curl 'https://api.thanxsandbox.com/partner/promotions/promo_abc123/codes?merchant_id={merchant_id}&status=unredeemed&per_page=500' \
-X GET \
-H 'X-ClientId: {client_id}' \
-H 'Accept-Version: v4.0' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access_token}'
{
"codes": [
{
"code": "A1B2C3D4",
"status": "unredeemed"
},
{
"code": "7QMX9K2P",
"status": "redeemed"
}
],
"pagination": {
"current_page": 1,
"per_page": 500,
"total_pages": 20
}
}
Promotions
List Promotion Codes
Returns the codes for a promotion’s active pool
GET
/
partner
/
promotions
/
:id
/
codes
curl 'https://api.thanxsandbox.com/partner/promotions/promo_abc123/codes?merchant_id={merchant_id}&status=unredeemed&per_page=500' \
-X GET \
-H 'X-ClientId: {client_id}' \
-H 'Accept-Version: v4.0' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access_token}'
{
"codes": [
{
"code": "A1B2C3D4",
"status": "unredeemed"
},
{
"code": "7QMX9K2P",
"status": "redeemed"
}
],
"pagination": {
"current_page": 1,
"per_page": 500,
"total_pages": 20
}
}
Scope required:
promos.readactive state, otherwise a 404 Not Found is returned.
If the promotion has no active pool, an empty codes array is returned with
zero total pages.
To pull codes to hand out to customers, filter by status=unredeemed. Note
that a code stays unredeemed until the customer redeems it at the point of
sale — not when you send it — so you must track which codes you have already
dispensed on your side. See
Dispensing codes to customers.
Parameters
Response
curl 'https://api.thanxsandbox.com/partner/promotions/promo_abc123/codes?merchant_id={merchant_id}&status=unredeemed&per_page=500' \
-X GET \
-H 'X-ClientId: {client_id}' \
-H 'Accept-Version: v4.0' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access_token}'
{
"codes": [
{
"code": "A1B2C3D4",
"status": "unredeemed"
},
{
"code": "7QMX9K2P",
"status": "redeemed"
}
],
"pagination": {
"current_page": 1,
"per_page": 500,
"total_pages": 20
}
}