WooCommerce - Get Orders

Description

This module allows querying orders from your WooCommerce store with filters by status, customer, dates, product, and more.

Configuration

Field	Type	Required	Description
credentials_id	string	Yes	Credentials ID
order_id	number	No	Specific order ID
status	string	No	Order status
customer	number	No	Customer ID
product	number	No	Orders with this product
search	string	No	Text search
after	string	No	After date (ISO 8601)
before	string	No	Before date (ISO 8601)
orderby	string	No	date, id, include, title, slug
order	string	No	asc, desc
per_page	number	No	Orders per page (max 100)
page	number	No	Page number

Credentials

Field	Description	Example
url	WooCommerce store base URL	https://my-store.com
consumer_key	REST API Consumer Key	ck_xxxx...
consumer_secret	REST API Consumer Secret	cs_xxxx...

Order Statuses (status)

Value	Description
pending	Pending payment
processing	Processing
on-hold	On hold
completed	Completed
cancelled	Cancelled
refunded	Refunded
failed	Failed
trash	Trash
any	Any status

Output

{
  "success": true,
  "orders": [
    {
      "id": 1234,
      "number": "1234",
      "status": "processing",
      "total": "89.99",
      "customer_id": 123,
      "billing": {},
      "shipping": {},
      "line_items": [],
      "date_created": "2024-01-15T10:30:00"
    }
  ],
  "total": 450,
  "total_pages": 9,
  "current_page": 1
}

Usage Example

Orders pending shipment

{
  "credentials_id": "woo_tienda",
  "status": "processing",
  "per_page": 50
}

Today’s orders

{
  "credentials_id": "woo_tienda",
  "after": "2024-01-15T00:00:00",
  "before": "2024-01-15T23:59:59"
}

Notes

• The maximum limit per request is 100 orders
• Dates must be in ISO 8601 format
• By default sorted by date descending
• The search field searches in order number and customer data

Related Nodes

• WooUpdateOrder - Update order status or tracking
• WooGetCustomers - Get order customer data
• WooGetProducts - Get order product data