Helpcenter +918010117117 https://help.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" [email protected] https://www.facebook.com/StoreHippohttps://twitter.com/StoreHippohttps://www.linkedin.com/company/hippoinnovations/https://plus.google.com/+Storehippo/posts
B4,309-10 Spaze iTech Park, Sector 49, Sohna Road, 122001 Gurgaon India

Related Topics

StoreHippo API Global Widgets Global Objects

Resources

Overview ms.blogs ms.brands ms.carts ms.categories ms.collections ms.coupon_codes ms.discounts_new ms.domains ms.email_logs ms.enquiries ms.fulfillments ms.invoices ms.languages ms.mailing_lists ms.navigations ms.notifications ms.orders ms.pages ms.products ms.redirects ms.reviews ms.sellers ms.ssl_certificates ms.store_ledger ms.store_locations ms.users

Brands

(ms.brands)

you need swagger

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: 
"images": [
    {
      "image": "ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif"
    }
  ]
images.image
Type: file
Required 		A single image field. Example:

ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif
SEO
Type: object
 		This object field contains data that affects the online visibility of a brand. Example: 
"SEO": {
    "title": "testing",
    "description": "tesing brand"
  }
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)

you need swagger

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: 
"images": [
    {
      "image": "ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif"
    }
  ]

images.image
Type: file
Required 		A single image field. Example:

ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif
SEO
Type: object
 		This object field contains data that affects the online visibility of a brand. Example: 
"SEO": {
    "title": "testing",
    "description": "tesing brand"
  }

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 !