Collection

Version 2020-01 (Latest)

A collection is a grouping of products that merchants can create to make their stores easier to browse. For example, a merchant might create a collection for a specific type of product that they sell, such as Footwear. Merchants can create collections by selecting products individually or by defining rules that automatically determine whether products are included.

Shopify stores start with a single collection, called Frontpage. This is a collection of products that are shown on the front page of the online store.

There are two different types of collection:

  • Custom collections, which contain products that are manually added to a collection by a merchant. For more information, see the CustomCollection resource.
  • Smart collections, which contain products that are automatically added based on selection conditions that a merchant chooses. For more information, see the SmartCollection resource.

The Collect resource is used to connect a product to a custom collection.

What you can do with Collection

The Shopify API lets you do the following with the Collection resource. More detailed versions of these general actions may be available:

Collection properties

body_html
"body_html": "<p>The best selling iPods ever</p>"

A description of the collection, complete with HTML markup. Many templates display this on their collection pages.

handle
"handle": "ipods"

A unique, human-readable string for the collection automatically generated from its title. This is used in themes by the Liquid templating language to refer to the collection. (limit: 255 characters)

image
"image": {
  "src": "http://static.shopify.com/collections/ipod.jpg?0",
  "alt": "iPods",
  "width": 500,
  "height": 488,
  "created_at": "2018-04-19T09:34:47-04:00"
}

Image associated with the collection. Valid values are:

  • attachment: An image attached to a collection returned as Base64-encoded binary data.
  • src: The source URL that specifies the location of the image.
  • alt: The alternative text that describes the collection image.
  • created_at: The time and date (ISO 8601 format) when the image was added to the collection.
  • width: The width of the image in pixels.
  • height: The height of the image in pixels.
id
read-only
"id": 841564295

The ID for the collection.

published_at
read-only
"published_at": "2008-02-01T19:00:00-05:00"

The time and date (ISO 8601 format) when the collection was made visible. Returns null for a hidden collection.

published_scope
read-only
"published_scope": "global"

Whether the collection is published to the Point of Sale channel. Valid values:

  • web: The collection is published to the Online Store channel but not published to the Point of Sale channel.
  • global: The collection is published to both the Online Store channel and the Point of Sale channel.
sort_order
"sort_order": "manual"

The order in which products in the collection appear. Valid values:

  • 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: In the order set manually by the shop owner.
  • price-asc: By price, in ascending order (lowest - highest).
  • price-desc: By price, in descending order (highest - lowest).
template_suffix
"template_suffix": "custom"

The suffix of the liquid template being used. For example, if the value is custom, then the collection is using the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid.

title
required
"title": "IPods"

The name of the collection. (limit: 255 characters)

updated_at
read-only
"updated_at": "2008-02-01T19:00:00-05:00"

The date and time (ISO 8601 format) when the collection was last modified.

Endpoints

GET /admin/api/2020-01/collections/#{collection_id}.json
Retrieves a single collection
fields

Show only certain fields, specified by a comma-separated list of field names.

Retrieve a specific collection by its ID

GET /admin/api/2020-01/collections/#{collection_id}.json
View Response
HTTP/1.1 200 OK
{
  "collection": {
    "id": 841564295,
    "handle": "ipods",
    "title": "IPods",
    "updated_at": "2008-02-01T19:00:00-05:00",
    "body_html": "<p>The best selling ipod ever</p>",
    "published_at": "2008-02-01T19:00:00-05:00",
    "sort_order": "manual",
    "template_suffix": null,
    "products_count": 1,
    "collection_type": "custom",
    "published_scope": "web",
    "admin_graphql_api_id": "gid://shopify/Collection/841564295",
    "image": {
      "created_at": "2020-01-14T10:26:56-05:00",
      "alt": "iPod Nano 8gb",
      "width": 123,
      "height": 456,
      "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1579015616"
    }
  }
}
GET /admin/api/2020-01/collections/#{collection_id}/products.json
Retrieve a list of products belonging to a collection. Note: As of version 2019-10, 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.. The products returned are sorted by the collection's sort order.
limit

The number of products to retrieve.

(default: 50, maximum: 250)

Retrieve a list of products belonging to a collection

