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

Categories

(ms.categories)

you need swagger

Contains all the categories that are required for a specific site.

Fields

Name Description
name
Type: string
 Required 		Name of the category. Example:

Women's Apparels
alias
Type: string
 		A unique handler string for a categories. Automatically generated from the name of categories. Example:

women-apparels
description
Type: string
 		Brief description about the category. Example:

A variety of women products.
images
Type: array
 		Multiple images related to the category. Example: 
"images":[{"image":"sample-image-woman.png","caption":"Women Apparels"}]
images.image
Type: file
Required 		Single image related to the category. Example:

sample-image-women.png
images.caption
Type: string
 This field holds text which acts as title of image on storefront. Example:

Women Apparels
parent
Type: string
 		Parent category (if any) of the category. Example:

Apparels
count
Type: string
 Read Only
Number of products saved under the category.
SEO
Type: object
 		Contains SEO variables like title, description, keywords, canonical url and sitemap priority. Example: 
"SEO": {
        "title": "Send a Bouquet of 200 Roses in Bangalore, Order Flowers Online in Bangalore",
        "description": "Send a bunch of 200 roses in Bangalore at ₹ 2499/- Same day delivery in Bangalore. Bangalore Blooms is  one of the oldest florist in Bangalore to 'Send Flowers in Bangalore' and to 'Order Cakes in Bangalore'",
        "keywords": "Exotic flowers, florists in bangalore, flower delivery bangalore, send flowers to bangalore, local florist in bangalore, florist bangalore"
    }
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 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.
metafield_sets
Type: array
 		Meta fields to be used in case extend entity is used.
publish
Type: string
 		Flag that determines if a category is published i.e. visible to users.
default_sort_order
Type: string
 		Order by which a category's children will be sorted. Example:

By date: Newest to oldest

Commands

Name Routes
add post  /api/1/entity/ms.categories TRY IT !
edit put  /api/1/entity/ms.categories/{_id} TRY IT !
list get  /api/1/entity/ms.categories TRY IT !
get get  /api/1/entity/ms.categories/{_id} TRY IT !
delete delete  /api/1/entity/ms.categories/{_id} TRY IT !
duplicate put  /api/1/entity/ms.categories/{_id}/_duplicate TRY IT !

Categories

(ms.categories)

you need swagger

Contains all the categories that are required for a specific site.

Fields

Name Description
name
Type: string
 Required 		Name of the category. Example:

Women's Apparels

alias
Type: string
 		A unique handler string for a categories. Automatically generated from the name of categories. Example:

women-apparels

description
Type: string
 		Brief description about the category. Example:

A variety of women products.

images.image
Type: file
 Required 		Single image related to the category. Example:

sample-image-women.png

images
Type: array
 		Multiple images related to the category. Example: 
"images":[{"image":"sample-image-woman.png","caption":"Women Apparels"}]

images.image
Type: file
Required 		Single image related to the category. Example:

sample-image-women.png
images.caption
Type: string
 This field holds text which acts as title of image on storefront. Example:

Women Apparels
fields
Type: array

parent
Type: string
 		Parent category (if any) of the category. Example:

Apparels

count
Type: string
 Read Only
Number of products saved under the category.

SEO
Type: object
 		Contains SEO variables like title, description, keywords, canonical url and sitemap priority. Example: 
"SEO": {
        "title": "Send a Bouquet of 200 Roses in Bangalore, Order Flowers Online in Bangalore",
        "description": "Send a bunch of 200 roses in Bangalore at ₹ 2499/- Same day delivery in Bangalore. Bangalore Blooms is  one of the oldest florist in Bangalore to 'Send Flowers in Bangalore' and to 'Order Cakes in Bangalore'",
        "keywords": "Exotic flowers, florists in bangalore, flower delivery bangalore, send flowers to bangalore, local florist in bangalore, florist bangalore"
    }

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 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.
metafield_sets
Type: array
 		Meta fields to be used in case extend entity is used.

publish
Type: string
 		Flag that determines if a category is published i.e. visible to users.

attributes
Type: array

default_sort_order
Type: string
 		Order by which a category's children will be sorted. Example:

By date: Newest to oldest

images.caption
Type: string
 		This field holds text which acts as title of image on storefront. Example:

Women Apparels

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 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.

Commands

Name Routes
add post  /api/1/entity/ms.categories TRY IT !
edit put  /api/1/entity/ms.categories/{_id} TRY IT !
list get  /api/1/entity/ms.categories TRY IT !
get get  /api/1/entity/ms.categories/{_id} TRY IT !
delete delete  /api/1/entity/ms.categories/{_id} TRY IT !
duplicate put  /api/1/entity/ms.categories/{_id}/_duplicate TRY IT !