Skip to main content
POST
Redeem a reward for the customer given on the request body

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Path Parameters

id
integer<int32>
required

Body

application/json

Customer redeem data. CustomerId remains required. When Checkout.CustomerOriginalIdSource is document or email, use Customer.Document or Customer.Email respectively.

Reward Redeem Request model

CustomerId
string

ID of the customer requesting the reward redeem. its the ID from the client store.

Customer
object | null

Optional customer identifiers. Customer.Document is required and used for lookup when Checkout.CustomerOriginalIdSource is document; Customer.Email is required and used for lookup when the setting is email.

Response

200 - application/json
Items
object[]
TotalItemCount
integer<int32>
PageSize
integer<int32>
PageNumber
integer<int32>
HasNextPage
boolean