List an offer's redemptions

curl --request GET \
  --url https://api.tassyir.io/apps/2026-10/offers/{id}/redemptions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tassyir.io/apps/2026-10/offers/{id}/redemptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "orderId": "<string>",
      "codeId": "<string>",
      "code": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "state": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "INVALID_CURSOR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "APP_TOKEN_INVALID",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "OFFER_NOT_OWNED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "NOT_FOUND",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 429,
  "detail": "<string>",
  "code": "BUSINESS_RATE_LIMITED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 500,
  "detail": "<string>",
  "code": "INTERNAL_ERROR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "API_BUSY",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

Offers

List an offer's redemptions

Each use of the offer on an order, newest first: the order id, the code and the amount it took off. Never the buyer: no name, no phone, no phone key. Only the owner reads them: An app changes, and reads the codes and redemptions of, only the offers its own installation created (ownerInstallationId is set from the token when it creates one). A merchant’s offer, or another app’s, is 403 OFFER_NOT_OWNED; an offer the token cannot see (another business, a store outside the installation’s stores) is 404.

Needs the read_offers scope (permission offers:read).

GET

apps

2026-10

offers

{id}

redemptions

List an offer's redemptions

curl --request GET \
  --url https://api.tassyir.io/apps/2026-10/offers/{id}/redemptions \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.tassyir.io/apps/2026-10/offers/{id}/redemptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "<string>",
      "orderId": "<string>",
      "codeId": "<string>",
      "code": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "state": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 400,
  "detail": "<string>",
  "code": "INVALID_CURSOR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 401,
  "detail": "<string>",
  "code": "APP_TOKEN_INVALID",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 403,
  "detail": "<string>",
  "code": "OFFER_NOT_OWNED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 404,
  "detail": "<string>",
  "code": "NOT_FOUND",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 429,
  "detail": "<string>",
  "code": "BUSINESS_RATE_LIMITED",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 500,
  "detail": "<string>",
  "code": "INTERNAL_ERROR",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 503,
  "detail": "<string>",
  "code": "API_BUSY",
  "docs": "<string>",
  "fix": "<string>",
  "requestId": "<string>",
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

An app access token from POST /apps/oauth/token, valid 1 hour. An offline token acts as the app; an online token acts as the app on behalf of one dashboard user (the intersection of both permission sets).

Path Parameters

string

required

A resource id. One this installation cannot read, or a malformed one, is 404 NOT_FOUND.

Minimum string length: 1

Query Parameters

state

enum<string>

Only redemptions in this state: held (the order is not with a carrier yet), final (handed over) or released (the order was cancelled).

Available options:

held,

final,

released

fields

string

Return only these top-level fields, separated by commas; the id is always kept. The response schema describes the whole resource. An unknown name is 400 INVALID_FIELDS. Fields: id, orderId, codeId, code, amount, currency, state, createdAt.

Maximum string length: 1000

limit

integer

Page size, 1 to 100 (default 50). A value outside that range is 400, never clamped.

Required range: 1 <= x <= 100

cursor

string

The nextCursor of the previous page, unchanged, with the same filters. Opaque; bound to this list and its filters (400 INVALID_CURSOR otherwise).

Maximum string length: 512

Response

A page of redemptions.

One page, newest first. Pass nextCursor back as cursor for the next one.

data

object[]

required

Show child attributes

nextCursor

string | null

required

Null on the last page.

Admin API

Developer API

List an offer's redemptions

Authorizations

Path Parameters

Query Parameters

Response