The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Multiple access scopes needed — refer to each endpoint for access scope requirements.
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.
Note:
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.
The order in which products in the collection appear. Valid values are:
Requires access scope.
Requires access scope.
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.Requires access scope.
Requires access scope.