WooCommerce · Example Payload

Woocommerce Rest Api Product Example

A sample description

Example Name

Woocommerce Rest Api Product Example is an example object payload from WooCommerce, with 30 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idnameslugpermalinktypestatusfeatureddescriptionshort_descriptionskupriceregular_pricesale_priceon_salepurchasabletotal_salesvirtualdownloadablemanage_stockstock_quantitystock_statusweightdimensionscategoriestagsimagesattributesdate_createddate_modifiedmeta_data

Example Payload

{
  "id": 1,
  "name": "Example Name",
  "slug": "string-value",
  "permalink": "https://example.com/path",
  "type": "simple",
  "status": "draft",
  "featured": true,
  "description": "A sample description",
  "short_description": "A sample description",
  "sku": "string-value",
  "price": "string-value",
  "regular_price": "string-value",
  "sale_price": "string-value",
  "on_sale": true,
  "purchasable": true,
  "total_sales": 1,
  "virtual": true,
  "downloadable": true,
  "manage_stock": true,
  "stock_quantity": 1,
  "stock_status": "instock",
  "weight": "string-value",
  "dimensions": {
    "length": "string-value",
    "width": "string-value",
    "height": "string-value"
  },
  "categories": [
    {
      "id": 1,
      "name": "Example Name",
      "slug": "string-value"
    }
  ],
  "tags": [
    {
      "id": 1,
      "name": "Example Name",
      "slug": "string-value"
    }
  ],
  "images": [
    "string-value"
  ],
  "attributes": [
    "string-value"
  ],
  "date_created": "2026-05-03T14:30:00Z",
  "date_modified": "2026-05-03T14:30:00Z",
  "meta_data": [
    "string-value"
  ]
}