WooCommerce REST API

https://github.com/woocommerce/woocommerce-rest-api-docs
Admin
The WooCommerce REST API provides programmatic access to manage WooCommerce store data and...
Tokens:426,684
Snippets:1,325
Trust Score:8.9
License:Apache-2.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### JSON response example for listing product reviews

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_product-reviews.md

Example JSON response returned by the GET /wp-json/wc/v3/products/reviews endpoint, showing review objects with fields like id, product_id, status, reviewer, rating, and _links.

```json
[
	{
		"id": 22,
		"date_created": "2018-10-18T17:59:17",
		"date_created_gmt": "2018-10-18T20:59:17",
		"product_id": 22,
		"status": "approved",
		"reviewer": "John Doe",
		"reviewer_email": "john.doe@example.com",
		"review": "<p>Nice album!</p>\n",
		"rating": 5,
		"verified": false,
		"reviewer_avatar_urls": {
			"24": "https://secure.gravatar.com/avatar/8eb1b522f60d11fa897de1dc6351b7e8?s=24&d=mm&r=g",
			"48": "https://secure.gravatar.com/avatar/8eb1b522f60d11fa897de1dc6351b7e8?s=48&d=mm&r=g",
			"96": "https://secure.gravatar.com/avatar/8eb1b522f60d11fa897de1dc6351b7e8?s=96&d=mm&r=g"
		},
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/reviews/22"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/reviews"
				}
			],
			"up": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/22"
				}
			]
		}
	},
	{
		"id": 20,
		"date_created": "2018-09-08T21:47:19",
		"date_created_gmt": "2018-09-09T00:47:19",
		"product_id": 31,
		"status": "approved",
		"reviewer": "Claudio Sanches",
		"reviewer_email": "john.doe@example.com",
		"review": "<p>Now works just fine.</p>\n",
		"rating": 1,
		"verified": true,
		"reviewer_avatar_urls": {
			"24": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=24&d=mm&r=g",
			"48": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=48&d=mm&r=g",
			"96": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=96&d=mm&r=g"
		},
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/reviews/20"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/reviews"
				}
			],
			"up": [
				{
					"href": "https://example.com/wp-json/wc/v3/products/31"
				}
			],
			"reviewer": [
				{
					"embeddable": true,
					"href": "https://example.com/wp-json/wp/v2/users/1"
				}
			]
		}
	}
]
```

--------------------------------

### Build the documentation locally with ./build.sh

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/README.md

Generates the documentation locally. Run this command in the repository root after making changes to the docs. The output is written to the `build` directory, where you can open `index.html` to view the site.

```bash
./build.sh
```

--------------------------------

### GET /wp-json/wc/v3/refunds

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_refunds.md

This code snippet documents the GET /wp-json/wc/v3/refunds endpoint, which retrieves a list of refunds from the store. It includes the HTTP method, endpoint, query parameters, request example, and response example.

```APIDOC
## GET /wp-json/wc/v3/refunds

### Description
Retrieves a list of refunds from the store, regardless of the order they are associated with.

### Method
GET

### Endpoint
/wp-json/wc/v3/refunds

### Parameters
#### Query Parameters
- **context** (string) - Optional - Scope under which the request is made; determines fields present in response. Options: `view` and `edit`. Default is `view`.
- **page** (integer) - Optional - Current page of the collection. Default is `1`.
- **per_page** (integer) - Optional - Maximum number of items to be returned in result set. Default is `10`.
- **search** (string) - Optional - Limit results to those matching a string.
- **after** (string) - Optional - Limit response to resources published after a given ISO8601 compliant date.
- **before** (string) - Optional - Limit response to resources published before a given ISO8601 compliant date.
- **exclude** (array) - Optional - Ensure result set excludes specific IDs.
- **include** (array) - Optional - Limit result set to specific ids.
- **offset** (integer) - Optional - Offset the result set by a specific number of items.
- **order** (string) - Optional - Order sort attribute ascending or descending. Options: `asc` and `desc`. Default is `desc`.
- **orderby** (string) - Optional - Sort collection by object attribute. Options: `date`, `modified`, `id`, `include`, `title` and `slug`. Default is `date`.
- **parent** (array) - Optional - Limit result set to those of particular parent IDs.
- **parent_exclude** (array) - Optional - Limit result set to all items except those of a particular parent ID.
- **dp** (integer) - Optional - Number of decimal points to use in each resource. Default is `2`.

### Request Example
```shell
curl https://example.com/wp-json/wc/v3/refunds \
	-u consumer_key:consumer_secret
