--- title: "Get all coupons" method: GET path: "/coupons" tags: ["Coupons"] --- # Get all coupons `GET /coupons` ## Request - Base URL: `https://api.fabric.inc/v3` - URL: `https://api.fabric.inc/v3/coupons` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Get a paginated list of coupons. ## Query parameters - `size` integer - `offset` integer - `sort` '-updatedAt' | '+updatedAt' | '-couponCodes' | '+couponCodes' | '-startAt' | '+startAt' | '-endAt' | '+endAt' | '-name' | '+name' - `search` string ## Headers - `x-fabric-tenant-id` string, required - `x-fabric-channel-id` string - `x-client-id` string - `x-fabric-request-id` string ## Response `200` OK - GetCouponsResponse: The coupons details. - `query` OffsetQuery: Provides pagination data. - `size` integer: The maximum number of records per page. - `offset` integer: 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` integer: The total number of available records. - `data` CouponResponse[]: An array containing coupons. - `id` string, required: A 24-character system-generated coupon ID, generated using the [create coupon](/v3/api-reference/offers/coupons/create-coupon) endpoint. - `name` string, required: The name of the coupon. - `status` 'ACTIVE' | 'SCHEDULED' | 'DISABLED' | 'EXPIRED', required: The status of the coupon. - `startAt` string, date-time, required: The timestamp in UTC format indicating when the coupon becomes valid. - `endAt` string, date-time, required: The timestamp in UTC format indicating when the coupon expires and is no longer valid. - `type` 'PRODUCT' | 'CART' | 'QUANTITY' | 'SHIPPING' | 'BUYGET' | 'SPEND_GET', required: The type of coupon promotion you want to create. The following are the coupon promotion types you can create: - `PRODUCT`: A SKU coupon promotion. Applies a discount to SKUs based on the value specified in the `discount` object of the request body. - `CART`: A cart coupon 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 coupon promotion. Provides discounts on items based on the quantity requirement set in the promotion. - `SHIPPING`: A shipping coupon promotion. Provides discounts on the shipping cost. - `BUYGET`: A BuyGet coupon promotion. Specifies the _Buy_ conditions and corresponding _Get_ discounts. - `SPEND_GET`: A SpendGet coupon promotion. Specifies the total order value required to qualify for discounts and the applicable discounts based on the order value. - `couponCodesCount` integer: The total number of coupon codes. - `createdAt` string, date-time, required: The timestamp in UTC format indicating when the coupon was created. - `updatedAt` string, date-time, required: The timestamp in UTC format indicating when the coupon was last updated. - `level` integer: Coupon execution order - `stackingType` 'STACKABLE' | 'EXCLUSIVE' | 'TYPE_EXCLUSIVE' | 'UNIVERSAL': 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` Possible 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. - `isStackable` boolean: - `true`: Allows the coupon to be stacked so it can be applied with other coupons. - `false`: Disables coupon stacking. - `isAlwaysApplied` boolean: Set `true` to always apply the promotion, even on non-stackable promotions, or `false` to apply promotion based on configured conditions. - `singleMultiUse` 'MULTI_USE' | 'SINGLE_USE': Determines whether the coupon is valid for single use or for multiple uses. The options are: - `SINGLE_USE`: The coupon can be used only once. - `MULTI_USE`: The coupon can be used multiple times. - `couponCodes` string[]: An array containing available coupon codes. - `promotionMessages` object[]: Message description for the promotion - `title` string: Message name - `message` string: Message description - `pages` string[]: The types of web pages where the message is displayed. - `locales` string[]: The locales in which the promotion message is displayed. Locale is a set of language or country-based preferences for user interface. - `additionalAttributes` object[]: A placeholder for additional attributes, in name-values pairs. - `name` string, required: The attribute name. - `values` union, required: The attribute value or values corresponding to the `name`. - string: The value of the additional attribute. - string[] - `attributeId` number: A unique identifier of the attribute, for external use. ## Other responses - `400`: Bad request - `401`: Unauthorized - `500`: Internal server error --- [API](https://skmtc.dev/fabric/apis/offers-coupons.md) - [All operations](https://skmtc.dev/fabric/apis/offers-coupons/llms.txt) - [OpenAPI document](https://skmtc.dev/fabric/apis/offers-coupons/revisions/4769f4b9212e?raw)