Skip to main content
PUT
Update coupon

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

coupon id

Body

application/json
name
string
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,
scheduled,
active,
inactive
customer_eligibility
enum<string>
required
Available options:
all,
customer,
segment,
customer-group
can_be_used_with_promotion
boolean
default:false
required
starts_at
string<date-time>
required
details
PercentageDiscountRule · object
required
applies_to_product
enum<string>
required
Available options:
all,
product,
category
coupon_type
enum<string>
required
Available options:
discount,
tiered-discount,
free-goods,
fixed-price,
free-shipping,
buy-x-get-y,
volume-based,
accelerated-rewards
coupon_code
string[]
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
application_rules
object | null
visibility_scope
enum<string>
default:public

visibility scope of the coupon. only public coupons are visible in storefront.

Available options:
public,
private

Response

200 - application/json

OK

message
string
success
boolean
content
object