Manage offers (synchronous API)

Create an offer

Creates a new offer.

post

/v1/offers

Authorizations

Header parameters

x-siteIdstringrequired

The site ID associated with the offer.

Body

namestringrequired

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

offerTypestringrequired

Type of the offer.

Example: discount

offerTriggerstringrequired

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

Example: promotionalUrlOrExternalTriggered

couponTypestringrequired

Type of the added coupon. If offerTrigger is couponCode then couponType field is required. Possible values are importCouponCodes, enterCouponCodes, generateCouponCodes, rangeCouponCodes.

Example: importCouponCodes

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

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

currencystringrequired

The currency of an offer. It is required only when we have product’s discountType either 'Amount' or 'Amount Off'.

Example: USD

priceListTypestring

The price list of the offer.

Example: listPrice

supportedLocalesobject[]

The locales supported by the offer.

productsobject[]

Eligibility and discount options for the product within the offer.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.digitalriver.com/v1/offers' \
  --header 'Authorization: Basic username:password' \
  --header 'x-siteId: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Offer_New_1","description":"Offer_New_1","externalReferenceOfferId":"Offer_New_1","offerType":"discount","offerTrigger":"promotionalUrlOrExternalTriggered","couponType":"importCouponCodes","offerStartDate":"2024-05-12T00:00:00.000Z","offerEndDate":"2024-05-13T00:00:00.000Z","totalUsageLimit":18,"shopperUsageLimit":12,"catalogId":"823600","currency":"USD","priceListType":"listPrice","supportedLocales":[{"locale":"en_GB"}],"products":[{"id":"287656800","discountType":"Amount","discountValue":2}]}'

201

400

401

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",
  "totalUsageLimit": 1,
  "shopperUsageLimit": 1,
  "catalogId": "823600",
  "currency": "USD",
  "priceListType": "listPrice",
  "supportedLocales": [
    {
      "locale": "en_CA"
    }
  ],
  "products": [
    {
      "id": "287656800",
      "discountType": "Amount",
      "discountValue": 2
    }
  ]
}

Offer successfully created.