```

### Response
#### Success Response (200)
Returns an array of refund objects. Each refund object contains fields such as `id`, `parent_id`, `date_created`, `date_created_gmt`, `amount`, `reason`, `refunded_by`, `refunded_payment`, `meta_data`, `line_items`, and `_links`.

#### Response Example
```json
[
	{
		"id": 726,
        "parent_id": 124,
		"date_created": "2017-03-21T17:07:11",
		"date_created_gmt": "2017-03-21T20:07:11",
		"amount": "10.00",
		"reason": "",
		"refunded_by": 1,
		"refunded_payment": false,
		"meta_data": [],
		"line_items": [],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds/726"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds"
				}
			],
			"up": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723"
				}
			]
		}
	},
	{
		"id": 724,
        "parent_id": 63,
		"date_created": "2017-03-21T16:55:37",
		"date_created_gmt": "2017-03-21T19:55:37",
		"amount": "9.00",
		"reason": "",
		"refunded_by": 1,
		"refunded_payment": false,
		"meta_data": [],
		"line_items": [
			{
				"id": 314,
				"name": "Woo Album #2",
				"product_id": 87,
				"variation_id": 0,
				"quantity": -1,
				"tax_class": "",
				"subtotal": "-9.00",
				"subtotal_tax": "0.00",
				"total": "-9.00",
				"total_tax": "0.00",
				"taxes": [],
				"meta_data": [
					{
						"id": 2076,
						"key": "_refunded_item_id",
						"value": "311"
					}
				],
				"sku": "",
				"price": -9
			}
		],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds/724"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds"
				}
			],
			"up": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723"
				}
			]
		}
	}
]
```
```

--------------------------------

### POST /wc/v3/system_status/tools/install_pages

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_system-status-tools.md

Installs all missing WooCommerce pages. Pages already defined and set up will not be replaced.

```APIDOC
## [POST] /wc/v3/system_status/tools/install_pages

### Description
Installs all missing WooCommerce pages. Pages already defined and set up will not be replaced.

### Method
POST

### Endpoint
https://example.com/wp-json/wc/v3/system_status/tools/install_pages

### Parameters
None documented.

### Request Example
None documented.

### Response
#### Success Response (200)
No response schema documented.

#### Response Example
None documented.
```

--------------------------------

### JSON response example for listing webhooks

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_webhooks.md

Example JSON response returned by the GET /wp-json/wc/v3/webhooks endpoint, showing two webhook objects with their properties and links.

```json
[
  {
    "id": 143,
    "name": "Customer created",
    "status": "active",
    "topic": "customer.created",
    "resource": "customer",
    "event": "created",
    "hooks": [
      "user_register",
      "woocommerce_created_customer",
      "woocommerce_api_create_customer"
    ],
    "delivery_url": "http://requestb.in/1g0sxmo1",
    "date_created": "2016-05-15T23:17:52",
    "date_created_gmt": "2016-05-15T20:17:52",
    "date_modified": "2016-05-15T23:17:52",
    "date_modified_gmt": "2016-05-15T20:17:52",
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v3/webhooks/143"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v3/webhooks"
        }
      ]
    }
  },
  {
    "id": 142,
    "name": "Order updated",
    "status": "active",
    "topic": "order.updated",
    "resource": "order",
    "event": "updated",
    "hooks": [
      "woocommerce_process_shop_order_meta",
      "woocommerce_api_edit_order",
      "woocommerce_order_edit_status",
      "woocommerce_order_status_changed"
    ],
    "delivery_url": "http://requestb.in/1g0sxmo1",
    "date_created": "2016-05-15T23:17:52",
    "date_created_gmt": "2016-05-15T20:17:52",
    "date_modified": "2016-05-15T23:17:52",
    "date_modified_gmt": "2016-05-15T20:17:52",
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v3/webhooks/142"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v3/webhooks"
        }
      ]
    }
  }
]
```

--------------------------------

### Customer downloads JSON response example

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_customers.md

Example JSON response for the customer downloads endpoint, showing download details and links.

