DELETE
/
coupons
/
{couponId}

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.

Path Parameters

​
couponId
string
required

A 24-character system-generated coupon ID, generated using the create coupon endpoint.

Response

200 - application/json

The coupon details.

​
id
string
required

A 24-character system-generated coupon ID, generated using the create coupon endpoint.

​
name
string
required

The name of the coupon.

​
status
enum<string>
required

The status of the coupon.

Available options:
ACTIVE,
SCHEDULED,
DISABLED,
EXPIRED
​
startAt
string
required

The timestamp in UTC format indicating when the coupon becomes valid.

​
endAt
string
required

The timestamp in UTC format indicating when the coupon expires and is no longer valid.

​
type
enum<string>
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.
Available options:
PRODUCT,
CART,
QUANTITY,
SHIPPING,
BUYGET,
SPEND_GET
​
createdAt
string
required

The timestamp in UTC format indicating when the coupon was created.

​
updatedAt
string
required

The timestamp in UTC format indicating when the coupon was last updated.

​
couponCodesCount
integer

The total number of coupon codes.

​
level
integer

Coupon execution order

Required range: 0 < x < 5
​
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 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.
Available options:
STACKABLE,
EXCLUSIVE,
TYPE_EXCLUSIVE,
UNIVERSAL
​
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
enum<string>

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.
Available options:
MULTI_USE,
SINGLE_USE
​
couponCodes
string[]

An array containing available coupon codes.

​
promotionMessages
object[]

Message description for the promotion

​
additionalAttributes
object[]

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

Was this page helpful?

Enable or disable a couponSearch for coupons