REST API port

  2. 主页
  4. 文档
  6. REST API port
  8. Orders
  10. GET Retrieve a list of orders

GET Retrieve a list of orders

Gets the list of orders that meet the criteria.

API：GET/rest/api/2021-07/orders/list

Parameters

Parameters
Data Type
created_at_min
string

Show orders created at or after date.(format: 2014-04-25T16:15:47-04:00)

created_at_max
string

Show orders created at or before date.(format: 2014-04-25T16:15:47-04:00)

updated_at_min
string

Show orders updated at or after date.(format: 2014-04-25T16:15:47-04:00)

updated_at_max
string

Show orders updated at or before date.(format: 2014-04-25T16:15:47-04:00)

status
string

Orders of a given status.(open: Open orders; closed: Closed orders; any: Orders of any status;)

financial_status
string

Filter orders by their financial status.(pending: Show only pending orders; paid: Show only paid orders; refunded: Show only refunded orders; partial_refund：Show only partially refunded orders; any: Show orders of any financial status;)

fulfillment_status
string

Filter orders by their fulfillment status.(shipped: Show orders that have been shipped; partial: Show partially shipped orders; unshipped: Show orders that have not yet been shipped; any: Orders of any fulfillment status;)

ids
string

Retrieve only orders specified by a comma-separated list of order IDs.

limit
integer

The maximum number of results to show on a page.(default: 50, maximum: 250;)

since_id
string

Show orders after the specified ID.