```json
[
  {
    "download_id": "91447fd1849316bbc89dfb7e986a6006",
    "download_url": "https://example.com/?download_file=87&order=wc_order_58d17c18352&email=joao.silva%40example.com&key=91447fd1849316bbc89dfb7e986a6006",
    "product_id": 87,
    "product_name": "Woo Album #2",
    "download_name": "Woo Album #2 &ndash; Song 2",
    "order_id": 723,
    "order_key": "wc_order_58d17c18352",
    "downloads_remaining": "3",
    "access_expires": "never",
    "access_expires_gmt": "never",
    "file": {
      "name": "Song 2",
      "file": "http://example.com/wp-content/uploads/woocommerce_uploads/2013/06/Song.mp3"
    },
    "_links": {
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v3/customers/26/downloads"
        }
      ],
      "product": [
        {
          "href": "https://example.com/wp-json/wc/v3/products/87"
        }
      ],
      "order": [
        {
          "href": "https://example.com/wp-json/wc/v3/orders/723"
        }
      ]
    }
  }
]
```

--------------------------------

### JSON response example for product custom field names

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_product-custom-fields.md

Example JSON response returned by the GET /wp-json/wc/v3/products/custom-fields/names endpoint. It contains an array of custom field names.

```json
{
	[
		"Custom field 1",
		"Custom field 2",
		"Custom field 3",
		"Custom field 4"
	]
}
```

--------------------------------

### GET /wp-json/wc/v3/refunds - JSON response example

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_refunds.md

Example JSON response for a list of refunds, showing two refund objects with fields like id, parent_id, amount, and _links.

```json
[
	{
		"id": 726,
        "parent_id": 124,
		"date_created": "2017-03-21T17:07:11",
		"date_created_gmt": "2017-03-21T20:07:11",
		"amount": "10.00",
		"reason": "",
		"refunded_by": 1,
		"refunded_payment": false,
		"meta_data": [],
		"line_items": [],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds/726"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds"
				}
			],
			"up": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723"
				}
			]
		}
	},
	{
		"id": 724,
        "parent_id": 63,
		"date_created": "2017-03-21T16:55:37",
		"date_created_gmt": "2017-03-21T19:55:37",
		"amount": "9.00",
		"reason": "",
		"refunded_by": 1,
		"refunded_payment": false,
		"meta_data": [],
		"line_items": [
			{
				"id": 314,
				"name": "Woo Album #2",
				"product_id": 87,
				"variation_id": 0,
				"quantity": -1,
				"tax_class": "",
				"subtotal": "-9.00",
				"subtotal_tax": "0.00",
				"total": "-9.00",
				"total_tax": "0.00",
				"taxes": [],
				"meta_data": [
					{
						"id": 2076,
						"key": "_refunded_item_id",
						"value": "311"
					}
				],
				"sku": "",
				"price": -9
			}
		],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds/724"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723/refunds"
				}
			],
			"up": [
				{
					"href": "https://example.com/wp-json/wc/v3/orders/723"
				}
			]
		}
	}
]
```

--------------------------------

### Create order note JSON response example

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_order-notes.md

Example response from creating an order note, showing the note object with links.

```json
{
  "id": 281,
  "author": "system",
  "date_created": "2017-03-21T16:46:41",
  "date_created_gmt": "2017-03-21T19:46:41",
  "note": "Order ok!!!",
  "customer_note": false,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v3/orders/723/notes/281"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v3/orders/723/notes"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v3/orders/723"
      }
    ]
  }
}
```

--------------------------------

### POST /wc/v3/products

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_index.md

Creates a new product. Accepts name, slug, and description in the request body.

```APIDOC
## POST /wc/v3/products

### Description
Creates a new product.

### Method
POST

### Endpoint
/wc/v3/products

### Parameters
#### Request Body
- **name** (string) - Optional - Product name.
- **slug** (string) - Optional - An alphanumeric identifier for the resource unique to its type.
- **description** (string) - Optional - HTML description of the resource.

### Request Example
```json
{
  "name": "Product Name",
  "slug": "product-name",
  "description": "<p>Product description</p>"
}
```

### Response
#### Success Response (201)
- **id** (integer) - Unique identifier for the resource.
- **name** (string) - Product name.
- **slug** (string) - An alphanumeric identifier for the resource unique to its type.
- **description** (string) - HTML description of the resource.

#### Response Example
```json
{
  "id": 1,
  "name": "Product Name",
  "slug": "product-name",
  "description": "<p>Product description</p>"
}
```
```

