GET /admin/api/{api_version}/orders.json
Retrieves a list of orders. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
Servers
- https://{store_name}.myshopify.com
- {store_name}.myshopify.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
api_version |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
x-shopify-access-token |
String | No |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
updated_at_min |
String | No |
Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00). |
financial_status |
String | No |
Filter orders by their financial status.(default: any) |
status |
String | No |
Filter orders by their status.(default: open) |
processed_at_min |
String | No |
Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00). |
fields |
String | No |
Retrieve only certain fields, specified by a comma-separated list of fields names. |
ids |
String | No |
Retrieve only orders specified by a comma-separated list of order IDs. |
attribution_app_id |
String | No |
Show orders attributed to a certain app, specified by the app ID. Set as |
created_at_min |
String | No |
Show orders created at or after date (format: 2014-04-25T16:15:47-04:00). |
updated_at_max |
String | No |
Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00). |
name |
String | No | |
limit |
String | No |
The maximum number of results to show on a page.(default: 50)(maximum: 250) |
fulfillment_status |
String | No |
Filter orders by their fulfillment status.(default: any) |
since_id |
String | No |
Show orders after the specified ID. |
created_at_max |
String | No |
Show orders created at or before date (format: 2014-04-25T16:15:47-04:00). |
processed_at_max |
String | No |
Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00). |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.