Products API

The Products endpoint allows you to create, read, update, and delete products in your WooCommerce store.

The Product Object

Product Properties

integer

required

Unique identifier for the product. Read-only.

string

required

Product name.

string

Product slug. Auto-generated from name if not provided.

string

Product URL. Read-only.

string

The date the product was created, in ISO8601 format. Read-only.

string

The date the product was last modified, in ISO8601 format. Read-only.

string

default:"simple"

Product type. Options: simple, grouped, external, variable

string

default:"publish"

Product status. Options: draft, pending, private, publish

boolean

default:"false"

List All Products

Retrieve a list of all products in your store.

curl https://example.com/wp-json/wc/v3/products \
  -u ck_1234567890abcdef:cs_1234567890abcdef

const response = await api.get('/products');
console.log(response.data);

response = requests.get(
    'https://example.com/wp-json/wc/v3/products',
    auth=HTTPBasicAuth(consumer_key, consumer_secret)
)
products = response.json()

$products = $woocommerce->get('products');

Query Parameters

integer

default:"1"

Current page of the collection.

integer

default:"10"

Maximum number of items to return (max 100).

string

Limit results to those matching a string.

string

Limit response to products published after a given ISO8601 date.

string

Limit response to products published before a given ISO8601 date.

string

default:"any"

Limit result set to products with specific status. Options: any, draft, pending, private, publish

string

Limit result set to products with specific type. Options: simple, grouped, external, variable

string

Limit result set to products with a specific SKU.

boolean

Limit result set to featured products.

string

Limit result set to products in specific category ID(s). Comma-separated list.

string

Limit result set to products with specific tag ID(s). Comma-separated list.

boolean

Limit result set to products on sale.

string

Limit result set to products based on minimum price.

string

Limit result set to products based on maximum price.

string

Limit result set to products with specified stock status. Options: instock, outofstock, onbackorder

string

default:"date"

Sort collection by attribute. Options: date, id, title, slug, price, popularity, rating

string

default:"desc"

Order sort direction. Options: asc, desc

Example Response

[
  {
    "id": 123,
    "name": "Premium T-Shirt",
    "slug": "premium-t-shirt",
    "permalink": "https://example.com/product/premium-t-shirt/",
    "date_created": "2024-01-15T10:30:00",
    "date_modified": "2024-01-20T14:45:00",
    "type": "simple",
    "status": "publish",
    "featured": false,
    "catalog_visibility": "visible",
    "description": "<p>High-quality cotton t-shirt</p>",
    "short_description": "<p>Comfortable premium t-shirt</p>",
    "sku": "TSHIRT-001",
    "price": "24.99",
    "regular_price": "29.99",
    "sale_price": "24.99",
    "on_sale": true,
    "purchasable": true,
    "total_sales": 45,
    "virtual": false,
    "downloadable": false,
    "downloads": [],
    "download_limit": -1,
    "download_expiry": -1,
    "tax_status": "taxable",
    "tax_class": "",
    "manage_stock": true,
    "stock_quantity": 50,
    "stock_status": "instock",
    "backorders": "no",
    "backorders_allowed": false,
    "backordered": false,
    "sold_individually": false,
    "weight": "0.5",
    "dimensions": {
      "length": "20",
      "width": "15",
      "height": "2"
    },
    "shipping_required": true,
    "shipping_taxable": true,
    "shipping_class": "",
    "shipping_class_id": 0,
    "reviews_allowed": true,
    "average_rating": "4.5",
    "rating_count": 12,
    "categories": [
      {
        "id": 15,
        "name": "Clothing",
        "slug": "clothing"
      }
    ],
    "tags": [
      {
        "id": 23,
        "name": "Summer",
        "slug": "summer"
      }
    ],
    "images": [
      {
        "id": 456,
        "date_created": "2024-01-15T10:30:00",
        "date_modified": "2024-01-15T10:30:00",
        "src": "https://example.com/wp-content/uploads/2024/01/tshirt.jpg",
        "name": "tshirt.jpg",
        "alt": "Premium T-Shirt"
      }
    ],
    "attributes": [],
    "default_attributes": [],
    "variations": [],
    "grouped_products": [],
    "menu_order": 0,
    "meta_data": []
  }
]

Retrieve a Product

Get details of a single product by ID.

curl https://example.com/wp-json/wc/v3/products/123 \
  -u ck_1234567890abcdef:cs_1234567890abcdef

const response = await api.get('/products/123');
console.log(response.data);