--------------------------------

### JSON response example for list all countries

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_data.md

Example JSON response from the GET /wp-json/wc/v3/data/countries endpoint. Shows the structure with country code, name, states array, and _links for self and collection. The example includes the United States with all its states and armed forces codes.

```json
[
	{
		"code": "US",
		"name": "United States (US)",
		"states": [
			{
				"code": "AL",
				"name": "Alabama"
			},
			{
				"code": "AK",
				"name": "Alaska"
			},
			{
				"code": "AZ",
				"name": "Arizona"
			},
			{
				"code": "AR",
				"name": "Arkansas"
			},
			{
				"code": "CA",
				"name": "California"
			},
			{
				"code": "CO",
				"name": "Colorado"
			},
			{
				"code": "CT",
				"name": "Connecticut"
			},
			{
				"code": "DE",
				"name": "Delaware"
			},
			{
				"code": "DC",
				"name": "District Of Columbia"
			},
			{
				"code": "FL",
				"name": "Florida"
			},
			{
				"code": "GA",
				"name": "Georgia"
			},
			{
				"code": "HI",
				"name": "Hawaii"
			},
			{
				"code": "ID",
				"name": "Idaho"
			},
			{
				"code": "IL",
				"name": "Illinois"
			},
			{
				"code": "IN",
				"name": "Indiana"
			},
			{
				"code": "IA",
				"name": "Iowa"
			},
			{
				"code": "KS",
				"name": "Kansas"
			},
			{
				"code": "KY",
				"name": "Kentucky"
			},
			{
				"code": "LA",
				"name": "Louisiana"
			},
			{
				"code": "ME",
				"name": "Maine"
			},
			{
				"code": "MD",
				"name": "Maryland"
			},
			{
				"code": "MA",
				"name": "Massachusetts"
			},
			{
				"code": "MI",
				"name": "Michigan"
			},
			{
				"code": "MN",
				"name": "Minnesota"
			},
			{
				"code": "MS",
				"name": "Mississippi"
			},
			{
				"code": "MO",
				"name": "Missouri"
			},
			{
				"code": "MT",
				"name": "Montana"
			},
			{
				"code": "NE",
				"name": "Nebraska"
			},
			{
				"code": "NV",
				"name": "Nevada"
			},
			{
				"code": "NH",
				"name": "New Hampshire"
			},
			{
				"code": "NJ",
				"name": "New Jersey"
			},
			{
				"code": "NM",
				"name": "New Mexico"
			},
			{
				"code": "NY",
				"name": "New York"
			},
			{
				"code": "NC",
				"name": "North Carolina"
			},
			{
				"code": "ND",
				"name": "North Dakota"
			},
			{
				"code": "OH",
				"name": "Ohio"
			},
			{
				"code": "OK",
				"name": "Oklahoma"
			},
			{
				"code": "OR",
				"name": "Oregon"
			},
			{
				"code": "PA",
				"name": "Pennsylvania"
			},
			{
				"code": "RI",
				"name": "Rhode Island"
			},
			{
				"code": "SC",
				"name": "South Carolina"
			},
			{
				"code": "SD",
				"name": "South Dakota"
			},
			{
				"code": "TN",
				"name": "Tennessee"
			},
			{
				"code": "TX",
				"name": "Texas"
			},
			{
				"code": "UT",
				"name": "Utah"
			},
			{
				"code": "VT",
				"name": "Vermont"
			},
			{
				"code": "VA",
				"name": "Virginia"
			},
			{
				"code": "WA",
				"name": "Washington"
			},
			{
				"code": "WV",
				"name": "West Virginia"
			},
			{
				"code": "WI",
				"name": "Wisconsin"
			},
			{
				"code": "WY",
				"name": "Wyoming"
			},
			{
				"code": "AA",
				"name": "Armed Forces (AA)"
			},
			{
				"code": "AE",
				"name": "Armed Forces (AE)"
			},
			{
				"code": "AP",
				"name": "Armed Forces (AP)"
			}
		],
		"_links": {
			"self": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/countries/us"
				}
			],
			"collection": [
				{
					"href": "https://example.com/wp-json/wc/v3/data/countries"
				}
			]
		}
	}
]
```

