GET /admin/api/{api_version}/smart_collections.json
Retrieves a list of smart collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. 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 |
---|---|---|---|
published_status |
String | No |
Filter results based on the published status of smart collections.(default: any) |
updated_at_min |
String | No |
Show smart collections last updated after this date. (format: 2014-04-25T16:15:47-04:00) |
limit |
String | No |
The number of results to show.(default: 50)(maximum: 250) |
since_id |
String | No |
Restrict results to after the specified ID. |
title |
String | No |
Show smart collections with the specified title. |
fields |
String | No |
Show only certain fields, specified by a comma-separated list of field names. |
ids |
String | No |
Show only the smart collections specified by a comma-separated list of IDs. |
product_id |
String | No |
Show smart collections that includes the specified product. |
published_at_min |
String | No |
Show smart collections published after this date. (format: 2014-04-25T16:15:47-04:00) |
published_at_max |
String | No |
Show smart collections published before this date. (format: 2014-04-25T16:15:47-04:00) |
handle |
String | No |
Filter results by smart collection handle. |
updated_at_max |
String | No |
Show smart collections last updated before this 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.