WooCommerce data, from one API.

The store's name, address, currency, time zone, WooCommerce version and number of published products.

List the store's products with price, sale and stock status, short description (plain text), categories and main image. Includes the total count and number of pages.

search string

Only results matching this text.

category integer

Only products in this category (its ID, from list_categories).

status string

Only products with this status. any | publish | draft | pending | private default: 'publish'

stock_status string

Only products with this stock status. instock | outofstock | onbackorder

on_sale boolean

Only products on sale. default: false

orderby string

Sort by date, popularity (sales), rating or price. date | popularity | rating | price default: 'date'

order string

Sort direction. asc | desc default: 'desc'

per_page integer

Results per page (1–100). default: 20

page integer

Page of results, from 1. default: 1

One product in full: everything list_products returns, plus its description (plain text), all images, attributes, average rating, rating count and total sales.

id* integer

The product ID.

List the store's product categories with their ID, slug, parent and number of published products.

search string

Only results matching this text.

per_page integer

Results per page (1–100). default: 100

page integer

Page of results, from 1. default: 1

Sales totals for a period: gross and net sales, average daily net sales, orders, items, tax, shipping, refunds, discounts and new customers, plus totals per day (or per month for long ranges). Amounts are in the store currency; dates are in the store's time zone.

period string

A preset range in the store's time zone: week (the last 7 days, including today), month (this month so far), last_month, or year (this year so far, totals by month). Defaults to week. Leave it out when giving date_min. week | month | last_month | year

date_min string

First day, YYYY-MM-DD (inclusive), instead of period.

date_max string

Last day, YYYY-MM-DD (inclusive), with date_min. Defaults to today.

The best-selling products for a period (up to 12), by quantity sold.

period string

A preset range in the store's time zone: week (the last 7 days, including today), month (this month so far), last_month, or year (this year so far, totals by month). Defaults to week. Leave it out when giving date_min. week | month | last_month | year

date_min string

First day, YYYY-MM-DD (inclusive), instead of period.

date_max string

Last day, YYYY-MM-DD (inclusive), with date_min. Defaults to today.

List orders, newest first, with number, date, status, currency, totals, items (name, quantity, SKU) and coupon codes. Customer details (names, addresses, emails, phone numbers, notes) are never included.

status string

Only orders with this status. any | pending | processing | on-hold | completed | cancelled | refunded | failed default: 'any'

after string

Only orders created on or after this day, YYYY-MM-DD (store time zone).

before string

Only orders created on or before this day, YYYY-MM-DD (store time zone).

per_page integer

Results per page (1–100). default: 20

page integer

Page of results, from 1. default: 1

List the store's coupons with code, amount, discount type, expiry date and usage.

search string

Only results matching this text.

per_page integer

Results per page (1–100). default: 20

page integer

Page of results, from 1. default: 1

Create a coupon. Needs a key with Read/Write permissions. Codes are unique in a store, so WooCommerce refuses a code that already exists.

code* string

The coupon code customers enter.

discount_type string

percent (a percentage off the cart), fixed_cart (a fixed amount off the cart) or fixed_product (a fixed amount off each matching product). percent | fixed_cart | fixed_product default: 'fixed_cart'

amount* number

The discount: a percentage for percent, else an amount in the store currency.

date_expires string

The day the coupon expires, YYYY-MM-DD. As in WooCommerce, it stops working at 00:00 that day (store time zone).

individual_use boolean

Whether the coupon can't be combined with other coupons. default: false

usage_limit integer

How many times the coupon can be used in total.

usage_limit_per_user integer

How many times each customer can use it.

minimum_amount number

The order subtotal needed to use the coupon.

product_ids array<integer>

Only these products (their IDs) are discounted.

free_shipping boolean

Whether the coupon grants free shipping (the store's free shipping method must accept coupons). default: false

description string

A note for the store's staff; customers don't see it.