GET /admin/api/{api_version}/custom_collections.json
Retrieves a list of custom collections. 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 |
|---|---|---|---|
published_status |
String | No |
Show custom collectsion with a given published status.(default: any) |
updated_at_min |
String | No |
Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00). |
limit |
String | No |
The maximum number of results to retrieve.(default: 50)(maximum: 250) |
since_id |
String | No |
Restrict results to after the specified ID. |
title |
String | No |
Show custom collections with a given title. |
fields |
String | No |
Show only certain fields, specified by a comma-separated list of field names. |
ids |
String | No |
Show only collections specified by a comma-separated list of IDs. |
product_id |
String | No |
Show custom collections that include a given product. |
published_at_min |
String | No |
Show custom collections published after date (format: 2014-04-25T16:15:47-04:00). |
published_at_max |
String | No |
Show custom collections published before date (format: 2014-04-25T16:15:47-04:00). |
handle |
String | No |
Filter by custom collection handle. |
updated_at_max |
String | No |
Show custom collections last updated 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.