Helpcenter +918010117117 https://cdn1.storehippo.com/s/573db3149f0d58741f0cc63b/ms.settings/5256837ccc4abf1d39000001/57614ef64256dc6851749879-480x480.png" support@storehippo.com 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

Introduction

Overview How to call Authentication Request Response Pagination Filtering Sorting

API Reference

Brands

(ms.brands)

It contains the brands of the product for a particular website.

Fields
EndPoints

Fields

ValueDescription
name   
Type: string
Required
Name of brand visible on storefront.
Nike
alias   
Type: string
Aliases are the unique brand URL on storefront. It is automatically generated from the name of brand.
nike
description   
Type: string
Brief description about the brand.
Everything you need for your sport & life.
images   
Type: array
Images for the brand.
{
"images": [
    {
      "image": "ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif"
    }
  ]
}
image
Type: file
Required
Single image related to the brand.
ms.brands/583bd9a634a6d66f1881e490/583bdb33962e6d28283338ab.gif
count   
Type: string
It stores the count of products of a brand.
publish   
Type: string
Enabling the flag makes the brand visible on storefront.
1
SEO   
Type: object
SEO contains data that affects the online visibility of a brand on search engine.
{ 
  "SEO": {
    "title": "Get Nike products upto 60% off",
    "description": "Everything you need for your sport. Limited offer. Hurry.",
    "keywords": "Nike products, Limited offer"
  }
}
title
Type: string
The title of the brand to specify a custom title for the brand page for SEO.
Get Nike products upto 60% off
description
Type: string
Specify a custom meta description for the brand page for SEO.
Everything you need for your sport. Limited offer. Hurry.
keywords
Type: string
Keywords are used to specify a custom meta keywords for the brand page for SEO.
Nike products, Limited offer
canonical_url
Type: string
The canonical URL is used to declare a single page as its source or for duplicate pages to reference their source/originating page.
sitemap_priority
Type: string
Sitemap priority defines the priority of the particular page in your store.
0.3

Commands (Endpoints)

PUT /api/1.1/entity/ms.brands/{resource_id}   
Updates an existing brand