Skip to main content
POST
/
v1
/
rewards
/
grants
/
{token}
/
claim
Claim reward grant
curl --request POST \
  --url https://api.oneofnone.io/v1/rewards/grants/{token}/claim \
  --header 'x-api-key: <api-key>'
{
  "grantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discountCode": "<string>",
  "value": 123,
  "externalIds": [
    {
      "externalId": "<string>",
      "externalCodeId": "<string>"
    }
  ]
}

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
​
value
integer
required
​
scope
enum<string>
required
Available options:
sitewide,
collection,
product,
variant
​
externalIds
object[]
required