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 Variations API

Manage variations of variable products including price, stock, and attributes

WooCommerce Product Variations 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 Variations. 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 5 operations across 2 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.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

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 Variations 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 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Product Variations 5

Manage variations of variable products including price, stock, and attributes

GET
/products/{product_id}/variations
WooCommerce List All Product Variations
listProductVariations 3 params → 200401404
POST
/products/{product_id}/variations
WooCommerce Create a Product Variation
createProductVariation 1 param body → 201400401
GET
/products/{product_id}/variations/{id}
WooCommerce Retrieve a Product Variation
getProductVariation 2 params → 200401404
PUT
/products/{product_id}/variations/{id}
WooCommerce Update a Product Variation
updateProductVariation 2 params body → 200400401404
DELETE
/products/{product_id}/variations/{id}
WooCommerce Delete a Product Variation
deleteProductVariation 3 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ProductVariation (13 properties), ProductVariationInput (9 properties), ProductImage (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ProductVariationInput
object
Input for creating or updating a product variation.
9 properties
MetaData
object
Custom metadata key-value entry.
3 properties
ProductImage
object
An image associated with a product.
4 properties
ProductVariation
object
A variation of a variable product with its own pricing and stock.
13 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

woocommerce-product-variations-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 Attributes API
WooCommerce Product Categories API