Version: 202201
Order Count
GET/openapi/2022-01/orders/count
Provides the total number of orders matching the specified query parameters.
Request
Query Parameters
created_at_min string
Filter orders created at or after date, for example: 2016-01-18T23:41:00Z
created_at_max string
Filter orders created at or before date, for example: 2016-01-18T23:41:00Z
updated_at_min string
Filter orders updated_at at or after date, for example: 2016-01-18T23:41:00Z
updated_at_max string
Filter orders updated at or after date, for example: 2016-01-18T23:41:00Z
status string
Filter orders by status: opened, placed, finished, cancelled
financial_status string
Filter orders by financial status: waiting, paying, paid, cancelled, failed, refunding, refund_failed, refunded, partially_refunded
fulfillment_status string
Filter orders by fulfillment status: initialled, waiting, partially_shipped, shipped, partially_finished, finished, cancelled, returning, returned, partially_returned
Responses
- 200
- 422
200
- application/json
- Schema
- Example
- Result
Schema
countinteger
Default value:
0Example:
7{
"count": 7
}
{
"count": 7
}
422
- application/json
No schema