Product Brands API
List Product Brands
GET /products/brands
| Attribute | Type | Required | Description |
|---|---|---|---|
context | string | No | Scope under which the request is made; determines fields present in response. |
page | integer | No | Current page of the collection. Defaults to 1. |
per_page | integer | No | Maximum number of items to be returned in result set. Defaults to no limit. Values between 0 and 100 are allowed. |
search | string | No | Limit results to those matching a string. |
exclude | array | No | Ensure result set excludes specific IDs. |
include | array | No | Limit result set to specific IDs. |
order | string | No | Sort ascending or descending. Allowed values: asc, desc. Defaults to asc. |
orderby | string | No | Sort by term property. Allowed values: name, slug, count. Defaults to name. |
hide_empty | boolean | No | If true, empty terms will not be returned. Defaults to true. |
parent | integer | No | Limit results to those with a specific parent ID. |
curl "https://example-store.com/wp-json/wc/store/v1/products/brands"
Example response:
[
{
"id": 16,
"name": "Nike",
"slug": "nike",
"description": "This is the Nike brand.",
"parent": 0,
"count": 11,
"image": {
"id": 55,
"src": "https://store.local/wp-content/uploads/2021/11/nike-logo.jpg",
"thumbnail": "https://store.local/wp-content/uploads/2021/11/nike-logo-324x324.jpg",
"srcset": "https://store.local/wp-content/uploads/2021/11/nike-logo.jpg 800w, https://store.local/wp-content/uploads/2021/11/nike-logo-324x324.jpg 324w, https://store.local/wp-content/uploads/2021/11/nike-logo-100x100.jpg 100w, https://store.local/wp-content/uploads/2021/11/nike-logo-416x416.jpg 416w, https://store.local/wp-content/uploads/2021/11/nike-logo-300x300.jpg 300w, https://store.local/wp-content/uploads/2021/11/nike-logo-150x150.jpg 150w, https://store.local/wp-content/uploads/2021/11/nike-logo-768x768.jpg 768w",
"sizes": "(max-width: 800px) 100vw, 800px",
"name": "nike-logo.jpg",
"alt": ""
},
"review_count": 2,
"permalink": "https://store.local/product-brand/nike/"
},
{
"id": 21,
"name": "Adidas",
"slug": "adidas",
"description": "",
"parent": 0,
"count": 1,
"image": null,
"review_count": 1,
"permalink": "https://store.local/product-brand/adidas/"
}
]
Single Product Brand
Get a single brand.
GET /products/brands/:id
or
GET /products/brands/:slug
| Parameter | Type | Required | Description |
|---|---|---|---|
identifier | string | Yes | The identifier of the brand to retrieve. Can be a brand ID or slug. |
curl "https://example-store.com/wp-json/wc/store/v1/products/brands/1"
or
curl "https://example-store.com/wp-json/wc/store/v1/products/brands/adidas"
Example response:
{
"id": 1,
"name": "Adidas",
"slug": "adidas",
"description": "",
"parent": 0,
"count": 1,
"image": null,
"review_count": 1,
"permalink": "https://store.local/product-brand/adidas/"
}