Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WooCommerce Product Attributes API

Retrieve global product attributes and their terms for filtering

WooCommerce Product Attributes API is one of 21 APIs that WooCommerce publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Product Attributes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and 7 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://example.com/wp-json/wc/v3.

4 operations 4 paths 5 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://example.com/wp-json/wc/v3
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

WooCommerce Product Attributes API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Auth using the WooCommerce Consumer Key as the username and Consumer Secret as the password over HTTPS. Over plain HTTP use OAuth 1.0a one-legged au…

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Product Attributes 4

Retrieve global product attributes and their terms for filtering

GET
/products/attributes
WooCommerce List Product Attributes
listStoreProductAttributes 2 params → 200
GET
/products/attributes/{id}
WooCommerce Retrieve a Product Attribute
getStoreProductAttribute 1 param → 200404
GET
/products/attributes/{id}/terms
WooCommerce List Product Attribute Terms
listStoreProductAttributeTerms 3 params → 200404
GET
/products/brands
WooCommerce List Product Brands
listStoreProductBrands 2 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are StoreProductImage (7 properties), StoreProductAttribute (6 properties), StoreBrand (5 properties), AttributeTerm (5 properties). Each schema is shown below with its type and property counts.

AttributeTerm
object
A term (option value) for a product attribute.
5 properties
StoreBrand
object
A product brand.
5 properties
StoreProductImage
object
Product image with thumbnail variants.
7 properties
StoreProductAttribute
object
A global product attribute for filtering and variation selection.
6 properties
Error
object
Error response returned when a request fails.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

woocommerce-product-attributes-api-openapi.yml Raw ↑

Other APIs WooCommerce publishes across the network.

WooCommerce Webhook Events
WooCommerce GraphQL API
WooCommerce Cart API
WooCommerce Checkout API
WooCommerce Coupons API
WooCommerce Customers API
WooCommerce Order Notes API
WooCommerce Order Refunds API
WooCommerce Orders API
WooCommerce Payment Gateways API
WooCommerce Product Categories API
WooCommerce Product Reviews API