Skip to main content
POST
Create a promotion
OAuth scope: promotions_writeAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
code
string
required
discount
Percentage · object
required
type
string
required
Allowed value: "MEMBERSHIPS_MULTI"
codes
string[]
required
requirements
Memberships · object
appliesToProducts
Open Api Promotion Selected Products · object
limits
Open Api Promotion Limits · object
subscriptionType
All Members · object
tiers
All Tiers · object

Response

OK

id
string
required
code
string
required
discount
Fixed Amount · object
required
status
enum<string>
required
Available options:
Live,
Ended,
Archived,
AllUsed
requirements
Shop · object
required
usageCount
integer<int32>
required
limits
Promotion Limits · object
required
appliesTo
Entire Order · object
required
type
string
required
Allowed value: "SHOP_AUTO_APPLYING"
title
string
required