Skip to main content
POST
Record reward redemption

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