Swagger Petstore - OpenAPI 3.0
GET/api/orders

List orders

Cursor-paginated — the response is { orders, nextCursor, hasMore }, not a bare array. Pass the returned nextCursor back as ?cursor= for the next page.

5 parameters
datestringoptional
Filter by delivery day, `yyyy-mm-dd`.
statusstringoptional
Filter by order status.
Allowed:draftconfirmedin_productionpackingshippingshippedclosed
customerIdstringoptional
Filter by customer.
limitintegeroptional
Page size. Defaults to 50.
cursorstringoptional
The `nextCursor` from the previous page.

4 status codes
200One page of orders.
ordersarray<object>optional
nextCursorstringoptional
Null on the last page.
hasMorebooleanoptional
400Invalid input — the `error` string says what was wrong.
errorstringrequired
401Not authenticated. Sign in first (see the Auth tag).
errorstringrequired
500Unexpected server error.
errorstringrequired

Error handling

A 400 is returned: Invalid input — the error string says what was wrong. A 401 is returned: Not authenticated. Sign in first (see the Auth tag). A 500 is returned: Unexpected server error.