BigCommerce - Get Orders

Description

This module allows querying orders from a BigCommerce store. It can get a specific order by ID or list orders with various filters such as status, customer, date range, and totals.

Configuration

Required Credentials

• Store Hash: Unique hash of your BigCommerce store
• Access Token: API V2 access token

Parameters

Parameter	Type	Required	Description
credentials_id	credential	Yes	BigCommerce credentials
order_id	string	No	Specific order ID
status_id	select	No	Order status
customer_id	string	No	Customer ID
email	string	No	Customer email
min_date_created	string	No	Minimum creation date (RFC 2822 or ISO 8601)
max_date_created	string	No	Maximum creation date
min_total	number	No	Minimum total
max_total	number	No	Maximum total
payment_method	string	No	Payment method
include_products	boolean	No	Include order products
sort	select	No	Sorting
limit	number	No	Result limit (default: 50)
page	number	No	Results page (default: 1)

Order Statuses

ID	Status
0	Incomplete
1	Pending
2	Shipped
3	Partially Shipped
4	Refunded
5	Cancelled
6	Declined
7	Awaiting Payment
8	Awaiting Pickup
9	Awaiting Shipment
10	Completed
11	On Hold
12	Disputed

Output

{
  "success": true,
  "orders": [...],
  "count": 25,
  "page": 1,
  "limit": 50,
  "message": "25 orders retrieved"
}

Order Fields

• id: Order ID
• status_id: Status ID
• status: Status name
• customer_id: Customer ID
• date_created: Creation date
• total_inc_tax: Total with taxes
• total_ex_tax: Total without taxes
• items_total: Item count
• payment_method: Payment method
• billing_address: Billing address
• shipping_addresses: Shipping addresses

Usage Example

Get order by ID

{
  "order_id": "12345",
  "include_products": true
}

Pending orders

{
  "status_id": "1",
  "sort": "date_created:desc"
}

Customer orders

{
  "customer_id": "789",
  "limit": 100
}

Orders by date range

{
  "min_date_created": "2024-01-01",
  "max_date_created": "2024-01-31",
  "min_total": 100
}

API Used

• Endpoint: GET /stores/{store_hash}/v2/orders
• Documentation: BigCommerce Orders API

Notes

• Uses the BigCommerce V2 API for orders
• Products are fetched with an additional call if requested
• The V2 API returns a direct array (no data wrapper)
• Dates must be in RFC 2822 or ISO 8601 format

Related Nodes

• BigcommerceUpdateOrder - Update order
• BigcommerceGetCustomers - Get customers
• BigcommerceGetProducts - Get products