Skip to content

Reward codes

A customer’s earned reward fulfilments (discount codes).

A customer’s {id} is its Shopify customer ID.

GET /customers/{id}/reward-codes

The customer’s earned reward fulfilments (discount codes).

Query params:

ParamTypeDescription
availablebooleanWhen 1/true, return only unused codes.
[
{
"id": "501",
"name": "$5 off",
"code": "APPY-5OFF-XXXX",
"used": false,
"createdAt": "2026-06-05T12:00:00+00:00"
}
]
FieldTypeDescription
idstringUnique identifier.
namestringReward name.
codestringThe discount code.
usedbooleanWhether the code has been used.
createdAtstringISO-8601 timestamp.

POST /customers/{id}/reward-codes/{codeId}/use

Marks a reward code as used, for example after the discount has been applied at an external checkout. The code is also deactivated in Shopify so it can no longer be redeemed. No stamps are refunded.

This call takes no body and returns the updated reward code object (see Reward code fields) with used set to true. An unknown code returns 404 REWARD_CODE_NOT_FOUND.

POST /customers/{id}/reward-codes/{codeId}/void

Voids a reward code: the stamps spent on it are refunded to the customer and the code is deactivated in Shopify. Use this to reverse a redemption.

This call takes no body and returns the updated reward code object (see Reward code fields). An unknown code returns 404 REWARD_CODE_NOT_FOUND; a code that cannot be voided returns 422 VOID_FAILED.