POST
/
offer
/
coupons

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required
coupon_code
string[]
required
coupon_type
enum<string>
required
Available options:
discount,
free-goods,
fixed-price,
free-shipping,
buy-x-get-y,
volume-based,
accelerated-rewards
details
object
required
status
enum<string>
required

this key is ignored in create coupon api and draft status will be added by default. required in update coupon api only.

Available options:
draft,
live,
stopped,
expired
customer_eligibility
enum<string>
required
Available options:
all,
customer,
segment
starts_at
string
required
description
string
tags
string[] | null
customer_id
string[]

required if customer_eligibility = custo

segment_id
string[]

required if customer_eligibility = segment

applies_to_product
enum<string>
Available options:
all,
product,
category
has_redemption_limit
boolean
default: false
redemption_limit
integer
default: 0
require_minimum_order_total
boolean
default: false
minimum_order_total
integer
default: 0
for_first_time_customer_only
boolean
default: false
can_be_used_with_promotion
boolean
default: false
expires_at
string | null

Response

200 - application/json
message
string
success
string
content
object