Search for promotions

curl --request POST \
  --url https://api.fabric.inc/v3/promotions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "startCursor": "H796HJHGANLSADS",
  "size": 10,
  "sort": "+updatedAt",
  "filters": [
    {
      "field": "name",
      "value": "Summer",
      "operator": "EQUAL"
    }
  ]
}'

{
  "query": {
    "size": 10,
    "nextCursor": "H796HJHGANLSADS"
  },
  "data": [
    {
      "id": "6380e7ecb419a30009865fad",
      "name": "Black Friday Promotion",
      "status": "SCHEDULED",
      "startAt": "2019-08-24T14:15:22Z",
      "endAt": "2019-08-25T14:15:22Z",
      "type": "PRODUCT",
      "createdAt": "2019-08-20T14:15:22Z",
      "updatedAt": "2019-08-20T14:15:22Z",
      "level": 3,
      "isStackable": true,
      "isAlwaysApplied": true,
      "additionalAttributes": [
        {
          "key": "type",
          "value": "Birthday",
          "attributeId": 100000
        }
      ],
      "promotionMessages": [
        {
          "title": "Buy 1 get 1 free",
          "message": "Offer valid at participating stores through September 5, 2023.",
          "pages": [
            "PDP",
            "Cart"
          ],
          "locales": [
            "en-CA",
            "fr-CA"
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

Merchant's 24-character tenant ID

x-fabric-channel-id

string

required

The sales channel ID.

x-client-id

string

The platform where the request is made.

x-fabric-request-id

string

A unique request ID.

Body

application/json

startCursor

string

Specifies the record number from which the search will start, effectively skipping all records before this point.

size

number

default: 10

The maximum number of records per page.

sort

enum<string>

The criteria to sort the results. Use the format {sort order}{field name}, where - refers to a descending order and + refers to an ascending order.

Available options:

+updatedAt,

+name,

+startAt,

+endAt,

+level,

-updatedAt,

-name,

-startAt,

-endAt,

-level

filters

object[]

Response

200 - application/json

query

object

The pagination details.

data

object[]

The response of the search request.

data.id

string

required

A 24-character system-generated promotion ID.

data.name

string

required

The name of the promotion.

data.status

enum<string>

required

The current status of the promotion.

Available options:

ACTIVE,

SCHEDULED,

DISABLED,

EXPIRED

data.startAt

string

required

The start time of the promotion, in UTC format.

data.endAt

string

required

The end time of the promotion, in UTC format.

data.type

enum<string>

required

Promotion types. The options are: Product: Also referred to as SKU promotion. Promotion or discount is applied on SKUs based on the value mentioned in the discount object of the request body. CART: Also referred to as cart promotion. Promotion or discount is applied on the minimum order amount of the cart based on the ORDER_VALUE mentioned in the condition object of the request body. QUANTITY: Quantity promotion provides discounts on items based on the quantity requirement set in the promotion. SHIPPING: Shipping promotion provides discounts on the shipping cost. BUYGET: BuyGet promotion specifies the Buy conditions and corresponding Get discounts. SPEND_GET: SpendGet promotion specifies the total order value required to qualify for discounts and the discounts applicable based on the order value.

Available options:

PRODUCT,

CART,

QUANTITY,

SHIPPING,

BUYGET,

SPEND_GET

data.createdAt

string

Record's creation time

data.updatedAt

string

Record's last updated time

data.level

integer

Promotion execution order. Promotion types are assigned a default execution order. First, level 1 promotions will be evaluated. The result of level 1 will be used as a base price for level 2. Similarly, the result of level 2 will be used as a base price for level 3, and so on.

data.isStackable

boolean

true: Promotion can be applied on top of other promotions false: Promotion cannot be applied with any other promotions

data.isAlwaysApplied

boolean

A flag indicating whether the promotion is always applied regardless of any exclusive promotions on the same item. Set to true if the promotion is always applied and set to false if the promotion is not applied on the item by default.

data.additionalAttributes

object[]

A placeholder for additional attributes related to promotions, in key-value pairs.

data.promotionMessages

object[]

Message description for the promotion

Was this page helpful?

Overview Delete a specific promotion

curl --request POST \
  --url https://api.fabric.inc/v3/promotions/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "startCursor": "H796HJHGANLSADS",
  "size": 10,
  "sort": "+updatedAt",
  "filters": [
    {
      "field": "name",
      "value": "Summer",
      "operator": "EQUAL"
    }
  ]
}'

{
  "query": {
    "size": 10,
    "nextCursor": "H796HJHGANLSADS"
  },
  "data": [
    {
      "id": "6380e7ecb419a30009865fad",
      "name": "Black Friday Promotion",
      "status": "SCHEDULED",
      "startAt": "2019-08-24T14:15:22Z",
      "endAt": "2019-08-25T14:15:22Z",
      "type": "PRODUCT",
      "createdAt": "2019-08-20T14:15:22Z",
      "updatedAt": "2019-08-20T14:15:22Z",
      "level": 3,
      "isStackable": true,
      "isAlwaysApplied": true,
      "additionalAttributes": [
        {
          "key": "type",
          "value": "Birthday",
          "attributeId": 100000
        }
      ],
      "promotionMessages": [
        {
          "title": "Buy 1 get 1 free",
          "message": "Offer valid at participating stores through September 5, 2023.",
          "pages": [
            "PDP",
            "Cart"
          ],
          "locales": [
            "en-CA",
            "fr-CA"
          ]
        }
      ]
    }
  ]
}