Skip to main content

Request New Customer Reward

This endpoint allows to get new customers reward for specified offer.

Request​

POST <API base url>/customers/{customerId}/offers/{offerId}/rewards/new

URL query parameters

NameTypeRequiredDescription
languagestringyesTwo letter language code according to ISO 639-1

Response​

On success:

{
  "value": {
    "reward": {
      "id": required uint64,
      "createdAt": required date,
      "offer": required {
        "id": required uint64,
        "merchant": {
          "id": required uint64,
          "marketName": required string,
          "logo": optional string (as URL)
        },
        "ad": required {
          "name": required string
        }
      },
      "offerId": required uint64, // deprecated
      "offerName": required string, // deprecated
      "merchant": {
        "id": required uint64,
        "marketName": required string,
        "logo": optional string (as URL)
      },
      "type": required string (one of - discount, gift, certificate, plusX, etc.),
      "text": optional string,
      "termsOfUse": optional string,
      "category": optional string,
      "promoCode": optional {
        "value": optional string,
        "status": required string (one of - unassigned, displayed),
        "displayTypes": required string[] (plainText, qr, barcodeCode128, barcodeEan13)  
        // recommended display type is a first element in displayTypes
      },
      "isSpent": required boolean,
      "isOpened": required boolean
    },
    "newRewardAvailableFrom": optional date (in UTC)
  }
}