Skip to content
GET /unified/ecommerce/orders/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body

idstring
required·

The unique identifier for an order

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
billing_addressobject

The billing address for an order

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
citystring

The city of the billing address

company_namestring

The company name of customer

countrystring

The country of the billing address

postal_codestring

The postal code of the billing address

statestring

The state/province of the billng address

street_1string

The first line of billing address

street_2string

The second line of billing address

created_atstring · date-time

The date and time when order was created

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
currencystring

The currency associated for amount of an order

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
customerobject

The customer this order is linked to

References: Customers → id
6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
company_namestring

The company name of customer

emailsobject[]

The emails of customer

3 properties
emailstring

The email of the customer

is_primaryboolean

The status of email

typestring

The type of email

first_namestring

The first name of customer

idstring

The unique identifier for customer

last_namestring

The last name of customer

namestring

The full name of customer

phonesobject[]

The phone numbers of customer

2 properties
numberstring

The number of phone

typestring

The type of phone

discountsobject[]

The discounts for an order

3 supported
Shopify
supported
Wix
supported
Zoho Inventory
supported
amountstring

The fixed amount of the discount

codestring

The code used to apply the discount

percentagestring

The percentage of discount

exchange_ratestring

The exchange rate for an order's transaction when the currency is different from the store's default currency.

2 supported
Bigcommerce
supported
Zoho Inventory
supported
fulfillment_statusstring

The fullfillment status for an order. If no clear mapping exists, then raw value is returned.

Possible values:
pendingpartialdeliveredcancelled
4 supported
Commerce7
supported
Shopify
supported
Wix
supported
Zoho Inventory
supported
line_itemsobject[]

The line items for an order

5 supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
namestring
required·

The name of the line item

quantitystring
required·

The quantity of the line item

descriptionstring

The description of the line item

discountsobject[]

The discounts for line item

3 properties
amountstring

The fixed amount for discounts

codestring

The used for discounts

percentagestring

The percentage of discounts

idstring

The id of the line item

optionsobject[]

The options for line item

3 properties
idstring

The unique identifier for options

namestring

The name for options

valuestring

The value for options

product_idstring

The product id of the line item

skustring

The sku of the line item

tax_amountstring

The tax amount of the line item

tax_ratestring

The tax rate of the line item

total_amountstring

The total amount of the line item

unit_pricestring

The unit price of the line item

variant_idstring

The variant id of the line item

notestring

The note for an order

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
order_numberstring

The order number for an order

5 supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
payment_methodstring

The payment method used for this order

3 supported
Bigcommerce
supported
Commerce7
supported
WooCommerce
supported
payment_statusstring

The payment status for an order. If no clear mapping exists, then raw value is returned.

Possible values:
pendingauthorizedpaidpartialrefundedvoidedcancelledunknown
5 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
Zoho Inventory
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

shipping_addressobject

The shipping address for an order

5 supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
citystring

The city of the shipping address

company_namestring

The company name of customer

countrystring

The country of the shipping address

postal_codestring

The postal code of the shipping address

statestring

The state/province of the shipping address

street_1string

The first line of shipping address

street_2string

The second line of shipping address

shipping_coststring

The shipping cost for an order

4 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
shipping_methodsobject

The shipping methods that are associated with the Order.

statusstring

The status for an order. If no clear mapping exists, then raw value is returned.

Possible values:
activecompletedcancelledarchivedpending
3 supported
Bigcommerce
supported
WooCommerce
supported
Zoho Inventory
supported
sub_totalstring

The sub-total amount for an order

5 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
Zoho Inventory
supported
submitted_datestring
total_amountstring

The total amount for an order

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
total_discountstring

The total discount for an order

5 supported
Bigcommerce
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
total_taxstring

The total tax for an order

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
trackingobject

The tracking details for an order

1 supported
Wix
supported
numberstring
required·

The tracking number of shipment

providerstring
required·

The name of carrier handling the shipment

updated_atstring · date-time

The date and time of last parcel update

urlstring

The url of tracking page

typestring

The type of the order

2 supported
Commerce7
supported
Zoho Inventory
supported
updated_atstring · date-time

The date and time when order was updated

6 supported
Bigcommerce
supported
Commerce7
supported
Shopify
supported
Wix
supported
WooCommerce
supported
Zoho Inventory
supported
curl -X GET 'https://api.truto.one/unified/ecommerce/orders/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const integratedAccountId = '<integrated_account_id>';

const response = await fetch(`https://api.truto.one/unified/ecommerce/orders/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/ecommerce/orders/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.get(
  'ecommerce',
  'orders',
  '<resource_id>',
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.get(
        "ecommerce",
        "orders",
        "<resource_id>",
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())