List Orders
GET {{baseUrl}}/v1/orders?limit=<string>&ending_before=<string>&starting_after=<string>
Retrieve a list of all orders.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
limit | string | The maximum number of orders to return. Range - 1-100. Default is 10. | |
ending_before | string | The ID of the order created after the last order you want to retrieve. | |
starting_after | string | The ID of the order created before the first order you want to retrieve. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"status":{"error_code":"\u003cstring\u003e","message":"\u003cstring\u003e","operation_id":"\u003cstring\u003e","response_code":"\u003cstring\u003e","status":"\u003cstring\u003e"},"data":[{"id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","amount_returned":"\u003cnumber\u003e","payment":"\u003cstring\u003e","created":"\u003cinteger\u003e","customer":"\u003cstring\u003e","currency":"\u003cstring\u003e","email":"\u003cstring\u003e","external_coupon_code":"\u003cstring\u003e","items":[{"amount":"\u003cnumber\u003e","currency":"BAM","description":"\u003cstring\u003e","parent":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","currency":"RWF","description":"\u003cstring\u003e","parent":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"metadata":{},"returns":[{"amount":"\u003cnumber\u003e","currency":"BDT","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","currency":"BND","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"shipping_address":{},"status":"\u003cstring\u003e","status_transitions":{"canceled":"\u003cnumber\u003e","fulfilled":"\u003cnumber\u003e","paid":"\u003cnumber\u003e","returned":"\u003cnumber\u003e","pending":"\u003cnumber\u003e","partial":"\u003cnumber\u003e"},"updated":"\u003cinteger\u003e","upstream_id":"\u003cstring\u003e","tax_percent":"\u003cnumber\u003e"},{"id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","amount_returned":"\u003cnumber\u003e","payment":"\u003cstring\u003e","created":"\u003cinteger\u003e","customer":"\u003cstring\u003e","currency":"\u003cstring\u003e","email":"\u003cstring\u003e","external_coupon_code":"\u003cstring\u003e","items":[{"amount":"\u003cnumber\u003e","currency":"HNL","description":"\u003cstring\u003e","parent":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","currency":"GNF","description":"\u003cstring\u003e","parent":"\u003cstring\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"metadata":{},"returns":[{"amount":"\u003cnumber\u003e","currency":"SVC","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"},{"amount":"\u003cnumber\u003e","currency":"BGN","description":"\u003cstring\u003e","parent":"\u003cnumber\u003e","quantity":"\u003cnumber\u003e","type":"\u003cstring\u003e"}],"shipping_address":{},"status":"\u003cstring\u003e","status_transitions":{"canceled":"\u003cnumber\u003e","fulfilled":"\u003cnumber\u003e","paid":"\u003cnumber\u003e","returned":"\u003cnumber\u003e","pending":"\u003cnumber\u003e","partial":"\u003cnumber\u003e"},"updated":"\u003cinteger\u003e","upstream_id":"\u003cstring\u003e","tax_percent":"\u003cnumber\u003e"}]}