GET /admin/api/2020-01/collections/#{collection_id}/products.json
View Response
HTTP/1.1 200 OK
{
  "products": [
    {
      "id": 632910392,
      "title": "IPod Nano - 8GB",
      "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
      "vendor": "Apple",
      "product_type": "Cult Products",
      "created_at": "2020-01-14T10:26:56-05:00",
      "handle": "ipod-nano",
      "updated_at": "2020-01-14T10:26:56-05:00",
      "published_at": "2007-12-31T19:00:00-05:00",
      "template_suffix": null,
      "published_scope": "web",
      "tags": "Emotive, Flash Memory, MP3, Music",
      "admin_graphql_api_id": "gid://shopify/Product/632910392",
      "options": [
        {
          "id": 594680422,
          "product_id": 632910392,
          "name": "Color",
          "position": 1
        }
      ],
      "images": [
        {
          "id": 850703190,
          "product_id": 632910392,
          "position": 1,
          "created_at": "2020-01-14T10:26:56-05:00",
          "updated_at": "2020-01-14T10:26:56-05:00",
          "alt": null,
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1579015616",
          "variant_ids": [],
          "admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
        },
        {
          "id": 562641783,
          "product_id": 632910392,
          "position": 2,
          "created_at": "2020-01-14T10:26:56-05:00",
          "updated_at": "2020-01-14T10:26:56-05:00",
          "alt": null,
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1579015616",
          "variant_ids": [
            808950810
          ],
          "admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
        }
      ],
      "image": {
        "id": 850703190,
        "product_id": 632910392,
        "position": 1,
        "created_at": "2020-01-14T10:26:56-05:00",
        "updated_at": "2020-01-14T10:26:56-05:00",
        "alt": null,
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1579015616",
        "variant_ids": [],
        "admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
      }
    }
  ]
}
Version 2020-04 (Release candidate)

A collection is a grouping of products that merchants can create to make their stores easier to browse. For example, a merchant might create a collection for a specific type of product that they sell, such as Footwear. Merchants can create collections by selecting products individually or by defining rules that automatically determine whether products are included.

Shopify stores start with a single collection, called Frontpage. This is a collection of products that are shown on the front page of the online store.

There are two different types of collection:

  • Custom collections, which contain products that are manually added to a collection by a merchant. For more information, see the CustomCollection resource.
  • Smart collections, which contain products that are automatically added based on selection conditions that a merchant chooses. For more information, see the SmartCollection resource.

The Collect resource is used to connect a product to a custom collection.

What you can do with Collection

The Shopify API lets you do the following with the Collection resource. More detailed versions of these general actions may be available:

Collection properties

body_html
"body_html": "<p>The best selling iPods ever</p>"

A description of the collection, complete with HTML markup. Many templates display this on their collection pages.

handle
"handle": "ipods"

A unique, human-readable string for the collection automatically generated from its title. This is used in themes by the Liquid templating language to refer to the collection. (limit: 255 characters)

image
"image": {
  "src": "http://static.shopify.com/collections/ipod.jpg?0",
  "alt": "iPods",
  "width": 500,
  "height": 488,
  "created_at": "2018-04-19T09:34:47-04:00"
}

Image associated with the collection. Valid values are:

  • attachment: An image attached to a collection returned as Base64-encoded binary data.
  • src: The source URL that specifies the location of the image.
  • alt: The alternative text that describes the collection image.
  • created_at: The time and date (ISO 8601 format) when the image was added to the collection.
  • width: The width of the image in pixels.
  • height: The height of the image in pixels.
id
read-only
"id": 841564295

The ID for the collection.

published_at
read-only
"published_at": "2008-02-01T19:00:00-05:00"

The time and date (ISO 8601 format) when the collection was made visible. Returns null for a hidden collection.

published_scope
read-only
"published_scope": "global"

Whether the collection is published to the Point of Sale channel. Valid values:

  • web: The collection is published to the Online Store channel but not published to the Point of Sale channel.
  • global: The collection is published to both the Online Store channel and the Point of Sale channel.
sort_order
"sort_order": "manual"

The order in which products in the collection appear. Valid values:

  • 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: In the order set manually by the shop owner.
  • price-asc: By price, in ascending order (lowest - highest).
  • price-desc: By price, in descending order (highest - lowest).
