Skip to main content

Get Customer Reward by Id

This endpoint allows to get customer's reward by Id.

Request​

GET <API base url>/customers/{customerId}/rewards/{rewardId}

URL query parameters

NameTypeRequiredDescription
languagestringyesTwo letter language code according to ISO 639-1

Response​

On success:

{
  "value": required {
    "id": required number,
    "createdAt": required date,
    "offer": required {
      "id": required number,
      "merchant": required {
        "id": required number,
        "marketName": required string,
        "logo": optional string (as URL)
      },
      "ad": required {
        "name": required string,
        "image": optional string
      }
    },
    "offerId": required number, // deprecated
    "offerName": required string, // deprecated
    "merchant": required {
      "id": required number,
      "marketName": required string,
      "logo": optional string (as URL)
    },
    "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),
      "displayTypes": required string[] (plainText, qr, barcodeCode128, barcodeEan13)  
      // recommended display type is a first element in displayTypes
    },
    "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,
    "customData": optional any
  }
}