--------------------------------

### JSON response for running a system status tool

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_system-status-tools.md

Example JSON response from running the clear_transients tool. Shows the tool ID, name, action, description, success flag, message, and hypermedia links.

```json
{
  "id": "clear_transients",
  "name": "WC transients",
  "action": "Clear transients",
  "description": "This tool will clear the product/shop transients cache.",
  "success": true,
  "message": "Product transients cleared",
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v3/system_status/tools/clear_transients"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v3/system_status/tools"
      }
    ]
  }
}
```

--------------------------------

### GET /wp-json/wc/v3 API Index

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_index.md

Retrieve the API index listing all available endpoints. Authentication is not required. The response is a JSON object with a namespace and routes. The JavaScript example uses the WooCommerce promise-based client; the PHP example uses the $woocommerce object; the Python example uses wcapi; the Ruby example uses the woocommerce_api gem.

```shell
curl https://example.com/wp-json/wc/v3
```

```javascript
WooCommerce.get("")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });
```

```php
<?php print_r($woocommerce->get('')); ?>
```

```python
print(wcapi.get("").json())
```

```ruby
woocommerce.get("").parsed_response
```

--------------------------------

### Get available email templates for an order

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_order-actions.md

Retrieve the list of email templates available for a specific order using the WooCommerce REST API endpoint /wp-json/wc/v3/orders/<id>/actions/email_templates. The examples show how to call the endpoint with cURL, JavaScript (WooCommerce JS library), PHP, Python, and Ruby. Note that the Ruby example uses the post method instead of get.

```shell
curl -X GET https://example.com/wp-json/wc/v3/orders/723/actions/email_templates \
	-u consumer_key:consumer_secret
```

```javascript
WooCommerce.get("orders/723/actions/email_templates")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });
```

```php
<?php
print_r($woocommerce->get('orders/723/actions/email_templates'));
?>
```

```python
print(wcapi.get("orders/723/actions/email_templates").json())
```

```ruby
woocommerce.post("orders/723/actions/email_templates").parsed_response
```

--------------------------------

### Create a simple product with Ruby

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_products.md

Use this Ruby example to create a simple product using the WooCommerce REST API Ruby library. It defines the product data hash and calls woocommerce.post("products", data).parsed_response to get the parsed response.

```ruby
data = {
  name: "Premium Quality",
  type: "simple",
  regular_price: "21.99",
  description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
  short_description: "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
  categories: [
    {
      id: 9
    },
    {
      id: 14
    }
  ],
  images: [
    {
      id: 42
    },
    {
      src: "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg",
    }
  ]
}

woocommerce.post("products", data).parsed_response
```

--------------------------------

### Retrieve a webhook by ID (GET /wp-json/wc/v3/webhooks/<id>)

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_webhooks.md

Retrieve a specific webhook by ID using the WooCommerce REST API. The endpoint is GET /wp-json/wc/v3/webhooks/<id>. Each example shows the same request in a different client language.

```shell
curl https://example.com/wp-json/wc/v3/webhooks/142 \
	-u consumer_key:consumer_secret
```

```javascript
WooCommerce.get("webhooks/142")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });
```

```php
<?php print_r($woocommerce->get('webhooks/142')); ?>
```

```python
print(wcapi.get("webhooks/142").json())
```

```ruby
woocommerce.get("webhooks/142").parsed_response
```

--------------------------------

### JSON response example for list product attributes

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_product-attributes.md

JSON response example for listing all product attributes. Shows an array of attribute objects, each with id, name, slug, type, order_by, has_archives, and _links.

```json
[
  {
    "id": 1,
    "name": "Color",
    "slug": "pa_color",
    "type": "select",
    "order_by": "menu_order",
    "has_archives": true,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v3/products/attributes/6"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v3/products/attributes"
        }
      ]
    }
  },
  {
    "id": 2,
    "name": "Size",
    "slug": "pa_size",
    "type": "select",
    "order_by": "menu_order",
    "has_archives": false,
    "_links": {
      "self": [
        {
          "href": "https://example.com/wp-json/wc/v3/products/attributes/2"
        }
      ],
      "collection": [
        {
          "href": "https://example.com/wp-json/wc/v3/products/attributes"
        }
      ]
    }
  }
]
```