template_suffix
"template_suffix": "custom"

The suffix of the liquid template being used. For example, if the value is custom, then the collection is using the collection.custom.liquid template. If the value is null, then the collection is using the default collection.liquid.

title
required
"title": "IPods"

The name of the collection. (limit: 255 characters)

updated_at
read-only
"updated_at": "2008-02-01T19:00:00-05:00"

The date and time (ISO 8601 format) when the collection was last modified.

Endpoints

GET /admin/api/2020-04/collections/#{collection_id}.json
Retrieves a single collection
fields

Show only certain fields, specified by a comma-separated list of field names.

Retrieve a specific collection by its ID

GET /admin/api/2020-04/collections/#{collection_id}.json
View Response
HTTP/1.1 200 OK
{
  "collection": {
    "id": 841564295,
    "handle": "ipods",
    "title": "IPods",
    "updated_at": "2008-02-01T19:00:00-05:00",
    "body_html": "<p>The best selling ipod ever</p>",
    "published_at": "2008-02-01T19:00:00-05:00",
    "sort_order": "manual",
    "template_suffix": null,
    "products_count": 1,
    "collection_type": "custom",
    "published_scope": "web",
    "admin_graphql_api_id": "gid://shopify/Collection/841564295",
    "image": {
      "created_at": "2020-01-14T10:26:56-05:00",
      "alt": "iPod Nano 8gb",
      "width": 123,
      "height": 456,
      "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/collections/ipod_nano_8gb.jpg?v=1579015616"
    }
  }
}
GET /admin/api/2020-04/collections/#{collection_id}/products.json
Retrieve a list of products belonging to a collection. Note: As of version 2019-10, 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.. The products returned are sorted by the collection's sort order.
limit

The number of products to retrieve.

(default: 50, maximum: 250)

Retrieve a list of products belonging to a collection

GET /admin/api/2020-04/collections/#{collection_id}/products.json
View Response
HTTP/1.1 200 OK
{
  "products": [
    {
      "id": 632910392,
      "title": "IPod Nano - 8GB",
      "body_html": "<p>It's the small iPod with one very big idea: Video. Now the world's most popular music player, available in 4GB and 8GB models, lets you enjoy TV shows, movies, video podcasts, and more. The larger, brighter display means amazing picture quality. In six eye-catching colors, iPod nano is stunning all around. And with models starting at just $149, little speaks volumes.</p>",
      "vendor": "Apple",
      "product_type": "Cult Products",
      "created_at": "2020-01-14T10:26:56-05:00",
      "handle": "ipod-nano",
      "updated_at": "2020-01-14T10:26:56-05:00",
      "published_at": "2007-12-31T19:00:00-05:00",
      "template_suffix": null,
      "published_scope": "web",
      "tags": "Emotive, Flash Memory, MP3, Music",
      "admin_graphql_api_id": "gid://shopify/Product/632910392",
      "options": [
        {
          "id": 594680422,
          "product_id": 632910392,
          "name": "Color",
          "position": 1
        }
      ],
      "images": [
        {
          "id": 850703190,
          "product_id": 632910392,
          "position": 1,
          "created_at": "2020-01-14T10:26:56-05:00",
          "updated_at": "2020-01-14T10:26:56-05:00",
          "alt": null,
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1579015616",
          "variant_ids": [],
          "admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
        },
        {
          "id": 562641783,
          "product_id": 632910392,
          "position": 2,
          "created_at": "2020-01-14T10:26:56-05:00",
          "updated_at": "2020-01-14T10:26:56-05:00",
          "alt": null,
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano-2.png?v=1579015616",
          "variant_ids": [
            808950810
          ],
          "admin_graphql_api_id": "gid://shopify/ProductImage/562641783"
        }
      ],
      "image": {
        "id": 850703190,
        "product_id": 632910392,
        "position": 1,
        "created_at": "2020-01-14T10:26:56-05:00",
        "updated_at": "2020-01-14T10:26:56-05:00",
        "alt": null,
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0006/9093/3842/products/ipod-nano.png?v=1579015616",
        "variant_ids": [],
        "admin_graphql_api_id": "gid://shopify/ProductImage/850703190"
      }
    }
  ]
}

Sign up for a Partner account to get started.

Sign up