Brands REST API

woocommerce-brands-rest-api-doc.md

Brands REST API

The Brands REST API allows you to create, view, update, and delete individual, or a batch, of brands. The endpoint is /wp-json/wc/v1/products/brands which basically mimics /wp-json/wc/v1/products/categories. You can refer to the same documentation of product categories REST API.

In addition to /products/brands endpoints, the /products endpoints also updated to display brands in the response and check the JSON request for brands.

Examples

• Retrieve all product brands:

  curl https://example.com/wp-json/wc/v2/products/brands -u consumer_key:consumer_secret
  

• Create a product brand:

  curl -X POST https://example.com/wp-json/wc/v2/products/brands \
   -u consumer_key:consumer_secret \
   -H "Content-Type: application/json" \
   -d '{
   "name": "Apple",
   "image": {
     "src": "https://upload.wikimedia.org/wikipedia/commons/thumb/f/fa/Apple_logo_black.svg/768px-Apple_logo_black.svg.png"
    }
  }'
  

• Delete a product brand:

  curl -X DELETE https://example.com/wp-json/wc/v2/products/brands/9?force=true -u consumer_key:consumer_secret
  

• Set brands to a product:

   curl -X PUT https://example.com/wp-json/wc/v2/products/123 \
    -u consumer_key:consumer_secret \
    -H 'Content-Type: application/json' \
    -d '{"brands": [48, 49]}'
  

  Note: When setting a brand to a product the url needs to be products/123 where 123 is the id of the product you want to update.

Why not use {"brands": [ {"id": 48}, {"id": 49} ]} to set brands, the same way you set categories. It took me a while to find this page and see that the standard has changed

Can you list all products associated to a specific brand through the api?

Such as https://example.com/wp-json/wc/v2/products?brand_id=48

hi!

what about the v3 of the API?

{
"code": "rest_no_route",
"message": "No route was found matching the URL and request method.",
"data": {
"status": 404
}
}

Why not use {"brands": [ {"id": 48}, {"id": 49} ]} to set brands, the same way you set categories. It took me a while to find this page and see that the standard has changed

Exactly, it does not work the same as categories.
Can this be mentioned in the docs?

{
"code": "rest_no_route",
"message": "No route was found matching the URL and request method.",
"data": {
"status": 404
}
}

This should work: https://example/wp-json/wc/v3/products/brands?consumer_key=123&consumer_secret=abc

{
"code": "rest_no_route",
"message": "No route was found matching the URL and request method.",
"data": {
"status": 404
}
}

This should work: https://example/wp-json/wc/v3/products/brands?consumer_key=123&consumer_secret=abc

Still getting the same error

{
"code": "rest_no_route",
"message": "No route was found matching the URL and request method.",
"data": {
"status": 404
}
}

This should work: https://example/wp-json/wc/v3/products/brands?consumer_key=123&consumer_secret=abc

Still getting the same error

@thetahmeed is there any updates about that? facing same issue

{
"code": "rest_no_route",
"message": "No route was found matching the URL and request method.",
"data": {
"status": 404
}
}

This should work: https://example/wp-json/wc/v3/products/brands?consumer_key=123&consumer_secret=abc

Still getting the same error

@thetahmeed is there any updates about that? facing same issue

is there any solution?

This does not explain how to remove brands from a product.

I tried this and it did not work

curl -X PUT https://example.com/wp-json/wc/v2/products/123 \ -u consumer_key:consumer_secret \ -H 'Content-Type: application/json' \ -d '{"brands": []}'

Also this did not work

curl -X PUT https://example.com/wp-json/wc/v2/products/123 \ -u consumer_key:consumer_secret \ -H 'Content-Type: application/json' \ -d '{"brands": null}'

In both cases a brand that was previously assigned to the product remained so.

UPDATE: This does work
curl -X PUT https://example.com/wp-json/wc/v2/products/123 \ -u consumer_key:consumer_secret \ -H 'Content-Type: application/json' \ -d '{"brands": [0]}'