Get offer by id

Get offer by id with requested set of fields.

By default, does not return any relations or statistics. Needed relations should be explicitly specified.

GET /v3/offers/{offerId}

Get offer by id

cURL

curl --request GET \
  --url https://{host}/promotion/v3/offers/{offerId} \
  --header 'Authorization: <api-key>'

200

{
  "offerId": "<string>",
  "name": "<string>",
  "unifiedCampaignId": "<string>",
  "validFrom": "2023-11-07T05:31:56Z",
  "validTo": "2023-11-07T05:31:56Z",
  "previewVisibleFrom": "2023-11-07T05:31:56Z",
  "offerType": "<string>",
  "content": {
    "title": "<string>",
    "description": "<string>",
    "brand": "<string>",
    "imageUrl": "<string>",
    "discountLabel": "<string>",
    "normalPriceLabel": "<string>",
    "pricePerUnitLabelEnabled": true,
    "unitOfMeasure": "<string>",
    "conditionLabel": "<string>",
    "receiptDisplayText": "<string>",
    "tags": [
      "<string>"
    ],
    "icons": [
      "<string>"
    ],
    "autogenerateDiscountLabel": true
  },
  "prices": {
    "currency": "<string>",
    "normalPrice": 50000000,
    "price": 123,
    "normalPricePerUnit": 50000000,
    "pricePerUnit": 123
  },
  "discount": {
    "priority": 123,
    "allowOtherDiscountsOnTop": true,
    "itemsApplicationType": "AllItems",
    "impactLevel": "Line",
    "maxDiscountAmount": 123,
    "maxDiscountAmountPerCoupon": 123,
    "maxNumberApplyPerReceipt": 123,
    "applyOnHighestPrice": true,
    "applicationType": "OnThreshold",
    "discountType": "Unknown",
    "checkoutTypes": [
      "<string>"
    ],
    "rewardRedemptionSettings": {
      "redeemableFrom": "2023-11-07T05:31:56Z",
      "redeemableTo": "2023-11-07T05:31:56Z",
      "redeemableForDays": 123
    },
    "rules": [
      {
        "type": "FixedPrice",
        "value": 50000000,
        "thresholdType": "Quantity",
        "thresholdValue": 50000000,
        "affiliations": [
          {
            "type": "Product",
            "id": "<string>",
            "identifiers": [
              "<string>"
            ],
            "applicationType": "Include"
          }
        ]
      }
    ]
  },
  "status": "Imported",
  "redemptionLimit": 123,
  "totalCoupons": 123,
  "statistics": {
    "assignedCoupons": 123,
    "activatedCoupons": 123,
    "redeemedCoupons": 123,
    "totalValue": 123,
    "minValue": 123,
    "maxValue": 123,
    "avgValue": 123,
    "minBasket": 123,
    "maxBasket": 123,
    "avgBasket": 123
  },
  "chainIds": [
    "<string>"
  ],
  "storeIds": [
    "<string>"
  ],
  "isDefault": true,
  "offerSynchronized": true,
  "fundedBy": "<string>",
  "audienceIds": [
    "<string>"
  ],
  "metadata": {},
  "authorName": "<string>",
  "isTemplate": true,
  "displayPriority": 123,
  "preactivated": true,
  "ignoreOnPos": true,
  "defaultValidForDays": 123,
  "modifiedDate": "2023-11-07T05:31:56Z",
  "modifiedBy": "<string>"
}

Authorizations

Authorization · string · header · required

Opaque Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

offerId · string · required

Query Parameters

includedRelations · enum<string>[]

List with the included relations.

Available options: StoresAndChains, Statistics, Discount, Affiliations

Response

200

application/json

OK

offerId · string · required

ID of Promotion Campaign.

Required string length: 1 - 255

name · string · required

Name of the campaign visible in the admin tools.

Required string length: 1 - 255

unifiedCampaignId · string | null

ID of Turboflow Campaign.

Maximum string length: 64

validFrom · string<date-time> | null

Date when any coupons for this promotion campaign become available to pick up in store.

validTo · string<date-time> | null

Date when all coupons for this promotion campaign stop being available to pick up in the store.

previewVisibleFrom · string<date-time> | null

Date when Coupons will be returned in API and visible in the app. Optional. When not specified, ValidFrom is used.

offerType · string | null

Customer specific campaign type. Determines how or by which service campaign will be used. Types used so far: game, appCoupon, gift, preferredStore, memberOffer, stampCard, stickersCampaign, segmentedAppCoupon.

Maximum string length: 255

content · object

Show child attributes

prices · object

Show child attributes

discount · object

Show child attributes

status · enum<string>

Available options: Imported, Active, Expired, Scheduled

redemptionLimit · integer<int32>

Specifies how many times coupon can be redeemed in store. Each redemption is a separate purchase. Amount of time a coupon can be used in one purchase is controlled by Discount model.

totalCoupons · integer<int32> | null

Total amount of possible coupons in the campaign. When it is null, unlimited amount of coupons can be assigned.

statistics · object

Statistical data about campaign. Can be null if not requested.

Show child attributes

chainIds · string[] | null

List of Chain Ids where Promotion campaign is available. Mutually exclusive with StoreIds. Can be null if not requested

storeIds · string[] | null

List of Store Ids where Promotion campaign is available. Mutually exclusive with ChainIds. Can be null if not requested

isDefault · boolean | null

Can be true only for personal campaigns ("personalOffer", "relevantOffer"). When true, this campaign will be returned for a user that has no coupons assigned in personal campaigns.

offerSynchronized · boolean

Specifies if offer was successfully synchronized into customer system

fundedBy · string | null

Specifies who this offer is funded by. Retailers can use any values they need, or keep it empty

Maximum string length: 100

audienceIds · string[] | null

Segmentation identifier from the audience service.

Maximum array length: 1

metadata · object | null

Allows to store any arbitrary data in Campaign, returned in all get requests and sent to IL during activation. Can be null.

Show child attributes

authorName · string | null

The name of the person/entity that created the offer.

Maximum string length: 64

isTemplate · boolean

Specifies if the offer is template, meaning it can be used as a base for other offers during creation

displayPriority · integer<int32>

Controlls the order in which coupons are returned to the mobile app. Lower number means higher priority

preactivated · boolean

Specifies if coupons for this offer require activation, or are working on POS without activation

ignoreOnPos · boolean

Specifies if coupons should be visible and processed by POS.

defaultValidForDays · integer<int32> | null

Default number of days a Triggered coupon is valid for, when no explicit value is specified during assignment

modifiedDate · string<date-time> | null

The date and time when the campaign was modified. Changes every time the campaign is updated.

modifiedBy · string | null

The name of the person/entity that last updated the offer.

Maximum string length: 64