Skip to main content
POST
Claim reward grant

Authorizations

x-api-key
string
header
required

Path Parameters

token
string
required
Required string length: 16 - 200

Response

Successful response

grantId
string<uuid>
required
rewardId
string<uuid>
required
discountCode
string | null
required
codeType
enum<string>
required
Available options:
automatic,
global_code,
unique_codes
valueType
enum<string>
required
Available options:
percentage,
fixed_amount,
free_shipping,
gated_content
value
integer
required
scope
enum<string>
required
Available options:
sitewide,
collection,
product,
variant
externalIds
object[]
required