It contains all the categories that are required for a specific site.
Value | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name Type: string Required | Name of the category.
| ||||||||||||
alias Type: string | Aliases are the unique category URL on storefront. It is automatically generated from the name of brand.
| ||||||||||||
description Type: string | Brief description about the category.
| ||||||||||||
images Type: array | Images for the category.
| ||||||||||||
parent Type: string | Parent category (if any) of the category.
| ||||||||||||
count Type: integer | It stores the count of products of a category. | ||||||||||||
SEO Type: object | SEO contains data that affects the online visibility of the category on search engine.
| ||||||||||||
metafield_sets Type: array | Metafields to be used in case you need extra fields in categories. | ||||||||||||
publish Type: string | Enabling the flag makes the category visible on storefront.
| ||||||||||||
default_sort_order Type: string | Order by which products of the category will be sorted.
| ||||||||||||
widget Type: string |
data : {
name: 'Children Wear',
alias: "Children-Wear",
description: 'A place where you find the different types of fashionable dress for children',
publish: 1,
}
{ status: 200,
data: { _id: '5d4d5393b6455f39d99da051' },
messages:
[ { name: 'ms.entity.categories.add',
level: 'success',
key: 'ms.entity.categories.add' } ] }
{
"data": {
"name": "raymonds",
"alias": "raymonds",
"description": "<p><span>The more powerful the customer’s fantasy of owning the product, the more likely they are to buy it. Therefore, I like to think of </span>product descriptions as storytelling and psychology<span>, incorporating the elements of both prose writing and journalism. A “good” product description will not do. Competition is getting too fierce. It must be great!</span></p>",
"parent" : "5d789e7acbe1ee658c8b193a",
"publish": 1
}
}
{
"fileBaseUrl": "https://cdn.storehippo.com/s/57aaca10964eb5eb1362cb19/",
"data": {
"_id": "5d7b36c95c88b60315e7f1c8"
},
"messages": [
{
"name": "ms.entity.categories.add",
"level": "success",
"key": "ms.entity.categories.add"
}
]
}
{
recordId : "5d4d57acb6455f39d99da5f8",
data : {
name: 'Men Wear',
alias: 'Men-Wear'
},
"version": 1,
command : 'edit'
}
{ status: 200,
data: 'updated successfully',
messages:
[ { name: 'ms.entity.categories.edit',
level: 'success',
key: 'ms.entity.categories.edit' } ] }
{
"data": {
"name": "new raymond",
"alias": "new-raymond",
"description": "<p><span>The more powerful the customer’s fantasy of owning the product, the more likely they are to buy it. Therefore, I like to think of </span>product descriptions as storytelling and psychology<span>, incorporating the elements of both prose writing and journalism. A “good” product description will not do. Competition is getting too fierce. It must be great!</span></p>",
"parent" : "5d789e7acbe1ee658c8b193a",
"publish": 1
}
}
{
"fileBaseUrl": "https://cdn.storehippo.com/s/57aaca10964eb5eb1362cb19/",
"data": "updated successfully",
"messages": [
{
"name": "ms.entity.categories.edit",
"level": "success",
"key": "ms.entity.categories.edit"
}
]
}
skipResolveTask |