Brands
(ms.brands)
Contain the brands of the product for a particular website.
Fields
| Name | Description | ||
|---|---|---|---|
| name Type: string Required | This field stores name of brand which will be visible on storefront. Example: test brand | ||
| alias Type: string Required | A unique handler string for a brand. Automatically generated from the name of brand. Example: test-brand | ||
| description Type: string | Brief description about the brand. Example: brand_description | ||
| images Type: array | An image of a brand. Example:
| ||
| SEO Type: object | This object field contains data that affects the online visibility of a brand. Example: | ||
| count Type: number Read Only | It stores the count of products of a brand. | ||
| publish Type: string | Flag that determines if a brand is published i.e. visible to users. | ||
| default_sort_order Type: string | Select sort order from pre-defined values in which you want your brand to be displayed. | ||
| sort_order Type: number | You can manually provide a sorting value for your brand which you want to display. |
Commands
| Name | Routes |
|---|---|
| add | post /api/1/entity/ms.brands TRY IT ! |
| edit | put /api/1/entity/ms.brands/{_id} TRY IT ! |
| list | get /api/1/entity/ms.brands TRY IT ! |
| get | get /api/1/entity/ms.brands/{_id} TRY IT ! |
| delete | delete /api/1/entity/ms.brands/{_id} TRY IT ! |
Brands
(ms.brands)
Contain the brands of the product for a particular website.
Fields
| Name | Description | ||
|---|---|---|---|
| name Type: string Required | This field stores name of brand which will be visible on storefront. Example: test brand | ||
| alias Type: string Required | A unique handler string for a brand. Automatically generated from the name of brand. Example: test-brand | ||
| description Type: string | Brief description about the brand. Example: brand_description | ||
| images.image Type: file Required | A single image field. Example: ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif | ||
| images Type: array | An image of a brand. Example:
| ||
| SEO Type: object | This object field contains data that affects the online visibility of a brand. Example: | ||
| count Type: number Read Only | It stores the count of products of a brand. | ||
| publish Type: string | Flag that determines if a brand is published i.e. visible to users. | ||
| default_sort_order Type: string | Select sort order from pre-defined values in which you want your brand to be displayed. | ||
| sort_order Type: number | You can manually provide a sorting value for your brand which you want to display. |
Commands
| Name | Routes |
|---|---|
| add | post /api/1/entity/ms.brands TRY IT ! |
| edit | put /api/1/entity/ms.brands/{_id} TRY IT ! |
| list | get /api/1/entity/ms.brands TRY IT ! |
| get | get /api/1/entity/ms.brands/{_id} TRY IT ! |
| delete | delete /api/1/entity/ms.brands/{_id} TRY IT ! |