Skip to main content
POST
Retry reward sync

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

Query Parameters

system
enum<string>
required
Available options:
shopify,
stripe

Response

Successful response

id
string<uuid>
required
teamId
string<uuid>
required
name
string
required
description
string | null
required
type
enum<string>
required
Available options:
DISCOUNT,
GATED_CONTENT,
FREE_CLAIM,
EARLY_ACCESS,
CREDIT
scope
enum<string>
required
Available options:
sitewide,
collection,
product,
variant
valueType
enum<string>
required
Available options:
percentage,
fixed_amount,
free_shipping,
gated_content
value
integer
required
minimumPurchase
integer | null
required
minimumQuantity
integer | null
required
usageLimitTotal
integer | null
required
usageLimitPerCustomer
integer | null
required
startsAt
string
required
expiresAt
string | null
required
stackable
boolean
required
codeType
enum<string>
required
Available options:
automatic,
global_code,
unique_codes
globalCode
string | null
required
externalUrl
string | null
required
imageId
integer | null
required
conditions
object
required
status
enum<string>
required
Available options:
draft,
active,
paused,
expired,
archived
totalRedemptions
integer
required
totalRevenueImpact
number
required
createdAt
string
required
updatedAt
string | null
required
image
object | null
externalIds
object[]
access
object