gedex/woocommerce-brands-rest-api-doc.md

## woocommerce-brands-rest-api-doc.md

      
    Raw
  

              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/v1/products/brands -u consumer_key:consumer_secret


Create a product brand:
curl -X POST https://example.com/wp-json/wc/v1/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/v1/products/brands/9?force=true -u consumer_key:consumer_secret


Set brands to a product:
 -u consumer_key:consumer_secret \
 -H 'Content-Type: application/json' \
 -d '{"id": "4304", "brands": [48, 49]}'