List Brands

GET

https://api.bigcommerce.com/stores/store_hash/v3/catalog/brands

GET

/stores/store_hash/v3/catalog/brands

1 curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/brands \
2      -H "X-Auth-Token: <apiKey>"

1 {
2   "data": [
3     {
4       "name": "Sagaform",
5       "id": 35,
6       "page_title": "",
7       "meta_keywords": [
8         ""
9       ],
10       "meta_description": "",
11       "search_keywords": "",
12       "image_url": "",
13       "custom_url": {
14         "url": "/brands/Sagaform.html",
15         "is_customized": false
16       }
17     },
18     {
19       "name": "OFS",
20       "id": 36,
21       "page_title": "OFS",
22       "meta_keywords": [
23         "modern",
24         "clean",
25         "contemporary"
26       ],
27       "meta_description": "OFS is a modern brand.",
28       "search_keywords": "kitchen, laundry, cart, storage",
29       "image_url": "",
30       "custom_url": {
31         "url": "/brands/OFS.html",
32         "is_customized": false
33       }
34     },
35     {
36       "name": "Common Good",
37       "id": 37,
38       "page_title": "",
39       "meta_keywords": [
40         ""
41       ],
42       "meta_description": "",
43       "search_keywords": "",
44       "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/k/screen%20shot%202018-05-07%20at%2012.24.24%20pm_1525785365__65102.png",
45       "custom_url": {
46         "url": "/brands/Common-Good.html",
47         "is_customized": false
48       }
49     },
50     {
51       "name": "BigCommerce",
52       "id": 38,
53       "page_title": "",
54       "meta_keywords": [
55         ""
56       ],
57       "meta_description": "",
58       "search_keywords": "",
59       "image_url": "",
60       "custom_url": {
61         "url": "/bigcommerce/",
62         "is_customized": false
63       }
64     },
65     {
66       "name": "Test Brand One",
67       "id": 39,
68       "page_title": "",
69       "meta_keywords": [
70         ""
71       ],
72       "meta_description": "",
73       "search_keywords": "",
74       "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/q/apihqggzm__53766.jpg",
75       "custom_url": {
76         "url": "/test-brand-one/",
77         "is_customized": false
78       }
79     },
80     {
81       "name": "Fog Linen Work",
82       "id": 40,
83       "page_title": "",
84       "meta_keywords": [
85         ""
86       ],
87       "meta_description": "description",
88       "search_keywords": "",
89       "image_url": "",
90       "custom_url": {
91         "url": "/fog-linen-work/",
92         "is_customized": false
93       }
94     },
95     {
96       "name": "Barr-Co.",
97       "id": 41,
98       "page_title": "",
99       "meta_keywords": [
100         ""
101       ],
102       "meta_description": "description",
103       "search_keywords": "",
104       "image_url": "",
105       "custom_url": {
106         "url": "/barr-co/",
107         "is_customized": false
108       }
109     },
110     {
111       "name": "Thames & Hudson",
112       "id": 42,
113       "page_title": "",
114       "meta_keywords": [
115         ""
116       ],
117       "meta_description": "description",
118       "search_keywords": "",
119       "image_url": "",
120       "custom_url": {
121         "url": "/thames-hudson/",
122         "is_customized": false
123       }
124     },
125     {
126       "name": "Able Brewing",
127       "id": 43,
128       "page_title": "",
129       "meta_keywords": [
130         ""
131       ],
132       "meta_description": "description",
133       "search_keywords": "",
134       "image_url": "",
135       "custom_url": {
136         "url": "/able-brewing/",
137         "is_customized": false
138       }
139     },
140     {
141       "name": "Chemex",
142       "id": 44,
143       "page_title": "",
144       "meta_keywords": [
145         ""
146       ],
147       "meta_description": "description",
148       "search_keywords": "",
149       "image_url": "",
150       "custom_url": {
151         "url": "/chemex/",
152         "is_customized": false
153       }
154     },
155     {
156       "name": "Kinfolk",
157       "id": 45,
158       "page_title": "",
159       "meta_keywords": [
160         ""
161       ],
162       "meta_description": "description",
163       "search_keywords": "",
164       "image_url": "",
165       "custom_url": {
166         "url": "/kinfolk/",
167         "is_customized": false
168       }
169     },
170     {
171       "name": "Iris Hantverk",
172       "id": 46,
173       "page_title": "",
174       "meta_keywords": [
175         ""
176       ],
177       "meta_description": "description",
178       "search_keywords": "",
179       "image_url": "",
180       "custom_url": {
181         "url": "/iris-hantverk/",
182         "is_customized": false
183       }
184     },
185     {
186       "name": "Gather Journal",
187       "id": 47,
188       "page_title": "",
189       "meta_keywords": [
190         ""
191       ],
192       "meta_description": "description",
193       "search_keywords": "",
194       "image_url": "",
195       "custom_url": {
196         "url": "/gather-journal/",
197         "is_customized": false
198       }
199     },
200     {
201       "name": "Openhouse Magazine",
202       "id": 48,
203       "page_title": "",
204       "meta_keywords": [
205         ""
206       ],
207       "meta_description": "description",
208       "search_keywords": "",
209       "image_url": "",
210       "custom_url": {
211         "url": "/openhouse-magazine/",
212         "is_customized": false
213       }
214     },
215     {
216       "name": "Smith Journal",
217       "id": 49,
218       "page_title": "",
219       "meta_keywords": [
220         ""
221       ],
222       "meta_description": "description",
223       "search_keywords": "",
224       "image_url": "",
225       "custom_url": {
226         "url": "/smith-journal/",
227         "is_customized": false
228       }
229     }
230   ],
231   "meta": {
232     "pagination": {
233       "total": 15,
234       "count": 15,
235       "per_page": 50,
236       "current_page": 1,
237       "total_pages": 1,
238       "links": {
239         "current": "?page=1&limit=50"
240       }
241     }
242   }
243 }

Returns a list of brands. Optional filter parameters can be passed in.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Query parameters

idintegerOptional

Filter items by ID.

id:inlist of integersOptional

id:not_inlist of integersOptional

id:minlist of integersOptional

id:maxlist of integersOptional

id:greaterlist of integersOptional

id:lesslist of integersOptional

namestringOptional

Filter items by name.

name:likestringOptional

Filter items by part of a name. For example, name:like=new returns brands with names that include new.

page_titlestringOptional

Filter items by page_title.

pageintegerOptional

Specifies the page number in a limited (paginated) list of products.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of products.

include_fieldslist of stringsOptional

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fieldslist of stringsOptional

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

sortenumOptional

Field name to sort by.

Allowed values:

directionenumOptional

Sort direction. Acceptable values are: asc, desc.

Allowed values:

Response

datalist of objects

metaobject

Data about the response, including pagination and collection totals.

Errors

403

Forbidden Error

List Brands

Authentication

OAuth scopes

Authentication header

Further reading

Query parameters

Response

Errors

OAuth scopes

Authentication header

Further reading