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.

Anchor to section titled 'undefined'

Collection

Requires products access scope.

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.

Was this section helpful?
#Endpoints
Anchor to section titled 'The Collection resource'

The Collection resource

Properties
body_html
->descriptionHtml
A description of the collection, complete with HTML markup. Many templates display this on their collection pages.
handle
->handle
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

Image associated with the collection. Valid values are:

id
read-only
->id
The ID for the collection.
published_at
read-only
->publishDate

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

published_scope
read-only
->publishable
Whether the collection is published to the Point of Sale channel. Valid values:
sort_order
->sortOrder

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

template_suffix
->templateSuffix
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
->title
The name of the collection. (limit: 255 characters)
updated_at
read-only
->updatedAt
The date and time (ISO 8601 format) when the collection was last modified.
Was this section helpful?
{}The Collection resource
{
  "body_html": "<p>The best selling iPods ever</p>",
  "handle": "ipods",
  "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"
  },
  "id": 841564295,
  "published_at": "2008-02-01T19:00:00-05:00",
  "published_scope": "global",
  "sort_order": "manual",
  "template_suffix": "custom",
  "title": "IPods",
  "updated_at": "2008-02-01T19:00:00-05:00"
}
Anchor to section titled 'GET request, Retrieves a single collection'

get
Retrieves a single collection

collection
Retrieves a single collection
Anchor to section titled 'Parameters of Retrieves a single collection'

Parameters

api_version
string
required
collection_id
string
required
fields
Show only certain fields, specified by a comma-separated list of field names.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a single collection'

Examples

Path parameters
collectionid=841564295
string
required
Was this section helpful?
get
/admin/api/2024-10/collections/841564295.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/collections/841564295.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
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": "2024-09-24T10:33:18-04:00",
      "alt": "MP3 Player 8gb",
      "width": 123,
      "height": 456,
      "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/collections/ipod_nano_8gb.jpg?v=1727188398"
    }
  }
}
Anchor to section titled 'GET request, Retrieve a list of products belonging to a collection'

get
Retrieve a list of products belonging to a collection

collection
Retrieve a list of products belonging to a collection. 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.. The products returned are sorted by the collection's sort order.
Anchor to section titled 'Parameters of Retrieve a list of products belonging to a collection'

Parameters

api_version
string
required
collection_id
string
required
limit
≤ 250
default 50
The number of products to retrieve.
Was this section helpful?
Anchor to section titled 'Examples of Retrieve a list of products belonging to a collection'

Examples

Path parameters
collectionid=841564295
string
required
Was this section helpful?
get
/admin/api/2024-10/collections/841564295/products.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/collections/841564295/products.json" \
-H "X-Shopify-Access-Token: {access_token}"
{}Response
JSON
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": "2024-09-24T10:33:18-04:00",
      "handle": "ipod-nano",
      "updated_at": "2024-09-24T10:33:18-04: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,
          "alt": null,
          "position": 1,
          "product_id": 632910392,
          "created_at": "2024-09-24T10:33:18-04:00",
          "updated_at": "2024-09-24T10:33:18-04:00",
          "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727188398"
        },
        {
          "id": 562641783,
          "alt": null,
          "position": 2,
          "product_id": 632910392,
          "created_at": "2024-09-24T10:33:18-04:00",
          "updated_at": "2024-09-24T10:33:18-04:00",
          "admin_graphql_api_id": "gid://shopify/ProductImage/562641783",
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano-2.png?v=1727188398"
        },
        {
          "id": 378407906,
          "alt": null,
          "position": 3,
          "product_id": 632910392,
          "created_at": "2024-09-24T10:33:18-04:00",
          "updated_at": "2024-09-24T10:33:18-04:00",
          "admin_graphql_api_id": "gid://shopify/ProductImage/378407906",
          "width": 123,
          "height": 456,
          "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727188398"
        }
      ],
      "image": {
        "id": 850703190,
        "alt": null,
        "position": 1,
        "product_id": 632910392,
        "created_at": "2024-09-24T10:33:18-04:00",
        "updated_at": "2024-09-24T10:33:18-04:00",
        "admin_graphql_api_id": "gid://shopify/ProductImage/850703190",
        "width": 123,
        "height": 456,
        "src": "https://cdn.shopify.com/s/files/1/0005/4838/0009/products/ipod-nano.png?v=1727188398"
      }
    }
  ]
}