The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Collection
A CollectionListing resource represents a product collection that a
merchant has made available to your sales channel. Merchants can make collections available to your sales channel
directly from their Shopify admin.
You can use this resource to retrieve collections that a merchant has published and display them in your marketplace. You can also retrieve a list of published product IDs that belong to a published collection.
Only sales channels can publish collections using the REST Admin API. You can't publish collections and make them available to non-sales channels apps using the REST Admin API.
When a merchant makes a collection available to your app, the products belonging to that collection are not automatically made available. The merchant must make both the collection and each product available to your sales channel.
Endpoints
- get/admin/api/latest/collection_
listings. json Retrieve collection listings that are published to your app - get/admin/api/latest/collection_
listings/{collection_ listing_ id}. json Retrieve a specific collection listing that is published to your app - get/admin/api/latest/collection_
listings/{collection_ listing_ id}/product_ ids. json Retrieve <code>product_ids</code> that are published to a <code>collection_id</code> - put/admin/api/latest/collection_
listings/{collection_ listing_ id}. json Create a collection listing to publish a collection to your app - del/admin/api/latest/collection_
listings/{collection_ listing_ id}. json Delete a collection listing to unpublish a collection from your app
The CollectionListing resource
Properties
Identifies which collection this listing is for.
The description of the collection, complete with HTML formatting.
The default product image for a collection.
The image for a collection.
A human-friendly unique string for the Collection automatically generated from its title.
The date and time when the collection was published. The API returns this in ISO_8601.
The name of the collection.
The order in which products in the collection appear. Valid values are:
Show sort_order properties
- alpha-asc: Alphabetically, in ascending order (A - Z).
- alpha-desc: Alphabetically, in descending order (Z - A).
- best-selling: By best-selling products.
- created: By date created, in ascending order (oldest - newest).
- created-desc: By date created, in descending order (newest - oldest).
- manual: Order created by the shop owner.
- price-asc: By price, in ascending order (lowest - highest).
- price-desc: By price, in descending order (highest - lowest).
The date and time when the collection was last modified. The API returns this in ISO_8601.
The CollectionListing resource
Anchor to GET request, Retrieve collection listings that are published to your appgetRetrieve collection listings that are published to your app
product_listings access scope.Retrieve collection listings that are published to your app. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
Amount of results
Retrieve collection listings that are published to your app
Retrieve collection listings that are published to your app
/admin/api/2025-07/collection_
Response
Anchor to GET request, Retrieve a specific collection listing that is published to your appgetRetrieve a specific collection listing that is published to your app
product_listings access scope.Retrieve a specific collection listing that is published to your app
Retrieve a specific collection listing that is published to your app
Retrieve a specific collection listing that is published to your app
/admin/api/2025-07/collection_
Response
Anchor to GET request, Retrieve <code>product_ids</code> that are published to a <code>collection_id</code>getRetrieve product_
Retrieve product_ids that are published to a collection_id. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
Amount of results
Retrieve product_ids that are published to a collection_id
Retrieve product_ids that are published to a collection_id
/admin/api/2025-07/collection_
Response
Anchor to PUT request, Create a collection listing to publish a collection to your appputCreate a collection listing to publish a collection to your app
product_listings access scope.Create a collection listing to publish a collection to your app
Create a collection listing to publish a collection to your app
Create a collection listing to publish a collection to your app
Show collection_listing properties
Identifies which collection this listing is for.
/admin/api/2025-07/collection_
Response
Anchor to DELETE request, Delete a collection listing to unpublish a collection from your appdelDelete a collection listing to unpublish a collection from your app
product_listings access scope.Delete a collection listing to unpublish a collection from your app
Delete a collection listing to unpublish a collection from your app
Delete a collection listing to unpublish a collection from your app