更新商品专辑

PUT 
/openapi/2022-01/collections/:id

通过唯一 ID 与请求体内容更新已有商品专辑的详细信息。

请求

Path参数

id string必填

待更新的专辑 ID（UUID 格式）。

application/json

请求体

请求体

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.

srcstring必填

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

示例

{
  "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
  }
}

响应

200

200

application/json

数据结构

数据结构

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

示例

{
  "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

数据结构

数据结构

errorsstring[]

示例

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

Result

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

422

422

application/json

数据结构

数据结构

errorsstring[]

示例

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

Result

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