Search for promotions

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Inventory (3.0.0)
Inventory FAQ
Imports
Counters
Inventory
Locations
Networks

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
- Overview
- POST
  Create promotion
- GET
  Get a specific promotion
- PUT
  Update a specific promotion
- POST
  Enable or disable a promotion
- POST
  End a promotion
- DEL
  Delete a specific promotion
- POST
  Search for promotions
- GET
  Get all promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

promotions

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

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Required string length: 24

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-client-id

string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id

string

A unique request ID.

Body

application/json

The search criteria.

size

number

default: 10

The maximum number of records per page.

Required range: 1 < x < 100

offset

integer

default: 0

The number of records to skip before returning records. For example, with an offset of 20 and limit of 10, you will get records from 21 to 30.

Required range: x > 0

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

The search results including the pagination data.

query

object

Provides pagination data.

data

object[]

The response of the search request.

data.id

string

A 24-character system-generated promotion ID generated when using the create promotion endpoint.

data.couponCodes

string[]

A list of coupon codes that are applicable only for coupons. For coupons, the response includes promo codes associated with the coupon. For promotions, the response includes an empty array.

data.couponCodesCount

number

The number of coupon codes associated with a coupon. This value is always 0 for promotions.

data.status

enum<string>

The following are possible promotion statuses:

ACTIVE: The promotion is live and available.
SCHEDULED: The promotion is scheduled to be active at a future date.
DISABLED: The promotion is turned off and can be re-enabled later if required.
EXPIRED: The promotion is no longer valid.

Available options:

ACTIVE,

SCHEDULED,

DISABLED,

EXPIRED

data.name

string

The name of the promotion.

data.startAt

string

The start time of the promotion, in UTC format.

data.endAt

string

The end time of the promotion, in UTC format.

data.updatedAt

string

The time when the promotion was last updated, in UTC format.

data.singleMultiUse

enum<string>

The field to indicate whether it's a single use or multi use coupon

Available options:

MULTI_USE,

SINGLE_USE

data.type

string

The type of promotion you want to create. The following are the promotion types you can create:

PRODUCT: A SKU promotion. Applies a discount to SKUs based on the value specified in the discount object of the request body.
CART: A cart promotion. Applies a discount to the minimum order amount of the cart based on the ORDER_VALUE specified in the condition object of the request body.
QUANTITY: A quantity promotion. Provides discounts on items based on the quantity requirement set in the promotion.
SHIPPING: A shipping promotion. Provides discounts on the shipping cost.
BUYGET: A BuyGet promotion. Specifies the Buy conditions and corresponding Get discounts.
SPEND_GET: A SpendGet promotion. Specifies the total order value required to qualify for discounts and the applicable discounts based on the order value.

data.level

number

The level of the promotion to be evaluated.

data.stackingType

enum<string>

Defines the rules for how a promotion can be combined with other promotions. This field determines whether a specific promotion can be applied in conjunction with other active promotions during a transaction or if it must be used exclusively. If configured, stackingType will have precedence over the isStackable and isAlwaysApplied. The following are possible stackingType values:

STACKABLE: This promotion can be combined with other stackable promotions, allowing multiple discounts to be applied together. The order in which stackable promotions are applied is determined by the level field, with promotions having a higher priority (lower numeric value) being applied before those with a lower priority.
EXCLUSIVE: This promotion can't be combined with any other promotions. The level field is used to determine which exclusive promotion will be evaluated and applied first. Once an exclusive promotion is applied, no other promotions can be used in the same transaction.
TYPE_EXCLUSIVE: This promotion can't be combined with other promotions of the same type. The level field is used to determine which promotion within the same type will be evaluated and applied first.
UNIVERSAL: This promotion can be combined with any other promotions without restrictions. Universal promotions will be evaluated last.

Available options:

STACKABLE,

EXCLUSIVE,

TYPE_EXCLUSIVE,

UNIVERSAL

data.isStackable

boolean

The field to indicate whether the promotion is stackable or not.

data.isAlwaysApplied

boolean

The field is true for an universal promotion.

data.additionalAttributes

object[]

A placeholder for additional attributes related to promotions, in name-values pairs.

data.promotionMessages

object[]

Message description for the promotion

data.proximityMessages

object

Was this page helpful?

Delete a specific promotion Get all promotions