Get Customer All Data

This endpoint allows to get information available to a customer.

Request

GET <API base url>/customers/{customerId}/all

URL query parameters

Name	Type	Required	Description
language	string	yes	Two letter language code according to ISO 639-1
query	string	no	Search query
offers.include	boolean	no	Should requests offers
offers.ids	uint64[]	no	Specific offers to request
offers.continuationToken	string	no	Request offers next page
merchants.include	boolean	no	Should requests merchants
merchants.ids	uint64[]	no	Specific merchants to request
merchants.continuationToken	string	no	Request merchants next page
benefits.include	boolean	no	Should requests benefits
benefits.ids	uint64[]	no	Specific benefits to request
benefits.continuationToken	string	no	Request benefits next page
privileges.include	boolean	no	Should requests privileges
privileges.ids	uint64[]	no	Specific privileges to request
privileges.continuationToken	string	no	Request privileges next page
regions.include	boolean	no	Should requests regions
regions.ids	uint64[]	no	Specific regions to request
regions.continuationToken	string	no	Request regions next page
rewards.include	boolean	no	Should requests rewards
rewards.ids	uint64[]	no	Specific rewards to request
rewards.continuationToken	string	no	Request rewards next page
categories.include	boolean	no	Should requests available categories

Response

On success:

{
  "value": {
    "merchants": optional {
      "continuationToken": optional string,
      "list": array of {
        "id": required uint64,
        // used to receive information about merchant, see `Get Merchant` section
        "configUrl": required string (as URL),
        "isFavorite": required boolean,
        "recommendedRank": required uint32,
        "recentOffer": {
          "announcedFrom": required date,
          "receivedAt": required date
        },
        "offers": optional array of {
          "id": required uint64,
          // used to receive information about offer, see `Get Offer` section
          "configUrl": required string (as URL)
        },
        "regions": optional array of {
          "id": required uint64,
          // used to receive information about region, see `Get Region` section
          "configUrl": required string (as URL)
        }
      }
    },
    "offers": optional {
      "continuationToken": optional string,
      "list": array of {
        "id": required uint64,
        // used to receive information about offer, see `Get Offer` section
        "configUrl": required string (as URL),
        "isLiked": optional boolean,
        "activationStatus": optional string (one of - undefined, activated, viewed),
        "isFavorite": optional boolean,
        "newRewardAvailableFrom": optional date,
        "receivedAt": required date,
        "stats": required {
          "likeCount": required number,
          "offerRewardLimit": optional number,
          "customerRewardLimit": optional number,
          "offerRewardCount": required number,
          "customerRewardCount": required number,
          "customerSpentRewardCount": required number,
          "hasAvailablePromoCodes": optional boolean
        },
        "progress": optional {
          "currentCount": optional number,
          "currentAmount": optional number,
        }
      }
    },
    "benefits": optional {
      "continuationToken": optional string,
      "list": array of {
        "id": required uint64,
        // used to receive information about benefit, see `Get Benefit` section
        "configUrl": required string (as URL)
      }
    },
    "privileges":optional {
      "continuationToken": optional string,
      "list": array of {
        "id": required uint64,
        // used to receive information about privilege, see `Get Privilege` section
        "configUrl": required string (as URL),
        "configs": required array of {
          "cardType": string,
          "reward": optional {
            "isAvailable": required boolean,
            "hasAvailablePromoCode": optional boolean
          }
        }
      }
    },
    "regions": optional {
      "continuationToken": optional string,
      "list": array of {
        "id": required uint64,
        // used to receive information about region, see `Get Region` section
        "configUrl": required string (as URL)
      }
    },
    "rewards" : optional {
      "continuationToken": optional string,
      "list": array of {
        "id": required uint64,
        "createdAt": required date,
        "promoCode": optional {
          "value": optional string,
          "status": required string (one of - unassigned, displayed),
          // recommended display type is a first element in displayTypes
          "displayTypes": required string[] (plainText, qr, barcodeCode128, barcodeEan13)
        },
        "certificate": optional {
          "provider": required string,
          "ids": optional string[],
          "value": optional number
        },
        "expiresAt": optional date,
        "isSpent": required boolean,
        "isOpened": required boolean,
        "customData": optional any,
        "offer": optional {
          "id": required uint64,
          // used to receive information about region, see `Get Offer` section
          "configUrl": required string
        },
        "privilege": optional {
          "id": required uint64,
          // used to receive information about region, see `Get Privilege` section
          "configUrl": required string
        }
      }
    },
    "categories": optional string[]
  }
}