Online Content Examples

Merchant List (Online)

By calling the /merchants endpoint, you can retrieve the full list of available online merchants for a particular brand / partner.

High-Value Parameters

Query-String Parameter	Type	Use-Case	Default
with_offers	integer	Determines whether offers should be returned within the merchant object. Supported values are: 1 - true 0 - false The offers and offersCount fields will always be returned regardless of setting, but the offers field will be an empty array if this value is 0	0
category_id	integer	Filters merchant list by category (accepts comma separated list of category ids).	null
elevated_only	integer	Only include merchants that currently have elevated rebates Supported values are: 1 - true 0 - false	0
mobile_only	integer	Only merchants who track mobile traffic should be included in response. Supported values are: 1 - true 0 - false	0
tablet_only	integer	Only merchants who track tablet traffic should be included in response. Supported values are: 1 - true 0 - false	0
merchant_tag (curated)	string	Merchants by tag. Example: "featured" Tags are a way of accessing curated sections of merchant content. If you have specific use-cases that would necessitate the creation of a tag, or if you would like to know which existing tags might be available for use, please reach out to your contact at Cartera.	null
personalized (algorithmic)	string	Merchants by member-personalized data. Supported values are: fav - member’s favorite merchants rec - member’s recommended merchants all - favorite and recommended merchants Use of this field requires passing a valid mem_id query-string parameter (or x-mem-id header) to identify the member you are requesting personalized data for. For details on how to generate a proper mem_id value, please see Member Identifier Generation.	null
name	string	Filter by merchant name. Accepts partial and non-exact matches (to a degree). Can be used to approximate merchant search.	null
offset	integer	Pagination parameter. Allows to specify desired position of the first item in the result set that matches the request.	0
limit	integer	Pagination parameter. Limits number of items returned in response.	50
sort_by	string	Determines a sort order of items in the response. Supported values are: name earn_rate featured	"name"
sort_type	string	Determines direction of sorting. Supported values are: asc desc	"asc"

Example Call

https://api.cartera.com/content/v4/merchants?page_id=<pageId>&limit=2000&with_offers=1

Example Response

{
  "metadata": <Response_Metadata>,
  "response": [
    {
      "id": 501,
      "name": "1-800 CONTACTS",
      "description": "1-800 CONTACTS is the world's largest contact lens store with over 20 million contacts in stock and over 2.5 million satisfied customers plus Free Shipping!",
      "disclaimer": " Not eligible on purchases made with coupon or discount codes that are not found on this site. Not eligible on gift cards, gift certificates or any other similar cash equivalents.",
      "logoUrls": {
        "_88x31": <cdn-url-for-88x31>,
        "_120x60": <cdn-url-for-120x60>
      },
      "lifestyleImages": {
        "lifestyle_banner": <cdn-url-for-merchant-lifestyle-rectangle-1168x200>,
        "lifestyle_rectangle": <cdn-url-for-merchant-lifestyle-rectangle-1200x900>,
        "square_lifestyle_logo": null,
        "gift_card": null
      },
      "flags": {
        "tracksMobile": true,
        "tracksTablet": true,
        "safariDoesNotTrack": false
      },
      "rebate": <Merchant_Rebate>,
      "categories": [ <Merchant_Category>, <Merchant_Category>, ... ],
      "clickUrl": "https://<partner-mall-domain>/click.php?afsrc=1&c=318959&p=2395&d_chan=content_api&l=114369&gmid=501&r=3pts-%24",
      "offers": <Merchant_SpecialOfferCollection>,
      "offersCount": 4,
      "tiers": <Merchant_TieredRebateCollection>,
      "classification": <Merchant_Classification>
    },
    ...
  ]
}

Examples of other contents are 'Category' and 'Point of Sale Offers'.