Skip to main content
POST
Create promotion

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
status
enum<string>
required

On create this field is ignored and the status is derived from starts_at: when starts_at is omitted or null the status is draft; a future starts_at makes it scheduled; a starts_at at or before the current time makes it active. Required on update.

Available options:
draft,
scheduled,
active,
inactive
customer_eligibility
enum<string>
required
Available options:
all,
customer,
segment,
customer-group
starts_at
string<date-time>
required
promotion_type
enum<string>
required
Available options:
discount,
free-goods,
free-shipping,
buy-x-get-y,
volume-based
can_be_used_with_other_promotion
boolean
required
description
string
tags
string[] | null
customer_id
string[]

required if customer_eligibility = customer

segment_id
string[]

required if customer_eligibility = segment

customer_group_id
string[]
redemption_limits
object | null
minimum_order_total
integer | null
default:0

Ignored when coupon_type or promotion_type is tiered-discount. Each slab in details defines its own order_value threshold.

for_first_time_customer_only
boolean
default:false
can_earn_loyalty_points
boolean
default:true
can_redeem_loyalty_points
boolean
default:true
expires_at
string<date-time> | null
priority
integer | null
Required range: 1 <= x <= 5
applies_to_product
enum<string>

seller scopes the promotion to specific marketplace sellers (details.sellers). It is valid only for promotion_type: discount and only on marketplace stores.

Available options:
all,
product,
category,
seller
details

Promotion rules; shape depends on promotion_type.

terms_and_conditions
string[] | null

Response

OK

message
string
success
boolean
content
object