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

Response

On success:

{
  "value": {
    "offers": required array of {
      "id": required uint64,
      "merchant": {
        "id": required uint64
      },
      "type": required string (one of - offer, privilege)
      "category": optional string,
      "averageCheck": optional string,
      "startDate": optional string (date in format YYYY-MM-DD),
      "startTime": optional string (time in format HH:MM:SS),
      "endDate": optional string (date in format YYYY-MM-DD),
      "endTime": optional string (time in format HH:MM:SS),
      "daysOfWeek": optional uint8[] (monday - 1 ... sunday - 7),
      "dayStartTime": optional string (time in format HH:MM:SS),
      "dayEndTime": optional string (time in format HH:MM:SS),
      "isOnline": optional boolean,
      "likesCount": optional number,
      "isLiked": optional boolean,
      "activationStatus": optional string (one of - undefined, activated, viewed),
      "isFavorite": optional boolean,
      "isCompleted": optional boolean,
      "newRewardAvailableFrom": optional date,
      "announcedFrom": required date,
      "receivedAt": required date,
      "marketWide": optional boolean,
      "requiresActivation": optional boolean,
      "promoCodeType": optional string (one of - global, personal, generated),
      "promoCode": optional string,
      "ad": optional {
        "languageCode": required string, 
        "name": required string,
        "description": optional string,
        "rewardText": optional string,
        "buttonText": optional string,
        "buttonUrl": optional string,
        "image": optional string (as URL)
      },
      "stats": required {
        "likeCount": required number,
        "offerRewardLimit": optional number,
        "customerRewardLimit": optional number,
        "offerRewardCount": required number,
        "customerRewardCount": required number,
        "customerSpentRewardCount": required number,
        "hasAvailablePromoCodes": optional boolean
      },
      "reward": optional {
        "merchant": {
          "id": required uint64
        },
        "type": required string (one of - discount, gift, certificate, plusX, etc.),
        "certificate": optional {
          "provider": required string,
          "id": optional string // Deprecated. Will be deleted from 01 Jan 2024,
          "ids": optional array of string,
          "value": optional number
        },
        "limit": optional {
          "used": required number,
          "max": required number
        }
      },
      "conditions": optional {
        "type": required string (one of - none, offersAccumulation, transactionsAccumulation),
        "targetCount": optional number,
        "targetAmount": optional number,
      },
      "progress": optional {
        "currentCount": optional number,
        "currentAmount": optional number,
      },
      "customFields": optional { [key:string]: any }
    },
    "rewards": required array of {
      "id": required number,
      "createdAt": required date,
      "offer": required {
        "id": required number,
      },
      "type": required string (one of - discount, gift, certificate, plusX, etc.),
      "text": optional string,
      "termsOfUse": optional string,
      "expiresAt": optional date,
      "promoCode": optional {
        "value": optional string,
        "status": required string (one of - unassigned, displayed)
      },
      "certificate": optional {
        "provider": required string,
        "id": optional string // Deprecated. Will be deleted from 01 Jan 2024,
        "ids": optional array of string,    
        "value": optional number
      },
      "isSpent": required boolean,
      "isOpened": required boolean,
      "displayTypes": required array of string (one of - plainText, qr, barcodeCode128, barcodeEan13),
      "customData": optional any
    },
    "merchants": required array of {
      "id": required number,
      "marketName": required string,
      "logo": optional string (as URL),
      "images": optional string[] (as URL),
      "legalName": required string,
      "about": optional string,
      "isFavorite": required boolean,
      "phones": optional string,
      "emails": optional string,
      "website": optional string,
      "isOnline": required boolean,
      "fbLink": optional string,
      "vkLink": optional string,
      "instagramLink": optional string,
      "buttonText": optional string,
      "buttonUrl": optional string,
      "category": optional string,
      "recentOffer": required {
        "announcedFrom": required date,
        "receivedAt": required date
      },
      "locations": optional array of{
        "images": optional string[] (as URL),
        "name": optional string,
        "phones": optional string,
        "address": optional string,
        "lon": required double - longitude,
        "lat": required double - latitude,
        "settlement": optional string, // deprecated
        "schedule": optional string
      }
    },
    "benefits": required array of {
      "id": required number,
      "name": required string,
      "description": optional string,
      "icon": optional string (as URL),
      "termsOfUse": optional string,
      "cardTypes": optional array of string
    },
    "availableCategories": required string[],
    "availableSettlements": required string[], // deprecated
    "recommendedMerchants": required number[]
  }
}