CollectionListing

Version 2019-10

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:

CollectionListing properties

collection_id
read-only
"collection_id": 1053727709

Identifies which collection this listing is for.

body_html
read-only
"body_html": "It's a collection of curated products for the home page."

The description of the collection, complete with HTML formatting.

default_product_image
read-only
"default_product_image": [
  {
    "src": "http://example.com/burton.jpg"
  }
]

The default product image for a collection.

image
read-only
"image": [
  {
    "src": "http://example.com/burton.jpg"
  }
]

The image for a collection.

handle
read-only
"handle": "ipod-nano"

A human-friendly unique string for the Collection automatically generated from i