Skip to main content

WooCommerce

Use WooCommerce to manage products, orders, customers, and coupons. With these operations, you can list, create, update, and delete entities in your WooCommerce store.

Prerequisites​

To use WooCommerce, you need:

  • A WooCommerce store (self-hosted WordPress with WooCommerce installed).
  • REST API credentials (Consumer Key & Consumer Secret). You can generate these credentials from:
    • WooCommerce Admin → Settings → Advanced → REST API
    • Follow this guide for setup instructions.

For detailed API reference, visit the official
WooCommerce REST API Documentation.

Supported Authentication Methods​

  • API Key (Consumer Key & Consumer Secret)

More details on authentication:
WooCommerce Authentication Methods

Basic Operations​

Order​

  • List Orders: Retrieve a list of all orders in your WooCommerce store.
  • Get Order: Retrieve detailed information about a specific order by its ID.
  • Create Order: Create a new order with customer and product details.
  • Update Order: Modify the details of an existing order.
  • Delete Order: Delete an order by its ID.

Coupon​

  • List Coupons: Retrieve a list of all discount coupons in your WooCommerce store.
  • Get Coupon: Retrieve details of a specific coupon by its ID.
  • Create Coupon: Create a new discount coupon.
  • Update Coupon: Modify an existing coupon.
  • Delete Coupon: Remove a coupon by its ID.

Customer​

  • List Customers: Retrieve a list of all customers in your WooCommerce store.
  • Get Customer: Retrieve details of a specific customer by their ID.
  • Create Customer: Add a new customer to your store.
  • Update Customer: Modify an existing customer’s details.
  • Delete Customer: Remove a customer by their ID.

Product​

  • List Products: Retrieve a list of all products in your WooCommerce store.
  • Get Product: Retrieve details of a specific product by its ID.
  • Create Product: Add a new product to your store.
  • Update Product: Modify an existing product’s details.
  • Delete Product: Remove a product by its ID.

Order Notes​

  • List Order Notes: Retrieve notes associated with a specific order.
  • Get Order Note: Retrieve details of a specific note for an order.
  • Create Order Note: Add a new note to an order.
  • Delete Order Note: Remove a note from an order.

Further Reading​

For more information on the WooCommerce API, refer to the official
WooCommerce REST API Documentation.