Update collection

PUT 
/openapi/2026-07/collections/:id

Allows users to update details of an existing collection by providing the collection ID and the desired updates in the request body.

Request

Path Parameters

id stringrequired

Collection ID. Must be a valid UUID

application/json

Body

Bodyrequired

collection objectrequired

Collection

titlestring

The name of the collection

handlestring

A unique URL-friendly identifier for the collection

descriptionstring

The description of the collection

image object

Image

srcstringrequired

The source URL of the collection image

widthint32

The width of the collection image in pixels

heightint32

The height of the collection image in pixels

altstring

Alt text for the collection image

seo_titlestring

The SEO title for the collection

seo_keywordsstring[]

The keywords for SEO

seo_descriptionstring

The SEO description for the collection

sort_orderstring

Merchandise sorting rules. Options include: manual (default), sales-desc, price-asc, price-desc, views-desc, vendor-asc, vendor-desc, created-desc, intelligent and more

Default value: manual

product_idsstring[]

List of product IDs to fully replace the collection. Must be valid UUIDs If provided, this field takes precedence over add_product_ids and delete_product_ids.

add_product_idsstring[]

List of product IDs to add to the existing collection. Must be valid UUIDs Ignored if product_ids is specified.

delete_product_idsstring[]

List of product IDs to remove from the existing collection. Must be valid UUIDs Ignored if product_ids is specified.

tagsstring[]

List of tags for the collection

Example

{
  "collection": {
    "title": "string",
    "handle": "string",
    "description": "string",
    "image": {
      "src": "string",
      "width": 0,
      "height": 0,
      "alt": "string"
    },
    "seo_title": "string",
    "seo_keywords": [
      "string"
    ],
    "seo_description": "string",
    "sort_order": "manual",
    "product_ids": [
      "string"
    ],
    "add_product_ids": [
      "string"
    ],
    "delete_product_ids": [
      "string"
    ],
    "tags": [
      "string"
    ]
  }
}

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

collection object

Collection

idstring

Collection ID

titlestring

Title

descriptionstring

Description

handlestring

URL-friendly identifier (handle)

smartboolean

Smart

image object

Image

srcstring

The source URL of the image

widthint32

The width of the image in pixels

heightint32

The height of the image in pixels

altstring

Alt text for the image

seo_titlestring

SEO title

seo_keywordsstring[]

SEO keywords

seo_descriptionstring

SEO description

sort_orderstring

Sort order

created_atstring

Creation timestamp, in ISO-8601 format

updated_atstring

Last update timestamp, in ISO-8601 format

match_rules object

Smart collection match rules

disjunctiveboolean

Whether conditions are disjunctive (OR)

rule_modules object[]

List of rule modules

Array [

disjunctiveboolean

Whether conditions are disjunctive (OR)

rules object[]

List of rules in this module

Array [

columnstring

Column

relationstring

Relation

conditionstring

Condition

]

]

tagsstring[]

List of tags for the collection

product_countint64

Number of products in the collection

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "collection": {
      "id": "string",
      "title": "string",
      "description": "string",
      "handle": "string",
      "smart": true,
      "image": {
        "src": "string",
        "width": 0,
        "height": 0,
        "alt": "string"
      },
      "seo_title": "string",
      "seo_keywords": [
        "string"
      ],
      "seo_description": "string",
      "sort_order": "string",
      "created_at": "string",
      "updated_at": "string",
      "match_rules": {
        "disjunctive": true,
        "rule_modules": [
          {
            "disjunctive": true,
            "rules": [
              {
                "column": "string",
                "relation": "string",
                "condition": "string"
              }
            ]
          }
        ]
      },
      "tags": [
        "string"
      ],
      "product_count": 0
    }
  }
}