Skip to main content
GET
/
ecommerce
/
orders
/
{id}
Get Order
curl --request GET \
  --url https://api.rootfi.dev/v4/ecommerce/orders/{id} \
  --header 'api_key: <api-key>'
{
  "rootfi_id": 157,
  "rootfi_deleted_at": null,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "ord_123456",
  "platform_unique_id": "ORD-2024-001",
  "currency_id": "USD",
  "reference": "REF-2024-001",
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "order_name": "Order #ORD-2024-001",
  "order_number": "ORD-2024-001",
  "description": "Summer Sale Order - Wireless Headphones",
  "total_discount": 10,
  "sub_total": 89.99,
  "tax_amount": 7.2,
  "total_amount": 97.19,
  "amount_due": 0,
  "order_status": "FULFILLED",
  "payment_status": "PAID",
  "customer_id": "cus_123456",
  "shipping_amount": 5.99
}
Retrieve a specific order by its ID. Orders include embedded fulfillments, transactions, and addresses for complete order lifecycle tracking.

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the order to retrieve

Authorizations

​
api_key
string
header
required

Path Parameters

​
id
string
required

The rootfi_id or platform_id of the order

Response

V4 Order object with embedded fulfillments and transactions

​
rootfi_id
number<double>
required

The unique ID we assign for that data's information

Example:

157

​
rootfi_created_at
string<date-time>
required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

​
rootfi_updated_at
string<date-time>
required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

​
rootfi_company_id
number<double>
required

The ID of the company in the accounting platform

Example:

1089

​
platform_id
string
required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

​
rootfi_deleted_at
string<date-time> | null

The date at which the data was deleted in the accounting platform

​
platform_unique_id
string | null

The ID of the data in the accounting platform.

​
raw_data
object

A JSON containing fields that you can directly get from the accounting platform.

​
data_hash
string | null

The hash of the data

​
customer_id
string | null

Reference to the Contact who placed this order

​
currency_id
string | null

ISO 4217 currency code for all monetary amounts

​
order_number
string | null

Human-readable order number (e.g., "ORD-2024-001")

​
status
enum<string> | null

Overall status of the order

Available options:
pending,
processing,
completed,
canceled,
on_hold,
unknown
​
payment_status
enum<string> | null

Payment state of the order

Available options:
pending,
paid,
partially_paid,
refunded,
partially_refunded,
voided,
unknown
​
fulfillment_status
enum<string> | null

Shipping/delivery state of the order

Available options:
unfulfilled,
partially_fulfilled,
fulfilled,
returned,
unknown
​
total_amount
number<double> | null

Final total amount including tax and shipping

​
total_discount
number<double> | null

Total discount amount applied to this order

​
total_tax
number<double> | null

Total tax amount charged

​
shipping_amount
number<double> | null

Shipping and handling charges

​
created_at
string | null

Original creation timestamp from platform (ISO 8601)

​
updated_at
string | null

Last update timestamp from platform (ISO 8601)

​
line_items
ecommerceV4LineItemObject · object[] | null

Individual items included in this order

​
addresses
ecommerceV4AddressObject · object[] | null

Shipping and billing addresses for this order

​
fulfillments
ecommerceFulFillmentsObject · object[] | null

Complete fulfillment records including tracking information

​
transactions
ecommerceTransactionObject · object[] | null

All payment and refund transactions associated with this order