GET/api/v1/orders

List orders

Returns a paginated list of every order for the authenticated merchant. Newest first. Use the `cursor` returned in `pagination.cursor` to page through the rest.

Authorization

Requires the orders:read scope. See the auth guide for how to mint a token with the right scopes.

Parameters

Query parameters

Field	Type	Description
cursor optional	string	Pagination cursor returned in the previous response's `nextCursor`. Omit to start from the beginning. e.g. c1a2b3c4
limit optional	number	Page size. 1–100, default 25. e.g. 25

Response

A successful call returns 200 OK with the body shown to the right. Errors follow the standard envelope.

Request

curl 'https://theyutes.com/api/v1/orders' \
  -H 'Authorization: Bearer tyk_••••••••••••••••••••••••••••••••'

Response · 200 OK

json

{
  "data": [
    {
      "id": "cl9j4k2l3000001jx8h2zfb1m",
      "number": "TY-X9K2QF",
      "status": "processing",
      "totalKobo": 4500000,
      "currency": "NGN",
      "createdAt": "2025-11-20T14:22:31.000Z",
      "customer": {
        "name": "Adaeze Okonkwo",
        "email": "adaeze.okonkwo12@gmail.com"
      }
    }
  ],
  "pagination": {
    "cursor": "c1a2b3c4",
    "limit": 25,
    "hasMore": false
  }
}