Skip to main content
POST
/
v1
/
rewards
/
redeem
Record reward redemption
curl --request POST \
  --url https://api.oneofnone.io/v1/rewards/redeem \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "rewardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "discountAmount": 1,
  "orderTotal": 1,
  "codeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "grantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamAppUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "<string>",
  "externalOrderId": "<string>",
  "customerEmail": "jsmith@example.com",
  "sessionId": "<string>",
  "metadata": {}
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.oneofnone.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
rewardId
string<uuid>
required
​
source
enum<string>
required
Available options:
shopify,
stripe,
vault,
manual
​
discountAmount
integer
required
Required range: x >= 0
​
orderTotal
integer
required
Required range: x >= 0
​
codeId
string<uuid> | null
​
grantId
string<uuid> | null
​
teamAppUserId
string<uuid> | null
​
orderId
string | null
Required string length: 1 - 500
​
externalOrderId
string | null
Required string length: 1 - 500
​
customerEmail
string<email> | null
​
sessionId
string | null
Required string length: 1 - 200
​
metadata
object

Response

Redemption recorded

​
success
enum<boolean>
required
Available options:
true