# CollectionListing
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.
The order in which products in the collection appear. Valid values are:
The best selling ipod ever
","default_product_image":null,"handle":"smart-ipods","image":{"created_at":"2025-01-02T11:09:43-05:00","src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/collections/ipod_nano_8gb.jpg?v=1735834183"},"title":"Smart iPods","sort_order":"manual","published_at":"2017-08-31T20:00:00-04:00"},{"collection_id":841564295,"updated_at":"2025-01-02T11:09:43-05:00","body_html":"The best selling ipod ever
","default_product_image":null,"handle":"ipods","image":{"created_at":"2025-01-02T11:09:43-05:00","src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/collections/ipod_nano_8gb.jpg?v=1735834183"},"title":"IPods","sort_order":"manual","published_at":"2017-08-31T20:00:00-04:00"},{"collection_id":395646240,"updated_at":"2025-01-02T11:09:43-05:00","body_html":"The best selling ipod ever. Again
","default_product_image":{"id":850703190,"created_at":"2025-01-02T11:09:43-05:00","position":1,"updated_at":"2025-01-02T11:09:43-05:00","product_id":632910392,"src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1735834183","variant_ids":[],"width":123,"height":456},"handle":"ipods_two","image":null,"title":"IPods Two","sort_order":"manual","published_at":"2017-08-31T20:00:00-04:00"},{"collection_id":691652237,"updated_at":"2025-01-02T11:09:43-05:00","body_html":"No ipods here
","default_product_image":null,"handle":"non-ipods","image":null,"title":"Non Ipods","sort_order":"manual","published_at":"2017-08-31T20:00:00-04:00"}]} ``` ## Retrieveproduct_ids
that are published to a collection_id
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.
### Endpoint
/admin/api/#{api_version}/collection_listings/{collection_listing_id}/product_ids.json (GET)
### Parameters
* api_version (required):
* collection_listing_id (required):
* limit: Amount of results
### Responses
#### 200
Retrieve product_ids
that are published to a collection_id
Examples:
##### Retrieve product_ids
that are published to a collection_id
Request:
```
GET /admin/api/unstable/collection_listings/841564295/product_ids.json
```
Response:
```
HTTP/1.1 200 OK
{"product_ids":[632910392]}
```
## Retrieve a specific collection listing that is published to your app
Retrieve a specific collection listing that is published to your app
### Endpoint
/admin/api/#{api_version}/collection_listings/{collection_listing_id}.json (GET)
### Parameters
* api_version (required):
* collection_listing_id (required):
### Responses
#### 200
Retrieve a specific collection listing that is published to your app
Examples:
##### Retrieve a specific collection listing that is published to your app
Request:
```
GET /admin/api/unstable/collection_listings/482865238.json
```
Response:
```
HTTP/1.1 200 OK
{"collection_listing":{"collection_id":482865238,"updated_at":"2025-01-02T11:09:43-05:00","body_html":"The best selling ipod ever
","default_product_image":null,"handle":"smart-ipods","image":{"created_at":"2025-01-02T11:09:43-05:00","src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/collections/ipod_nano_8gb.jpg?v=1735834183"},"title":"Smart iPods","sort_order":"manual","published_at":"2017-08-31T20:00:00-04:00"}} ``` ## Create a collection listing to publish a collection to your app Create a collection listing to publish a collection to your app ### Endpoint /admin/api/#{api_version}/collection_listings/{collection_listing_id}.json (PUT) ### Parameters * api_version (required): * collection_listing_id (required): ### Responses #### 200 Create a collection listing to publish a collection to your app Examples: ##### Create a collection listing to publish a collection to your app Request: ``` PUT /admin/api/unstable/collection_listings/482865238.json {"collection_listing":{"collection_id":482865238}} ``` Response: ``` HTTP/1.1 200 OK {"collection_listing":{"collection_id":482865238,"updated_at":"2025-01-02T11:09:43-05:00","body_html":"The best selling ipod ever
","default_product_image":null,"handle":"smart-ipods","image":{"created_at":"2025-01-02T11:09:43-05:00","src":"https://cdn.shopify.com/s/files/1/0005/4838/0009/collections/ipod_nano_8gb.jpg?v=1735834183"},"title":"Smart iPods","sort_order":"manual","published_at":"2017-08-31T20:00:00-04:00"}} ``` ## Delete a collection listing to unpublish a collection from your app Delete a collection listing to unpublish a collection from your app ### Endpoint /admin/api/#{api_version}/collection_listings/{collection_listing_id}.json (DELETE) ### Parameters * api_version (required): * collection_listing_id (required): ### Responses #### 200 Delete a collection listing to unpublish a collection from your app Examples: ##### Delete a collection listing to unpublish a collection from your app Request: ``` DELETE /admin/api/unstable/collection_listings/841564295.json ``` Response: ``` HTTP/1.1 200 OK ```