Get Privilege by Id

This endpoint allows to get privilege available to a customer.

Request

GET <API base url>/customers/{customerId}/privileges/{privilegeId}

URL query parameters

Name	Type	Required	Description
language	string	no	Two letter language code according to ISO 639-1

Response

On success:

{
  "value": {
    "id": required uint64,
    "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),
    "accruedRewards": {
      ["cardId": string]: {
        "id": required uint64,
        "createdAt": required date,
        "merchant": {
            "id": required uint64,
            "marketName": required string,
            "logo": optional string (as URL)
        },
        "type": required string (one of - discount, gift, certificate, plusX, etc.),
        "expiresAt": optional date,
        "text": optional string,  
        "termsOfUse": 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
        },
        "certificate": optional {
            "provider": required string,
            "ids": optional array of string,
            "value": optional number
        },
        "isSpent": required boolean,
        "isOpened": required boolean
      }
    }
    "configs": required {
      ["cardType": string] : {
        "reward": optional {
          "isAvailable": required boolean,
          "merchant": {
            "id": required uint64,
            "marketName": required string,
            "logo": optional string (as URL)
          },
          "type": required string (one of - discount, gift, certificate, plusX, etc.),
          "certificate": optional {
            "provider": required string,
            "ids": optional array of string,
            "value": optional number
          },
          "hasAvailablePromoCode": optional boolean
        },
        "ad": optional {
          "name": required string,
          "description": optional string,
          "rewardText": optional string,
          "buttonText": optional string,
          "buttonUrl": optional string,
          "image": optional string (as URL)
        }
      }
    },
    "customFields": optional { [key:string]: any }
  }
}