Manage offers (synchronous API)

Create an offer

Creates a new offer.

POSThttps://api.digitalriver.com/v1/offers

Header parameters

Body

application/json

namestring

Name of an offer.

Example: "Offer_New_1"

descriptionstring

A description of the offer.

Example: "Offer_New_1"

externalReferenceOfferIdstring

The external reference identifier of the offer.

Example: "Offer_New_1"

offerTypestring

Type of the offer.

Example: "discount"

offerTriggerstring

Determines how the offer is triggered. Possible values are alwaysTriggered, couponCode, siteTest.

Example: "promotionalUrlOrExternalTriggered"

offerStartDatestring

Start date of an offer.

Example: "2024-05-12T00:00:00.000Z"

offerEndDatestring

End date of an offer.

Example: "2024-05-13T00:00:00.000Z"

supportedLocalesarray of object

The locales supported by the offer.

totalUsageLimitnumber

Total usuage limit of an offer.

Example: 18

shopperUsageLimitnumber

Shopper usage limit of an offer.

Example: 12

catalogIdstring

The catalog associated to the offer.

Example: "823600"

currencystring

The currency of the offer.

Example: "USD"

priceListTypestring

The price list of the offer.

Example: "listPrice"

productsarray of object

Eligibility and discount options for the product within the offer.

Response

201

Offer successfully created.

Body

application/json

idstring

Identifier of an offer..

Example: "426368220289"

statusstring

Status of an offer.

Example: "Draft"

namestring

The name of the offer.

Example: "Key_New_315511"

descriptionstring

Description of an offer.

Example: "New_Release_Offer_5"

externalReferenceOfferIdstring

The external reference identifier of the offer.

Example: "Key_New_315511"

siteIdstring

The site ID associated with the offer.

Example: "paytest2"

offerTypestring

The type of the offer.

Example: "discount"

offerTriggerstring

Determines how the offer is triggered. Possible values are alwaysTriggered, couponCode, siteTest.

Example: "promotionalUrlOrExternalTriggered"

offerStartDatestring

Start date of an offer.

Example: "2024-05-12T00:00:00.000Z"

offerEndDatestring

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

Example: "2024-05-13T00:00:00.000Z"

creationDatestring

The date of creation of an offer.

Example: "2024-05-02T08:29:00.275Z"

modificationDatestring

The date of modification of an offer.

Example: "2024-05-02T08:29:00.275Z"

defaultLocalestring

Default locale of an offer.

Example: "en_US"

supportedLocalesarray of object

The locales supported by the offer.

totalUsageLimitnumber

Total usuage limit of an offer.

Example: 1

shopperUsageLimitnumber

Shopper usage limit of an offer.

Example: 1

catalogIdstring

The catalog associated to the offer.

Example: "823600"

currencystring

The currency of an offer.

Example: "USD"

priceListTypestring

The price list of an offer.

Example: "listPrice"

productsarray of object

Eligibility and discount options for the product within the offer.

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/offers', {
    method: 'POST',
    headers: {
      "x-siteId": "text",
      "Content-Type": "application/json",
      "Accept": "text"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "id": "426368220289",
  "status": "Draft",
  "name": "Key_New_315511",
  "description": "New_Release_Offer_5",
  "externalReferenceOfferId": "Key_New_315511",
  "siteId": "paytest2",
  "offerType": "discount",
  "offerTrigger": "promotionalUrlOrExternalTriggered",
  "offerStartDate": "2024-05-12T00:00:00.000Z",
  "offerEndDate": "2024-05-13T00:00:00.000Z",
  "creationDate": "2024-05-02T08:29:00.275Z",
  "modificationDate": "2024-05-02T08:29:00.275Z",
  "defaultLocale": "en_US",
  "supportedLocales": [
    {
      "locale": "en_CA"
    }
  ],
  "totalUsageLimit": 1,
  "shopperUsageLimit": 1,
  "catalogId": "823600",
  "currency": "USD",
  "priceListType": "listPrice",
  "products": [
    {
      "id": "287656800",
      "discountType": "Amount",
      "discountValue": 2
    }
  ]
}

Deploy an offer

Deploys an offer.

POSThttps://api.digitalriver.com/v1/offers/{offerId}/deploy

Path parameters

offerId*number

The offer's ID.

Header parameters

Response

201

Offer successfully deployed.

Body

application/json

idstring

Identifier of an offer.

Example: "36094662050499"

statusstring

Status of an offer.

Example: "Deployed"

namestring

Name of an offer.

Example: "Offer_New_1"

descriptionstring

Description of an offer.

Example: "Offer_New_1"

externalReferenceOfferIdstring

The external reference identifier of the offer.

Example: "Offer_New_1"

siteIdstring

The site ID associated with the offer.

Example: "paytest2"

offerStartDatestring

Start date of an offer.

Example: "2024-05-12T00:00:00.000Z"

offerEndDatestring

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

Example: "2024-05-13T00:00:00.000Z"

creationDatestring

Date of creation of an offer.

Example: "2024-05-11T07:23:27.829Z"

modificationDatestring

Date of modification of an offer.

Example: "2024-05-11T07:23:27.829Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/offers/{offerId}/deploy', {
    method: 'POST',
    headers: {
      "x-siteId": "text",
      "Accept": "text",
      "Content-Type": "text",
      "x-erid-as-oid": "text"
    },
});
const data = await response.json();

Response

201

{
  "id": "36094662050499",
  "status": "Deployed",
  "name": "Offer_New_1",
  "description": "Offer_New_1",
  "externalReferenceOfferId": "Offer_New_1",
  "siteId": "paytest2",
  "offerStartDate": "2024-05-12T00:00:00.000Z",
  "offerEndDate": "2024-05-13T00:00:00.000Z",
  "creationDate": "2024-05-11T07:23:27.829Z",
  "modificationDate": "2024-05-11T07:23:27.829Z"
}

Retire an offer

Retires an offer.

POSThttps://api.digitalriver.com/v1/offers/{offerId}/retire

Path parameters

offerId*number

The offer's ID.

Header parameters

Response

200

Offer successfully retired.

Body

application/json

idstring

Identifier of an offer.

Example: "36094662050499"

statusstring

Status of an offer.

Example: "Retired"

namestring

Name of an offer.

Example: "Offer_New_1"

descriptionstring

Description of an offer.

Example: "Offer_New_1"

externalReferenceOfferIdstring

The external reference identifier of the offer.

Example: "Offer_New_1"

siteIdstring

site for which offer is created.

Example: "paytest2"

creationDatestring

Date of creation of an offer.

Example: "2024-05-11T07:23:27.829Z"

modificationDatestring

Date of modification of an offer.

Example: "2024-05-11T08:14:23.148Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.digitalriver.com/v1/offers/{offerId}/retire', {
    method: 'POST',
    headers: {
      "x-siteId": "text",
      "Accept": "text",
      "x-erid-as-oid": "text",
      "Authorization": "text"
    },
});
const data = await response.json();

Response

200

{
  "id": "36094662050499",
  "status": "Retired",
  "name": "Offer_New_1",
  "description": "Offer_New_1",
  "externalReferenceOfferId": "Offer_New_1",
  "siteId": "paytest2",
  "creationDate": "2024-05-11T07:23:27.829Z",
  "modificationDate": "2024-05-11T08:14:23.148Z"
}