Get brands

Shop API v1
GET*base*/brands
GET*base*/brands/*brandId*
Authentication:API key

Fetches a specific brand referenced by its ID, or the full list of brands..

If the brandId parameter is specified, one brand is fetched, otherwise all brands in the catalog are fetched.

Parameters

brandId

int
optional
Brand ID as integer.

Response

200 Content-type: application/json

object key

brand object
required

The brandId for the brand object.

"14": {"name": "Brand X"} for brand ID 14.

name

string
The name of the brand.

brand

string
The ID of the brand.

uri

string
The URI for this brand.

metaKeywords metaDescription metaTitle

string
Meta data about the brand.

Response example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
HTTP/1.1 200 OK
Content-type: application/json

{
   "1" : {
      "name" : "Brand Name",
      "brand" : "1",
      "uri" : "brandname",
      "metaKeywords" : "",
      "metaDescription" : "",
      "metaTitle" : ""
   }
}

Error example

1
2
3
4
5
6
7
8
HTTP/1.1 404 Not Found
Content-type: application/json

{
   "errors" : {
      "brand" : "not found"
   }
}