Storeden Developers

Brands API

Current version: v1.1

List brands

GET
/brands/list.json
[
	{
		"uid": 102978,
		"name": "APPLE",
		"slug": "apple-inc",
		"description": "Best offerts about iPhone, iPad, MacBook and iPod"
	},
	...
]
					

Get brand entity

GET
/brands/brand.json
uid required (uid) Unique brand uid identifier
{
	"uid": 102978,
	"name": "APPLE",
	"slug": "apple-inc",
	"description": "Best offerts about iPhone, iPad, MacBook and iPod",
	"seo": {
        "title": "",
        "description": "",
        "keywords": "",
        "robots": ""
    },
    "disabled": false,
    "default_sort": "inherit"
}
					

Add a new brand

POST
/brands/brand.json
name required (string) New brand name
If brand already exists, this call will return the brand UID
description (string) Brand description
disabled (int) Set value to 1 to disable brand
seo_title (string) Seo title, used into Head > Title tag
seo_description (string) Seo title, used into Head > Meta description tag
seo_keywords (string) Seo title, used into Head > Meta keywords tag
{
	"uid": 114510
}
					

Update brand data

PUT
/brands/brand.json
uid required (int) Unique brand identifier
name required (string) Brand name
description (string) Brand description. HTML usage is restricted
disabled (int) Set this field to 1 disable the brand visibilit on Shop page.
seo_title (string) Seo title, used into Head > Title tag
seo_description (string) Seo title, used into Head > Meta description tag
seo_keywords (string) Seo title, used into Head > Meta keywords tag
{
	"ok": 1,
	"err": null,
	"updatedExisting": true
}
					

Remove brand

DELETE
/brands/brand.json
uid required (int) Unique brand identifier
{
	"ok": 1,
	"err": null,
}
					

Update brand visibility

PUT
/brands/visibility.json
uid required (int) Unique brand identifier
status required (int) Specify 1 to make brand visible on e-commerce or 0 to hide from storefront
{
	"ok": 1,
	"nModified": 1,
	"n": 1,
	"err": null,
	"errmsg": null,
	"updatedExisting": true
}