Sign in
latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Retrieve Offer (Synchronous API)

Get an offer

Get an offer.

get/v1/offers/{offerid}

Path parameters

offeridnumber required

The identifier of the offer.

Query parameters

versionstring

The version of the offer, only support version=deployed. Use this parameter to get the latest deployed version for the active offer.

Headers

x-siteIdstring required

The site ID associated with the offer.

x-erid-as-oidstring

Set to true to use the external reference identifier (ERID) in the path instead of the offer identifier (offerId).

Response

Offer successfully retrieved.

idstring

Identifier of an offer.

statusstring

Status of an offer.

namestring

Name of an offer.

descriptionstring

A description of the offer.

externalReferenceOfferIdstring

The external reference identifier for the offer.

siteIdstring

The site ID associated with the offer.

offerTypestring

The type of offer.

offerTriggerstring

Specifies how the offer is triggered. Possible values include alwaysTriggered, couponCode, siteTest.

offerStartDatestring

The start date of the offer.

offerEndDatestring

End date of an offer. End date must be a future date.

creationDatestring

Date of creation of an offer.

modificationDatestring

Date of modification of an offer .

defaultLocalestring

The end date of the offer.

totalUsageLimitnumber

The total usage limit for the offer.

shopperUsageLimitnumber

The usage limit per shopper for the offer.

catalogIdstring

The catalog associated with the offer.

currencystring

The currency of the offer.

priceListTypestring

The price list of the offer.

Example response

{
  "id": "36094662050499",
  "status": "Deployed",
  "name": "Offer_New_1",
  "description": "Offer_New_1",
  "externalReferenceOfferId": "Offer_New_1",
  "siteId": "paytest2",
  "offerType": "discount",
  "offerTrigger": "promotionalUrlOrExternalTriggered",
  "offerStartDate": "2024-05-12T00:00:00.000Z",
  "offerEndDate": "2024-05-13T00:00:00.000Z",
  "creationDate": "2024-05-11T07:23:27.829Z",
  "modificationDate": "2024-05-11T08:14:23.148Z",
  "defaultLocale": "en_US",
  "supportedLocales": [
    {
      "locale": "en_GB"
    }
  ],
  "totalUsageLimit": 18,
  "shopperUsageLimit": 12,
  "catalogId": "823600",
  "currency": "USD",
  "priceListType": "listPrice",
  "products": [
    {
      "id": "287656800",
      "discountType": "Amount",
      "discountValue": 2
    }
  ]
}