🔒

Requires write_collection access scope. More access scope

The Update Collection API allows users to update details of an existing collection by providing the collection ID and the desired updates in the request body. This API supports updates to various attributes, including the title, description, SEO details, associated products, and more.This API is especially useful for:

1. Modify collection details such as title, description, or handle.
2. Update the associated image, SEO metadata, and sorting order for merchandise.

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. be store123.

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

Path Parameters

Body Parameters

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 PUT \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/collections/{id} \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}' \
     --header 'content-type: application/json' \
     --data '{
         "collection": {
             "title": "Updated Summer Collection",
             "description": "Updated description for summer collection.",
             "image": {
                 "src": "//cdn.shoplazza.com/image.jpg",
                 "width": 800,
                 "height": 600,
                 "alt": "Updated collection image"
             },
             "seo_title": "Updated Best Summer Collection",
             "seo_description": "Updated shop the best summer collection.",
             "seo_keywords": "summer, updated clothing, fashion",
             "sort_order": "sales-desc",
             "product_ids": "prod1-id,prod3-id",
             "is_clear_all_product_ids": false
         }
     }'
    

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": [
     "Collection not found"
  ]
}

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

Error Details