Skip to content

List Orders

Endpoint

http
GET /unified/ecommerce/orders
Integrations supported
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string
By default the `result` attribute is an array of objects. This parameter allows you to specify a field in each `result` objects to use as key, which transforms the `result` array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
Example: id
truto_ignore_limit
boolean
Ignores the `limit` query parameter.
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar
created_at
string · date-time
The date and time when order was created
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
updated_at
string · date-time
The date and time when order was updated
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
customer_id
string
The ID of the customer to filter the orders by.
Supported in
  • Bigcommerce
  • WooCommerce
sort_by
object
The field to sort the resource by. Should be in format `{ fieldName: direction }`. The direction can be `asc` or `desc`.
Supported in
  • Bigcommerce
  • Wix
  • WooCommerce
created_at
string · date-time
The date and time when order was created
All possible enum values:
  • asc
  • desc
Supported in
  • Bigcommerce
  • Wix
  • WooCommerce
updated_at
string · date-time
The date and time when order was updated
All possible enum values:
  • asc
  • desc
Supported in
  • Bigcommerce
  • Wix
id
string
The unique identifier for an order
All possible enum values:
  • asc
  • desc
Supported in
  • WooCommerce
status
string
Filter orders by their status.
All possible enum values:
  • active
  • any
  • archived
  • cancelled
  • completed
  • pending
Supported in
  • Shopify
  • WooCommerce
fulfillment_status
string
The fullfillment status for an order. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • cancelled
  • delivered
  • partial
  • pending
Supported in
  • Shopify

Response Body

result
object[]
List of Orders
id
string
REQUIRED · The unique identifier for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
order_number
string
The order number for an order
Supported in
  • Shopify
  • Wix
  • WooCommerce
currency
string
The currency associated for amount of an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
exchange_rate
string
The exchange rate for an order's transaction when the currency is different from the store's default currency.
Supported in
  • Bigcommerce
discounts
object[]
The discounts for an order
Supported in
  • Shopify
  • Wix
code
string
The code used to apply the discount
amount
string
The fixed amount of the discount
percentage
string
The percentage of discount
sub_total
string
The sub-total amount for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
shipping_cost
string
The shipping cost for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
total_discount
string
The total discount for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
total_tax
string
The total tax for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
total_amount
string
The total amount for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
status
string
The status for an order. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • active
  • completed
  • cancelled
  • archived
  • pending
Supported in
  • Bigcommerce
  • WooCommerce
payment_status
string
The payment status for an order. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • pending
  • authorized
  • paid
  • partial
  • refunded
  • voided
  • cancelled
  • unknown
Supported in
  • Bigcommerce
  • Shopify
  • Wix
fulfillment_status
string
The fullfillment status for an order. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • pending
  • partial
  • delivered
  • cancelled
Supported in
  • Shopify
  • Wix
payment_method
string
The payment method used for this order
Supported in
  • Bigcommerce
  • WooCommerce
customer
object
The customer this order is linked to
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
id
string
The unique identifier for customer
first_name
string
The first name of customer
last_name
string
The last name of customer
name
string
The full name of customer
company_name
string
The company name of customer
emails
object[]
The emails of customer
email
string
The email of the customer
type
string
The type of email
is_primary
boolean
The status of email
phones
object[]
The phone numbers of customer
number
string
The number of phone
type
string
The type of phone
billing_address
object
The billing address for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
street_1
string
The first line of billing address
street_2
string
The second line of billing address
company_name
string
The company name of customer
city
string
The city of the billing address
state
string
The state/province of the billng address
postal_code
string
The postal code of the billing address
country
string
The country of the billing address
shipping_address
object
The shipping address for an order
Supported in
  • Shopify
  • Wix
  • WooCommerce
street_1
string
The first line of shipping address
street_2
string
The second line of shipping address
company_name
string
The company name of customer
city
string
The city of the shipping address
state
string
The state/province of the shipping address
postal_code
string
The postal code of the shipping address
country
string
The country of the shipping address
tracking
object
The tracking details for an order
Supported in
  • Wix
provider
string
REQUIRED · The name of carrier handling the shipment
number
string
REQUIRED · The tracking number of shipment
url
string
The url of tracking page
updated_at
string · date-time
The date and time of last parcel update
line_items
object[]
The line items for an order
Supported in
  • Shopify
  • Wix
  • WooCommerce
name
string
REQUIRED · The name of the line item
quantity
string
REQUIRED · The quantity of the line item
total_amount
string
The total amount of the line item
id
string
The id of the line item
product_id
string
The product id of the line item
variant_id
string
The variant id of the line item
sku
string
The sku of the line item
description
string
The description of the line item
options
object[]
The options for line item
id
string
The unique identifier for options
name
string
The name for options
value
string
The value for options
unit_price
string
The unit price of the line item
tax_rate
string
The tax rate of the line item
tax_amount
string
The tax amount of the line item
discounts
object[]
The discounts for line item
code
string
The used for discounts
amount
string
The fixed amount for discounts
percentage
string
The percentage of discounts
note
string
The note for an order
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
created_at
string · date-time
The date and time when order was created
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
updated_at
string · date-time
The date and time when order was updated
Supported in
  • Bigcommerce
  • Shopify
  • Wix
  • WooCommerce
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.