Collection Properties

🔒
Requires collection access scope.

Collection properties

Fields	Type	Desc
id	string	The ID of the collection.
title	string	The title of the collection.
description	string	The description of the collection, supports rich text.
handle	string	The SEO link
smart	string	Whether it is a smart .
image	image	The image for the collection.
seo_title	string	SEO title.
seo_description	string	SEO description.
seo_keywords	string	SEO keywords, separated by English commas.
sort_order	string	Collection merchandise sorting rules: - `sales-desc`: by total sales volume, hight 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 card 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 - `manual`: manually
created_at	string	Creation time, formatted as ISO-8601
updated_at	string	Last modification time, formatted as ISO-8601

Example

{
  "id": "e79e6138-ae9a-4046-8d6c-50883c20535e",
  "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": "manual",
  "created_at": "2024-04-17T07:33:02Z",
  "updated_at": "2024-04-17T07:35:11Z"
}

🔒Requires collection access scope.

Collection properties

Example

🔒
Requires `collection` access scope.