Brands
This is used to view, create, update and delete brands.
Brand Properties
id |
{ "id" : 255 }
The unique ID of the brand |
title |
{ "title": "Acme" }
The title/name of the brand |
description |
{ "description" : "Established in 1996."}
The description for the brand |
url |
{ "url" : "http://www.shopname.com/acme" }
The full URL for the brand |
active |
{ "active" : true }
Either true or false |
metaTitle |
{ "metaTitle" : "Acme Shoes" }
The title tag for the brand page |
metaDescription |
{ "metaDescription" : "Come and take a look at Acme." }
The meta description for the brand page |
metaKeywords |
{ "metaKeywords" : "shoes, acme" }
The meta keywords for the brand page |
image |
{ "image" : "https://static.ecommercedns.uk/images/456A0.jpg" }
The image object (present only when the Brand has an image), the image object has a single property url |
What you can do with brands
GET /v1/brands
Receive a list of all brands
GET /v1/brands/count
Count the number of brands
GET /v1/brands/ID
Receive a brand
POST /v1/brands
Create a new brand
PUT /v1/brands/ID
Update a brand
DELETE /v1/brands/ID
Delete a brand
GET /v1/brands
Returns all brands. By default the first 50 brands (both active and inactive) are returned, sorted by creation date.
fields | Comma separated list of properties to include |
sort | title or title_desc (default is creation date) |
active | 0 or 1 |
count | Count |
offset | Offset |
GET /v1/brands
HTTP/1.1 200 OK [ { "id": 1, "title": "...", "description": "...", "url": "http://www.domain.com/slug", "active": true, "metaTitle": "...", "metaKeywords": "...", "metaDescription": "...", "image": { "url": "https://static.ecommercedns.uk/images/456e70cea611e36883b4dd3e02bb3a70.jpg?1" } } ]
GET /v1/brands/count
Returns a count of the brands.
active | 0 or 1 |
GET /v1/brands/count
HTTP/1.1 200 OK { "count": 99 }
GET /v1/brands/ID
Returns a single brand.
fields | Comma separated list of properties to include |
GET /v1/brands/1
HTTP/1.1 200 OK { "id": 1, "title": "...", "description": "...", "url": "http://www.domain.com/slug", "active": true, "metaTitle": "...", "metaKeywords": "...", "metaDescription": "...", "image": { "url": "https://static.ecommercedns.uk/images/456e70cea611e36883b4dd3e02bb3a70.jpg?1" } }
POST /v1/brands
Creates a new brand.
title | required |
description | optional |
active | default is true |
metaTitle | optional |
metaDescription | optional |
metaKeywords | optional |
slug | optional (do not include the domain name) |
image | URL or base64 encoded image |
POST /v1/brands
POST /v1/brands { "title": "Brand Title" "slug": "brand-title", "image": "http://www.domain.com/images/test.jpg" }
POST /v1/brands
HTTP/1.1 201 Created HTTP/1.1 201 Created { "id": 3, "title": "Brand Title", "description": "", "url": "http://www.shopname.com/brand-title", "active": true, "metaTitle": "", "metaDescription": "", "image": { "url": "https://static.ecommercedns.uk/images/456e70cea611e36883b4dd3e02bb3a70.jpg?1" } }
PUT /v1/brands/ID
Update a brand. All object properties are allowed.
PUT /v1/brands/3
PUT /v1/brands/3 { "active": false, "slug": "brand" }
PUT /v1/brands/3
HTTP/1.1 200 OK { "id": 3, "title": "Brand Title", "description": "", "url": "http://www.shopname.com/brand", "active": false, "metaTitle": "", "metaKeywords": "", "metaDescription": "", "image": { "url": "https://static.ecommercedns.uk/images/456e70cea611e36883b4dd3e02bb3a70.jpg?1" } }
DELETE /v1/brands/ID
Deletes an existing brand.
Returns 204 No Content on success.