Update Collection

PUT 
/openapi/2022-01/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's ID

application/json

Body

Body

collection object

titlestring

The title of the collection.

handlestring

The SEO link, the C-end album link is https://{subdomain}.myshoplaza.com/collections/{handle}.

seo_titlestring

SEO title.

seo_keywordsstring

SEO keywords, separated by English commas.

seo_descriptionstring

SEO description.

descriptionstring

The description of the collection, supports rich text.

image object

The image for the collection. This image is added to the collection's page in the Shoplazza admin.

srcstringrequired

Image's URL

widthint32

Image's width in px

heightint32

Image's height in px

altstring

Image's alt

sort_orderstring

Collection merchandise sorting rules:

- alpha-asc: merchandise title dictionary in ascending order
- alpha-desc: merchandise title dictionary in reverse order
- price-asc: merchandise price in ascending order
- price-desc: merchandise price in reverse order
- created-desc: merchandise creation time in ascending order
- manual manual sorting, sorted in the order of the product_ids field.

product_idsstring

Product IDs inside this collection, separated by comma, for example: 0097cfc8-6ec3-40ed-ab9f-6f2231b705a6,0097cfc8-6ec3-40ed-ab9f-6f2231b705a6

is_clear_all_product_idsboolean

Whether to clear the collection

Example

{
  "collection": {
    "title": "string",
    "handle": "string",
    "seo_title": "string",
    "seo_keywords": "string",
    "seo_description": "string",
    "description": "string",
    "image": {
      "src": "string",
      "width": 0,
      "height": 0,
      "alt": "string"
    },
    "sort_order": "string",
    "product_ids": "string",
    "is_clear_all_product_ids": true
  }
}

Responses

200

200

application/json

Schema

Schema

collection object
idstring
Example: a60fe556-43ad-4e07-9125-507ac1bf71f7
titlestring
Example: Test-Collection
descriptionstring
Example: Desc
handlestring
Example: test-collection
smartboolean
Default value: true
Example: false
image object
srcstring
Example: //cdn.shoplazza.com/9de53f9726576696b318a8d95c0946cb.jpeg
widthinteger
Default value: 0
Example: 1920
heightinteger
Default value: 0
Example: 1080
altstring
Example:
pathstring
Example: 9de53f9726576696b318a8d95c0946cb.jpeg
seo_titlestring
Example: seo_title
seo_descriptionstring
Example: Desc
seo_keywordsstring
Example: test
sort_orderstring
Example: title-desc
created_atstring
Example: 2024-04-16T10:31:13Z
updated_atstring
Example: 2024-04-16T11:29:32Z

Example

{
  "collection": {
    "id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
    "title": "Test-Collection",
    "description": "Desc",
    "handle": "test-collection",
    "smart": false,
    "image": {
      "src": "//cdn.shoplazza.com/9de53f9726576696b318a8d95c0946cb.jpeg",
      "width": 1920,
      "height": 1080,
      "alt": "",
      "path": "9de53f9726576696b318a8d95c0946cb.jpeg"
    },
    "seo_title": "seo_title",
    "seo_description": "Desc",
    "seo_keywords": "test",
    "sort_order": "title-desc",
    "created_at": "2024-04-16T10:31:13Z",
    "updated_at": "2024-04-16T11:29:32Z"
  }
}

Result

{
    "collection": {
        "id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
        "title": "Test-Collection",
        "description": "Desc",
        "handle": "test-collection",
        "smart": false,
        "image": {
            "src": "//cdn.shoplazza.com/9de53f9726576696b318a8d95c0946cb.jpeg",
            "width": 1920,
            "height": 1080,
            "alt": "",
            "path": "9de53f9726576696b318a8d95c0946cb.jpeg"
        },
        "seo_title": "seo_title",
        "seo_description": "Desc",
        "seo_keywords": "test",
        "sort_order": "title-desc",
        "created_at": "2024-04-16T10:31:13Z",
        "updated_at": "2024-04-16T11:29:32Z"
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Collection not found"
  ]
}

Result

{
  "errors": [
    "Collection not found"
  ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "productIds has an invalid UUID"
  ]
}

Result

{
  "errors": [
    "productIds has an invalid UUID"
  ]
}