> ## Documentation Index > Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt > Use this file to discover all available pages before exploring further. # Get all promotions > Retrieves a paginated list of all promotions. ## OpenAPI ````yaml promotions.openapi get /promotions openapi: 3.0.0 info: title: Offers - Promotions description: > fabric Promotions are discounts on items, carts, or shipping methods. These endpoints allow you to create and manage promotional discounts that are applied to a customers' cart that meets the required conditions. Because promotions are linked to specific price lists, you must submit the correct price list ID. version: 3.0.0 x-audience: external-public termsOfService: https://fabric.inc/terms-of-use contact: name: Offers support email: support@fabric.inc license: name: fabric API License url: https://fabric.inc/api-license servers: - url: https://api.fabric.inc/v3 description: Production environment security: [] externalDocs: description: Find out more about Offers url: https://developer.fabric.inc/docs/offers-overview paths: /promotions: get: tags: - Promotions summary: Get all promotions description: Retrieves a paginated list of all promotions. operationId: getPromotions parameters: - $ref: '#/components/parameters/xFabricTenantId' - $ref: '#/components/parameters/xFabricChannelId' - $ref: '#/components/parameters/xClientId' - $ref: '#/components/parameters/xFabricRequestId' - $ref: '#/components/parameters/queryParameterSize' - $ref: '#/components/parameters/queryParameterOffset' - name: sort in: query description: >- 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. required: false schema: type: string default: '-updatedAt' enum: - '-updatedAt' - +updatedAt - '-startAt' - +startAt - '-endAt' - +endAt - '-name' - +name - name: search in: query description: The keyword to filter the promotions. required: false schema: type: string example: BLACK FRIDAY responses: '200': description: OK headers: x-fabric-request-id: $ref: '#/components/headers/xFabricRequestIdResponse' content: application/json: schema: $ref: '#/components/schemas/getPromotionsResponse' '400': description: Bad request headers: x-fabric-request-id: $ref: '#/components/headers/xFabricRequestIdResponse' content: application/json: schema: anyOf: - $ref: '#/components/schemas/badSizeError' - $ref: '#/components/schemas/badSortingError' - $ref: '#/components/schemas/missingTenantHeader' - $ref: '#/components/schemas/error400' '401': description: Unauthorized headers: x-fabric-request-id: $ref: '#/components/headers/xFabricRequestIdResponse' content: application/json: schema: $ref: '#/components/schemas/error401' '500': description: Internal server error headers: x-fabric-request-id: $ref: '#/components/headers/xFabricRequestIdResponse' content: application/json: schema: $ref: '#/components/schemas/error500' security: - AuthorizationToken: [] components: parameters: xFabricTenantId: in: header name: x-fabric-tenant-id schema: type: string minLength: 24 maxLength: 24 required: true example: 5f328bf0b5f328bf0b5f328b description: >- 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](/v3/platform/settings/account-details/getting-the-account-id). This header is required. xFabricChannelId: in: header name: x-fabric-channel-id schema: type: string example: '12' description: >- 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. xClientId: in: header name: x-client-id schema: type: string required: false example: copilot description: >- A unique identifier obtained from [Copilot](/v3/platform/settings/api-apps/getting-system-app-credentials) for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows. xFabricRequestId: in: header name: x-fabric-request-id description: A unique request ID. required: false schema: type: string example: 263e731c-45c8-11ed-b878-0242ac120002 queryParameterSize: name: size in: query description: The maximum number of records per page. required: false schema: type: integer format: int32 minimum: 1 default: 10 maximum: 100 queryParameterOffset: name: offset in: query description: >- 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: false schema: type: integer format: int32 minimum: 0 example: 0 default: 0 headers: xFabricRequestIdResponse: description: Unique request ID schema: type: string example: 263e731c-45c8-11ed-b878-0242ac120002 schemas: getPromotionsResponse: type: object description: Promotions list properties: query: $ref: '#/components/schemas/offsetQuery' data: type: array description: Promotions list items: $ref: '#/components/schemas/promotionResponse' badSizeError: type: object description: Pagination size error, an invalid value was sent properties: type: description: The error code. type: string example: REQUEST_VALIDATION message: description: An error message corresponding to the `type`. type: string example: Size should be a valid number badSortingError: type: object description: Invalid sorting values sent properties: type: description: The error code. type: string example: REQUEST_VALIDATION message: description: >- An error message corresponding to the `type`. In this case. an invalid sorting value was sent. type: string example: Sorting value must be one of the allowed values missingTenantHeader: type: object description: Tenant header is missing properties: type: description: The error code. type: string example: TENANT_HEADER_REQUIRED message: description: An error message corresponding to the `type`. type: string example: x-fabric-tenant-id header is required error400: type: object description: Bad request error properties: type: description: The error code. type: string example: BAD_REQUEST message: description: An error message corresponding to the `type`. type: string example: Bad request error401: type: object description: Unauthorized error properties: type: description: The error code. type: string example: UNAUTHORIZED message: description: An error message corresponding to the `type`. type: string example: Invalid credentials error500: type: object description: Internal server error properties: type: description: The error code. type: string example: INTERNAL_SERVER_ERROR message: description: An error message corresponding to the `type`. type: string example: Internal server error offsetQuery: type: object description: Provides pagination data. properties: size: description: The maximum number of records per page. type: integer format: int32 minimum: 1 default: 10 maximum: 100 example: 10 offset: type: integer format: int32 example: 10 minimum: 0 default: 0 description: >- 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. count: type: integer format: int32 example: 50 description: The total number of available records. promotionResponse: type: object description: The details of the promotion. required: - id - name - startAt - endAt - status - type properties: id: type: string description: >- A 24-character system-generated The promotion ID generated when using the [create promotion](/v3/api-reference/offers/promotions/create-promotion) endpoint. example: 6380e7ecb419a30009865fad name: type: string description: The name of the promotion. example: Black Friday Promotion status: type: string description: The current status of the promotion. enum: - ACTIVE - SCHEDULED - DISABLED - EXPIRED example: SCHEDULED startAt: type: string format: date-time description: The start time of the promotion, in UTC format. example: '2019-08-24T14:15:22.000Z' endAt: type: string format: date-time description: The end time of the promotion, in UTC format. example: '2019-08-25T14:15:22.000Z' type: type: string description: > 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. enum: - PRODUCT - CART - QUANTITY - SHIPPING - BUYGET - SPEND_GET example: PRODUCT createdAt: $ref: '#/components/schemas/createdAt' updatedAt: $ref: '#/components/schemas/updatedAt' level: type: integer format: int32 minimum: 0 maximum: 5 description: >- 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. example: 3 stackingType: type: string description: > 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. enum: - STACKABLE - EXCLUSIVE - TYPE_EXCLUSIVE - UNIVERSAL example: STACKABLE isStackable: type: boolean example: false description: > - `true`: The promotion can be stacked, and its discounts will be summed together with other promotions. - `false`: The promotion can't be applied with any other promotions. isAlwaysApplied: type: boolean example: false description: >- 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 isn't applied on the item by default. additionalAttributes: type: array description: >- A placeholder for additional attributes related to promotions, in name-values pairs. items: type: object description: Details of additional attributes. required: - name - values properties: name: type: string description: The attribute name. example: type values: description: The attribute value or values corresponding to the `name`. oneOf: - type: string description: The value of the additional attribute. example: Birthday - type: array items: type: string description: The values of the additional attributes. example: - Birthday - Holiday attributeId: type: number description: A unique identifier of the attribute, for external use. example: 100000 promotionMessages: $ref: '#/components/schemas/promotionMessages' createdAt: type: string format: date-time description: Record's creation time example: '2019-08-20T14:15:22.000Z' updatedAt: type: string format: date-time description: Record's last updated time example: '2019-08-20T14:15:22.000Z' promotionMessages: type: array description: Message description for the promotion required: - title - locales - pages items: type: object description: Message description for the promotion properties: title: type: string description: Message name example: Buy 2 get 1 free message: type: string description: Message description example: Offer valid at participating stores through September 5, 2023. pages: type: array description: The types of web pages where the message is displayed. items: type: string description: Page type example: PDP example: - PDP - Cart locales: type: array description: >- The locales in which the promotion message is displayed. Locale is a set of language or country-based preferences for user interface. items: type: string description: Locale example: en-CA example: - en-CA - fr-CA securitySchemes: AuthorizationToken: type: http scheme: bearer bearerFormat: JWT ````