response = requests.get(
    'https://example.com/wp-json/wc/v3/products/123',
    auth=HTTPBasicAuth(consumer_key, consumer_secret)
)
product = response.json()

$product = $woocommerce->get('products/123');

Create a Product

Create a new product in your store.

curl -X POST https://example.com/wp-json/wc/v3/products \
  -u ck_1234567890abcdef:cs_1234567890abcdef \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Hoodie",
    "type": "simple",
    "regular_price": "49.99",
    "description": "Comfortable premium hoodie made from organic cotton.",
    "short_description": "Premium organic cotton hoodie",
    "categories": [
      {
        "id": 15
      }
    ],
    "images": [
      {
        "src": "https://example.com/images/hoodie.jpg"
      }
    ]
  }'

const newProduct = {
  name: 'Premium Hoodie',
  type: 'simple',
  regular_price: '49.99',
  description: 'Comfortable premium hoodie made from organic cotton.',
  short_description: 'Premium organic cotton hoodie',
  categories: [
    { id: 15 }
  ],
  images: [
    { src: 'https://example.com/images/hoodie.jpg' }
  ]
};

const response = await api.post('/products', newProduct);
console.log(response.data);

data = {
    'name': 'Premium Hoodie',
    'type': 'simple',
    'regular_price': '49.99',
    'description': 'Comfortable premium hoodie made from organic cotton.',
    'short_description': 'Premium organic cotton hoodie',
    'categories': [{'id': 15}],
    'images': [{'src': 'https://example.com/images/hoodie.jpg'}]
}

response = requests.post(
    'https://example.com/wp-json/wc/v3/products',
    json=data,
    auth=HTTPBasicAuth(consumer_key, consumer_secret)
)
product = response.json()

$data = [
    'name' => 'Premium Hoodie',
    'type' => 'simple',
    'regular_price' => '49.99',
    'description' => 'Comfortable premium hoodie made from organic cotton.',
    'short_description' => 'Premium organic cotton hoodie',
    'categories' => [
        ['id' => 15]
    ],
    'images' => [
        ['src' => 'https://example.com/images/hoodie.jpg']
    ]
];

$product = $woocommerce->post('products', $data);

Required Fields

string

required

Product name

Optional Fields

string

default:"simple"

Product type: simple, grouped, external, variable

string

Product regular price

string

Product sale price

string

Product description (supports HTML)

string

Product short description (supports HTML)

string

Unique SKU (Stock Keeping Unit)

boolean

default:"false"

Enable stock management

integer

Stock quantity (requires manage_stock to be true)

string

default:"instock"

Stock status: instock, outofstock, onbackorder

array

List of category IDs

[{"id": 15}, {"id": 23}]

array

List of product images

[{"src": "https://example.com/image.jpg"}]

Update a Product

Update an existing product.

curl -X PUT https://example.com/wp-json/wc/v3/products/123 \
  -u ck_1234567890abcdef:cs_1234567890abcdef \
  -H "Content-Type: application/json" \
  -d '{
    "regular_price": "54.99",
    "sale_price": "44.99"
  }'

const updates = {
  regular_price: '54.99',
  sale_price: '44.99'
};

const response = await api.put('/products/123', updates);
console.log(response.data);

data = {
    'regular_price': '54.99',
    'sale_price': '44.99'
}

response = requests.put(
    'https://example.com/wp-json/wc/v3/products/123',
    json=data,
    auth=HTTPBasicAuth(consumer_key, consumer_secret)
)
product = response.json()

$data = [
    'regular_price' => '54.99',
    'sale_price' => '44.99'
];

$product = $woocommerce->put('products/123', $data);

Delete a Product

Delete a product permanently or move it to trash.

curl -X DELETE https://example.com/wp-json/wc/v3/products/123 \
  -u ck_1234567890abcdef:cs_1234567890abcdef

curl -X DELETE https://example.com/wp-json/wc/v3/products/123?force=true \
  -u ck_1234567890abcdef:cs_1234567890abcdef

// Move to trash
await api.delete('/products/123');

// Permanent delete
await api.delete('/products/123', { params: { force: true } });

# Move to trash
requests.delete(
    'https://example.com/wp-json/wc/v3/products/123',
    auth=HTTPBasicAuth(consumer_key, consumer_secret)
)

# Permanent delete
requests.delete(
    'https://example.com/wp-json/wc/v3/products/123',
    params={'force': True},
    auth=HTTPBasicAuth(consumer_key, consumer_secret)
)

// Move to trash
$woocommerce->delete('products/123');

// Permanent delete
$woocommerce->delete('products/123', ['force' => true]);

