| Name | Description |
|---|
name
Type: object
Required | Name of the collection.
Example: Latest Trends |
alias
Type: string
Read Only
| A unique handler string for a collection. Automatically generated from the name of collection.
Example: latest-trends |
type
Type: string
Required | Choose type as "dynamic" if you want to show products according to filters set for individual collection otherwise choose "manual".
Example: dynamic |
filters
Type: array
| A rule type for which specific collection is created. According to the rule defined, products matching the rule will be shown in that collection set on storefront.
Example: "filters":[{"field":"price","operator":"eq","value":"4000"}]
|
images
Type: array
| Images for collections.
Example: {
"image": "ms.collections/5ad88c2a569500abbd5745d2/5ad88c21f25c2cabbca59daf.png"
"_metadata": {
"image": {
"name": "Screenshot from 2017-11-02 16-34-51.png",
"type": "image/png"
}
}
}
images.image
Type: object
Required | A single image field.
Example:"image": { "name": "Screenshot from 2017-11-02 16-34-51.png", "type": "image/png" }
|
|
count
Type: string
Read Only
| It stores the count of products of a collection.
|
SEO
Type: object
| This object field contains data that affects the online visibility of a collection.
Example: "SEO":{"title": "Beautiful Saree",
"description": "Designer Sarees in chiffon, net, georgette fabrics starting from INR 1150. Buy New Designer Sarees in various prints & patterns. ✯ 100% Authentic Products ✯ Craftsvilla Assured ✯ COD.",
"keywords": "Saree,Beautiful,Designer,Latest",
"canonical_url": ""
}
SEO.title
Type: string
| The title of the product to specify a custom title for the product page for SEO. If you do not specify this field, the product name is used as the title.
Example:Beautiful Sarees | SEO.keyword
Type: string
| Enter the keywords to specify a custom meta keywords for the product page for SEO. It should be separated by commas.
Example:Saree,Beautiful,Designer,Latest | SEO.description
Type: string
| The description of the product to specify a custom meta description for the product page for SEO. If you do not specify this field, the product description is used as the meta description.
Example:Write here a short note of 30-100 words that describes your product the best. | SEO.sitemap_priority
Type: string
| Defines the priority of the particular page in your store.
|
|
default_sort_order
Type: string
| Select sort order from pre-defined values in which you want your collection to be displayed.
Example: "-created_on" |
sort_order
Type: number
| Manually provide a sorting value for your collection which you want to display.
Example: 2 |