--------------------------------

### Create product variation - JSON response example

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_product-variations.md

Example response from the create variation endpoint. Shows the created variation object with id, dates, prices, image, attributes, and _links.

```json
{
  "id": 732,
  "date_created": "2017-03-23T00:36:38",
  "date_created_gmt": "2017-03-23T03:36:38",
  "date_modified": "2017-03-23T00:36:38",
  "date_modified_gmt": "2017-03-23T03:36:38",
  "description": "",
  "permalink": "https://example.com/product/ship-your-idea/?attribute_pa_color=black",
  "sku": "",
  "price": "9.00",
  "regular_price": "9.00",
  "sale_price": "",
  "date_on_sale_from": null,
  "date_on_sale_from_gmt": null,
  "date_on_sale_to": null,
  "date_on_sale_to_gmt": null,
  "on_sale": false,
  "status": true,
  "purchasable": true,
  "virtual": false,
  "downloadable": false,
  "downloads": [],
  "download_limit": -1,
  "download_expiry": -1,
  "tax_status": "taxable",
  "tax_class": "",
  "manage_stock": false,
  "stock_quantity": null,
  "stock_status": "instock",
  "backorders": "no",
  "backorders_allowed": false,
  "backordered": false,
  "weight": "",
  "dimensions": {
    "length": "",
    "width": "",
    "height": ""
  },
  "shipping_class": "",
  "shipping_class_id": 0,
  "image": {
    "id": 423,
    "date_created": "2016-10-19T12:21:14",
    "date_created_gmt": "2016-10-19T16:21:14",
    "date_modified": "2016-10-19T12:21:14",
    "date_modified_gmt": "2016-10-19T16:21:14",
    "src": "https://example.com/wp-content/uploads/2016/10/T_4_front-12.jpg",
    "name": "",
    "alt": ""
  },
  "attributes": [
    {
      "id": 6,
      "name": "Color",
      "option": "Black"
    }
  ],
  "menu_order": 0,
  "meta_data": [],
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v3/products/22/variations/732"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v3/products/22/variations"
      }
    ],
    "up": [
      {
        "href": "https://example.com/wp-json/wc/v3/products/22"
      }
    ]
  }
}
```

--------------------------------

### Create a simple product with Python

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_products.md

Use this Python example to create a simple product using the WooCommerce REST API Python library. It defines the product data dictionary and calls wcapi.post("products", data), printing the JSON response.

```python
data = {
    "name": "Premium Quality",
    "type": "simple",
    "regular_price": "21.99",
    "description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.",
    "short_description": "Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.",
    "categories": [
        {
            "id": 9
        },
        {
            "id": 14
        }
    ],
    "images": [
        {
            "id": 42
        },
        {
            "src": "http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg"
        }
    ]
}

print(wcapi.post("products", data).json())
```

--------------------------------

### Retrieve a coupon by ID (GET /wp-json/wc/v3/coupons/<id>)

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_coupons.md

Retrieve a specific coupon by ID using the WooCommerce REST API. The endpoint is GET /wp-json/wc/v3/coupons/<id>. Each example uses the same ID (719) and the appropriate client library for the language.

```shell
curl https://example.com/wp-json/wc/v3/coupons/719 \
	-u consumer_key:consumer_secret
```

```javascript
WooCommerce.get("coupons/719")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });
```

```php
<?php print_r($woocommerce->get('coupons/719')); ?>
```

```python
print(wcapi.get("coupons/719").json())
```

```ruby
woocommerce.get("coupons/719").parsed_response
```

--------------------------------

### JSON response for creating a product tag

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_product-tags.md

JSON response example for creating a product tag. Shows the created tag with its id, name, slug, description, count, and links.

```json
{
  "id": 34,
  "name": "Leather Shoes",
  "slug": "leather-shoes",
  "description": "",
  "count": 0,
  "_links": {
    "self": [
      {
        "href": "https://example.com/wp-json/wc/v3/products/tags/34"
      }
    ],
    "collection": [
      {
        "href": "https://example.com/wp-json/wc/v3/products/tags"
      }
    ]
  }
}
```

--------------------------------

