ShopEazydevelopers
API referenceMerchant API BetaOrders

List or search orders

Beta
Credentials
  • OAuth access token
Scopes
orders:read
GET
/v1/merchant/stores/{storeId}/orders

Access: OAuth scope orders:read; not write-gated.

Paged: { items, nextCursor }, limit (default 30, at most 100) and an opaque cursor.

Authorization

merchantOAuth orders:read
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: orders:read

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

Query Parameters

queue?string
Value in"fulfil""collect"
status?string
Value in"open""completed""cancelled"
payment?string
Value in"unpaid""partially_paid""paid""partially_refunded""refunded"
search?string

Free text. A search ignores the other filters and is not paginated.

cursor?string

The nextCursor of the previous page, unchanged. A cursor that is not one we gave you is 400 bad_request.

limit?integer

Page size: default 30, at most 100 (more is 100; a missing or unusable value is 30).

Range1 <= value <= 100
Default30

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/orders' \  -H 'Authorization: Bearer <access_token>'
Example Response
{  "data": {    "items": [      {        "id": "riEhGrBxE2kF04RzXyaz",        "number": "ORD-00001",        "channel": "online",        "customerName": "Thandi Mokoena",        "soldByName": null,        "total": {          "amount": 32900,          "currency": "ZAR"        },        "status": "open",        "paymentStatus": "unpaid",        "fulfillmentStatus": "unfulfilled",        "placedAt": 1792924396792,        "lineCount": 1,        "kinds": [          "physical"        ]      }    ],    "nextCursor": null  }}

Change the business details PUT

The business behind the shops: name, legal and trading names, registration and VAT numbers, email, phone and address. Only what is sent changes, and every shop's policies pick up the new contact details. Access: OAuth scope `settings:write`; owner/admin only; write-gated by the subscription.

Ring up a manual (counter) order POST

Access: OAuth scope `orders:write`; write-gated by the subscription.