GET /admin/api/{api_version}/products.json
Retrieves a list of products. Note: As of version 2019-07, 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 products last updated after date. (format: 2014-04-25T16:15:47-04:00) |
vendor |
String | No |
Filter results by product vendor. |
product_type |
String | No |
Filter results by product type. |
presentment_currencies |
String | No |
Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. |
fields |
String | No |
Show only certain fields, specified by a comma-separated list of field names. |
ids |
String | No |
Return only products specified by a comma-separated list of product IDs. |
published_at_max |
String | No |
Show products published before date. (format: 2014-04-25T16:15:47-04:00) |
created_at_min |
String | No |
Show products created after date. (format: 2014-04-25T16:15:47-04:00) |
updated_at_max |
String | No |
Show products last updated before date. (format: 2014-04-25T16:15:47-04:00) |
published_status |
String | No |
Return products by their published status(default: any) |
limit |
String | No |
Return up to this many results per page.(default: 50)(maximum: 250) |
since_id |
String | No |
Restrict results to after the specified ID. |
title |
String | No |
Filter results by product title. |
created_at_max |
String | No |
Show products created before date. (format: 2014-04-25T16:15:47-04:00) |
published_at_min |
String | No |
Show products published after date. (format: 2014-04-25T16:15:47-04:00) |
collection_id |
String | No |
Filter results by product collection ID. |
handle |
String | No |
Filter results by product handle. |
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.