CollectionListing
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-01/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/2020-01/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/2020-01/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/2020-01/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/2020-01/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/2020-01/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/2020-01/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/2020-01/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/2020-01/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/2020-01/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-04/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/2020-04/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/2020-04/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/2020-04/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/2020-04/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/2020-04/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/2020-04/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/2020-04/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/2020-04/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/2020-04/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-07/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/2020-07/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/2020-07/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/2020-07/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/2020-07/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/2020-07/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/2020-07/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/2020-07/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/2020-07/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/2020-07/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/2020-10/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/2020-10/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/2020-10/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/2020-10/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/2020-10/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/2020-10/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/2020-10/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/2020-10/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/2020-10/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/2020-10/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/2021-01/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/2021-01/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/2021-01/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/2021-01/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/2021-01/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/2021-01/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/2021-01/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/2021-01/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/2021-01/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/2021-01/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/2021-04/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/2021-04/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/2021-04/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/2021-04/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/2021-04/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/2021-04/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/2021-04/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/2021-04/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/2021-04/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/2021-04/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
Sales Channel SDK
The CollectionListing resource is available to Sales Channel SDK applications only.
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.
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.
What you can do with CollectionListing
The Shopify API lets you do the following with the CollectionListing resource. More detailed versions of these general actions may be available:
- GET /admin/api/unstable/collection_listings.json Retrieve collection listings that are published to your app
-
GET /admin/api/unstable/collection_listings/{collection_listing_id}/product_ids.json
Retrieve
product_ids
that are published to acollection_id
- GET /admin/api/unstable/collection_listings/{collection_listing_id}.json Retrieve a specific collection listing that is published to your app
- PUT /admin/api/unstable/collection_listings/{collection_listing_id}.json Create a collection listing to publish a collection to your app
- DELETE /admin/api/unstable/collection_listings/{collection_listing_id}.json Delete a collection listing to unpublish a collection from your app
CollectionListing properties
collection_id
read-only |
Identifies which collection this listing is for. |
body_html
read-only |
The description of the collection, complete with HTML formatting. |
default_product_image
read-only |
The default product image for a collection. |
image
read-only |
The image for a collection. |
handle
read-only |
A human-friendly unique string for the Collection automatically generated from its title. |
published_at
read-only |
The date and time when the collection was published. The API returns this in ISO_8601. |
title
read-only |
The name of the collection. |
sort_order
read-only |
The order in which products in the collection appear. Valid values are:
|
updated_at
read-only |
The date and time when the collection was last modified. The API returns this in ISO_8601. |
Endpoints
page
parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve collection listings that are published to your app
GET /admin/api/unstable/collection_listings.json
View Response
HTTP/1.1 200 OK
{
"collection_listings": [
{
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "Smart iPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 841564295,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"title": "IPods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
},
{
"collection_id": 395646240,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever. Again</p>",
"default_product_image": {
"id": 850703190,
"created_at": "2021-01-01T14:04:27-05:00",
"position": 1,
"updated_at": "2021-01-01T14:04:27-05:00",
"product_id": 632910392,
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1609527867",
"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": "2021-01-01T14:04:27-05:00",
"body_html": "<p>No ipods here</p>",
"default_product_image": null,
"handle": "non-ipods",
"image": null,
"title": "Non Ipods",
"sort_order": "manual",
"published_at": "2017-08-31T20:00:00-04:00"
}
]
}
product_ids
that are published to a collection_id
. Note: As of version 2019-07, 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.
limit
|
Amount of results (default:50 , maximum: 1000 )
|
Retrieve product_ids
that are published to a collection_id
GET /admin/api/unstable/collection_listings/841564295/product_ids.json
View Response
HTTP/1.1 200 OK
{
"product_ids": [
632910392
]
}
Retrieve a specific collection listing that is published to your app
GET /admin/api/unstable/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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
PUT /admin/api/unstable/collection_listings/482865238.json
{
"collection_listing": {
"collection_id": 482865238
}
}
View Response
HTTP/1.1 200 OK
{
"collection_listing": {
"collection_id": 482865238,
"updated_at": "2021-01-01T14:04:27-05:00",
"body_html": "<p>The best selling ipod ever</p>",
"default_product_image": null,
"handle": "smart-ipods",
"image": {
"created_at": "2021-01-01T14:04:27-05:00",
"src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1609527867"
},
"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 /admin/api/unstable/collection_listings/482865238.json
View Response
HTTP/1.1 200 OK