anyshop docs homeStatusOpen the dashboard

API reference Orders List orders

API referenceOrders

List orders

GET methodhttps://api.anyshop.io/v1/orders

Orders in your API key's mode, newest first. Checkouts never paid are not listed.

  • Scope orders:read

Query parameters

  • limitinteger How many to return: 1 to 100, default 201 to 100
  • starting_afterstring The last ID of the previous page; the next page starts after itUp to 64 characters
  • statusenum Only orders in this statuspending_paymentpaiddeliveredrefunded
  • emailstring Only this buyer's orders: their email address, exactlyUp to 254 characters

Returns

A list of order objects, newest first: { "object": "list", "data", "has_more" }.

Errors

Status and error.type
  • 400invalid_requestThe request is not valid; error.param names the field
  • 401authenticationNo API key, or it is not valid
  • 403permissionThe key does not have the scope this needs, it is a test key where only a live key may act (the catalog), or the store is suspended (store_suspended)
  • 404not_foundNot found in the key's store and mode
  • 409conflictConflicts with the object's state (type conflict), or an Idempotency-Key reused for another request (type idempotency, code idempotency_key_reused)
  • 429rate_limitedToo many requests; see Retry-After