Get Offer

This endpoint allows to get offer information.

Request

GET configUrl

Response

On success:

{
  "value": {
    "id": required uint64,
    "merchant": {
      "id": required uint64,
      // used to receive information about merchant, see `Get Merchant` section
      "configUrl": required string (as URL)
    },
    "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,
    "announcedFrom": required date,
    "receivedAt": required date,
    "ad": optional {
      "languageCode": required string, 
      "name": required string,
      "description": optional string,
      "rewardText": optional string,
      "rewardTermsOfUse": optional string,
      "button": required {
        "text": optional string,
        "url": optional string
      },
      "image": optional string (as URL)
    },
    "reward": optional {
      "merchant": {
        "id": required uint64,
        // used to receive information about merchant, see `Get Merchant` section
        "configUrl": required string (as URL)
      },
      "type": required string (one of - discount, gift, certificate, plusX, etc.),
      "certificate": optional {
        "provider": required string,
        "ids": optional string[],
        "value": optional number
      }
    },
    "conditions": optional {
      "type": required string (one of - none, offersAccumulation, transactionsAccumulation, referral, registrationBonus),
      "targetCount": optional number,
      "targetAmount": optional number,
    },
    "requiresActivation": required boolean,
    "customFields": optional { [key:string]: any },
    "regions": optional array {
      "id": required uint64,
      // used to receive information about region, see `Get Region` section
      "configUrl": required string (as URL)
    },
    "marketWide": required boolean,
    "locationIds": optional number[]
  }
}