Parameters

boolean

default:"false"

Set to true to permanently delete the product. Otherwise, it will be moved to trash.

Batch Update Products

Create, update, and delete multiple products in a single request.

curl -X POST https://example.com/wp-json/wc/v3/products/batch \
  -u ck_1234567890abcdef:cs_1234567890abcdef \
  -H "Content-Type: application/json" \
  -d '{
    "create": [
      {
        "name": "Product 1",
        "type": "simple",
        "regular_price": "10.00"
      },
      {
        "name": "Product 2",
        "type": "simple",
        "regular_price": "20.00"
      }
    ],
    "update": [
      {
        "id": 123,
        "regular_price": "15.00"
      }
    ],
    "delete": [
      456
    ]
  }'

Product Variations

For variable products, you can manage variations through a sub-endpoint.

List Product Variations

curl https://example.com/wp-json/wc/v3/products/123/variations \
  -u ck_1234567890abcdef:cs_1234567890abcdef

Create a Variation

curl -X POST https://example.com/wp-json/wc/v3/products/123/variations \
  -u ck_1234567890abcdef:cs_1234567890abcdef \
  -H "Content-Type: application/json" \
  -d '{
    "regular_price": "19.99",
    "attributes": [
      {
        "id": 1,
        "option": "Large"
      }
    ]
  }'

Common Use Cases

Update Stock Quantity

await api.put('/products/123', {
  manage_stock: true,
  stock_quantity: 100,
  stock_status: 'instock'
});

Set Product on Sale

await api.put('/products/123', {
  regular_price: '99.99',
  sale_price: '79.99'
});

Add Product to Category

await api.put('/products/123', {
  categories: [
    { id: 15 },
    { id: 23 }
  ]
});

Search Products by SKU

curl "https://example.com/wp-json/wc/v3/products?sku=TSHIRT-001" \
  -u ck_1234567890abcdef:cs_1234567890abcdef

Get Featured Products

curl "https://example.com/wp-json/wc/v3/products?featured=true" \
  -u ck_1234567890abcdef:cs_1234567890abcdef

Filter by Price Range

curl "https://example.com/wp-json/wc/v3/products?min_price=10&max_price=50" \
  -u ck_1234567890abcdef:cs_1234567890abcdef

Error Handling

Invalid Product ID

{
  "code": "woocommerce_rest_product_invalid_id",
  "message": "Invalid product ID.",
  "data": {
    "status": 404
  }
}

Missing Required Field

{
  "code": "woocommerce_rest_product_name_required",
  "message": "The product name is required.",
  "data": {
    "status": 400
  }
}

Duplicate SKU

{
  "code": "woocommerce_rest_product_sku_already_exists",
  "message": "The SKU already exists on another product.",
  "data": {
    "status": 400,
    "resource_id": 456
  }
}

REST API

Store API

PHP APIs

Core Classes

Products REST API

Products API

The Product Object

Product Properties

List All Products

Query Parameters

Example Response

Retrieve a Product

Create a Product

Required Fields

Optional Fields

Update a Product

Delete a Product

Parameters

Batch Update Products

Product Variations

List Product Variations

Create a Variation

Common Use Cases

Update Stock Quantity

Set Product on Sale

Add Product to Category

Search Products by SKU

Get Featured Products

Filter by Price Range

Error Handling

Invalid Product ID

Missing Required Field

Duplicate SKU

Next Steps

Orders API

Customers API

​Products API

​The Product Object

​Product Properties

​List All Products

​Query Parameters

​Example Response

​Retrieve a Product

​Create a Product

​Required Fields

​Optional Fields

​Update a Product

​Delete a Product

​Parameters

​Batch Update Products

​Product Variations

​List Product Variations

​Create a Variation

​Common Use Cases

​Update Stock Quantity

​Set Product on Sale

​Add Product to Category

​Search Products by SKU

​Get Featured Products

​Filter by Price Range

​Error Handling

​Invalid Product ID

​Missing Required Field

​Duplicate SKU

​Next Steps

Orders API

Customers API

Products API

The Product Object

Product Properties

List All Products

Query Parameters

Example Response

Retrieve a Product

Create a Product

Required Fields

Optional Fields

Update a Product

Delete a Product

Parameters

Batch Update Products

Product Variations

List Product Variations

Create a Variation

Common Use Cases

Update Stock Quantity

Set Product on Sale

Add Product to Category

Search Products by SKU

Get Featured Products

Filter by Price Range

Error Handling

Invalid Product ID

Missing Required Field

Duplicate SKU

Next Steps