- Support
- Product Releases
- Blog
- Overview
- API References
- API Authentication
- Getting Started with fabric APIs
- Making your first API request
- Example
- Using Developer Portal
- Security and Compliance
- Product Catalog API - Overview
- Developer Guide
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products
Allocations
- Orders (3.0.0)
Backorders Preorders
Exports
Developer Guide
Invoices
Shopping Lists
Shopping List Items
Notifications
Orders
Returns
Cancellations
Tracking
Frauds
Payments
Appeasements
Credits
Shipments
Shipping Methods
Shipping Method Items
Webhooks
- Orders FAQ(s)
- Overview
- Algolia standard integration
- Avalara standard integration
- Constructor.io standard integration
- Stripe standard integration
- Offers (3.0.0)
Real-time Pricing Engine
Promotions
Webhook Events
Redemptions
Priced Products
Product Exclusion Lists
Price Types
Coupons
Coupon Codes
Segments
Prices
Price Methods
Price Controls
Price Lists
Add-ons
Exports
Imports
Attributes
Customer Profile
Customer Address
Customer Self
Getting Started
Product Catalog
Orders
Integrations
Offers
Customers
Get all promotions
Get a paginated list of all promotions.
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Merchant's 24-character tenant ID
The sales channel ID.
The platform where the request is made.
A unique request ID.
The maximum number of records per page.
Specifies the record from which the search will start, effectively skipping all records before this point.
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.
The keyword to filter the promotions.
curl --request GET \
--url https://api.fabric.inc/v3/promotions \
--header 'Authorization: Bearer <token>' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
The sales channel ID.
The platform where the request is made.
A unique request ID.
Query Parameters
The maximum number of records per page.
Specifies the record from which the search will start, effectively skipping all records before this point.
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.
-updatedAt
, +updatedAt
, -startAt
, +startAt
, -endAt
, +endAt
The keyword to filter the promotions.
Response
The pagination details.
The maximum number of records per page.
Reference point to start the search for records in the next data set
Promotions list
A 24-character system-generated promotion ID.
The name of the promotion.
The current status of the promotion.
ACTIVE
, SCHEDULED
, DISABLED
, EXPIRED
The start time of the promotion, in UTC format.
The end time of the promotion, in UTC format.
Promotion types. The options are:<br />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.<br />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.<br />QUANTITY: Quantity promotion provides discounts on items based on the quantity requirement set in the promotion.<br />SHIPPING: Shipping promotion provides discounts on the shipping cost.<br />BUYGET: BuyGet promotion specifies the Buy conditions and corresponding Get discounts.<br />SPEND_GET: SpendGet promotion specifies the total order value required to qualify for discounts and the discounts applicable based on the order value.
PRODUCT
, CART
, QUANTITY
, SHIPPING
, BUYGET
, SPEND_GET
Record's creation time
Record's last updated time
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.
true: Promotion can be applied on top of other promotions<br />false: Promotion cannot be applied with any other promotions
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.
A placeholder for additional attributes related to promotions, in key-value pairs.
The attribute name.
The attribute value or values corresponding to the key
.
A unique identifier of the attribute, for external use.
Message description for the promotion
Message name
Message description
The types of web pages where the message is displayed.
The locales in which the promotion message is displayed. Locale is a set of language or country-based preferences for user interface.
Was this page helpful?
curl --request GET \
--url https://api.fabric.inc/v3/promotions \
--header 'Authorization: Bearer <token>' \
--header 'x-fabric-channel-id: <x-fabric-channel-id>' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>'
{
"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"
]
}
]
}
]
}