🔒

Requires write_collection access scope. More access scope

The Create Collection API allows users to create a new collection in the store, including details like the title, description, associated products, SEO attributes, and merchandise sorting rules. This endpoint provides flexibility for managing collections and organizing products effectively.This API is especially useful for:

1. Create a collection to group related products for better categorization.
2. Apply specific sorting rules to arrange products in the collection.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Body Parameters

Sort Order Options

• manual: Default manual sorting.
• sales-desc: By total sales volume, high to low.
• published-desc: By product published time, newest first.
• real-sales-desc: By product real sales, more to less.
• inventory-quantity-asc: By inventory quantity, less to more.
• inventory-quantity-desc: By inventory quantity, more to less.
• views-desc: By product page views, more to less.
• add-to-cart-count-desc: By add-to-cart count, more to less.
• updated-desc: By product update time, newest first.
• vendor-asc: By supplier name A-Z.
• vendor-desc: By supplier name Z-A.
• alpha-asc: By product title A-Z.
• alpha-desc: By product title Z-A.
• price-asc: By price, low to high.
• price-desc: By price, high to low.
• created-desc: By creation time, newest first.

Response Explanation

Successful Response

error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Request Examples

curl --request POST \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/collections \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}' \
     --header 'content-type: application/json' \
     --data '{
         "collection": {
             "title": "Summer Collection",
             "handle": "summer-collection",
             "description": "A collection of summer products.",
             "image": {
                 "src": "http://cdn.shoplazza.com/image.jpg",
                 "width": 300,
                 "height": 300,
                 "alt": "Summer Collection Image"
             },
             "seo_title": "Summer Collection",
             "seo_description": "Explore our summer collection.",
             "seo_keywords": "summer, collection, products",
             "sort_order": "sales-desc",
             "product_ids": "123e4567-e89b-12d3-a456-426614174000,456e7890-e12b-34d5-c678-123456789abc"
         }
     }'

Success Response Example

{
  "collection": {
    "id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
    "title": "Test-Collection",
    "description": "Desc",
    "handle": "test-collection",
    "smart": false,
    "image": {
      "src": "//cdn.shoplazza.com/loading.png",
      "width": 100,
      "height": 100,
      "alt": "",
      "path": "loading.png"
    },
    "seo_title": "seo_title",
    "seo_description": "Desc",
    "seo_keywords": "test",
    "sort_order": "title-asc",
    "created_at": "2024-04-16T10:31:12Z",
    "updated_at": "2024-04-16T10:31:12Z"
  }
}

Error Response Example

{
  "errors": [
     "Title is taken."
  ]
}

{
  "error": "store is not active"
}

Error Details