### GET /wp-json/wc/v3/system_status

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_system-status.md

This endpoint retrieves the system status of the WooCommerce installation, including environment and database properties. All properties are read-only.

```APIDOC
## GET /wp-json/wc/v3/system_status

### Description
Retrieves the system status of the WooCommerce installation, including environment and database properties.

### Method
GET

### Endpoint
`/wp-json/wc/v3/system_status`

### Parameters
None

### Response
#### Success Response (200)
- **environment** (object) - Environment properties.
- **database** (object) - Database properties.

#### Response Example
```json
{
  "environment": {
    "home_url": "https://example.com",
    "site_url": "https://example.com",
    "version": "6.0.0",
    "log_directory": "/path/to/logs",
    "log_directory_writable": true,
    "wp_version": "6.0",
    "wp_multisite": false,
    "wp_memory_limit": 256,
    "wp_debug_mode": false,
    "wp_cron": true,
    "wp_environment_type": "production",
    "language": "en_US",
    "server_info": "Apache/2.4.41 (Ubuntu)",
    "php_version": "7.4.3",
    "php_post_max_size": 8388608,
    "php_max_execution_time": 30,
    "php_max_input_vars": 1000,
    "curl_version": "7.68.0",
    "suhosin_installed": false,
    "max_upload_size": 2097152,
    "mysql_version": "8.0.25",
    "default_timezone": "UTC",
    "fsockopen_or_curl_enabled": true,
    "soapclient_enabled": true,
    "domdocument_enabled": true,
    "gzip_enabled": true,
    "mbstring_enabled": true,
    "remote_post_successful": true,
    "remote_post_response": "OK",
    "remote_get_successful": true,
    "remote_get_response": "OK"
  },
  "database": {
    "wc_database_version": "6.0.0",
    "database_prefix": "wp_",
    "maxmind_geoip_database": "/path/to/geoip",
    "database_tables": []
  }
}
```
```

--------------------------------

### Example OAuth parameters string

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_authentication.md

Example of normalized and percent-encoded OAuth parameters used to build the signature base string. The parameters are sorted alphabetically by encoded key and joined with '&'.

```text
oauth_consumer_key=abc123&oauth_signature_method=HMAC-SHA1
```

--------------------------------

### List all order notes (GET /wp-json/wc/v3/orders/723/notes)

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_order-notes.md

List all notes for a specific order using the WooCommerce REST API. The endpoint is GET /wp-json/wc/v3/orders/<id>/notes. The example uses order ID 723. The response is an array of note objects.

```shell
curl https://example.com/wp-json/wc/v3/orders/723/notes \
	-u consumer_key:consumer_secret
```

```javascript
WooCommerce.get("orders/723/notes")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.log(error.response.data);
  });
```

```php
<?php print_r($woocommerce->get('orders/723/notes')); ?>
```

```python
print(wcapi.get("orders/723/notes").json())
```

```ruby
woocommerce.get("orders/723/notes").parsed_response
```

--------------------------------

### JSON response example for updating a product review

Source: https://github.com/woocommerce/woocommerce-rest-api-docs/blob/trunk/source/includes/wp-api-v3/_product-reviews.md

Shows the full JSON response returned after a successful update, including review details, avatar URLs, and _links.

```json
{
	"id": 20,
	"date_created": "2018-09-08T21:47:19",
	"date_created_gmt": "2018-09-09T00:47:19",
	"product_id": 31,
	"status": "approved",
	"reviewer": "Claudio Sanches",
	"reviewer_email": "john.doe@example.com",
	"review": "Now works just fine.",
	"rating": 5,
	"verified": true,
	"reviewer_avatar_urls": {
		"24": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=24&d=mm&r=g",
		"48": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=48&d=mm&r=g",
		"96": "https://secure.gravatar.com/avatar/908480753c07509e76322dc17d305c8b?s=96&d=mm&r=g"
	},
	"_links": {
		"self": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/reviews/20"
			}
		],
		"collection": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/reviews"
			}
		],
		"up": [
			{
				"href": "https://example.com/wp-json/wc/v3/products/31"
			}
		],
		"reviewer": [
			{
				"embeddable": true,
				"href": "https://example.com/wp-json/wp/v2/users/1"
			}
		]
	}
}
```
Tokens:
Raw