Skip to main content
GET
/
ecommerce
/
orders
Get All Orders
curl --request GET \
  --url https://api.rootfi.dev/v3/ecommerce/orders \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "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,
      "line_items": [
        {
          "item_id": "prod_789",
          "tax_id": "tax_001",
          "line_item_type_id": "ord_123456",
          "line_item_type": "ECOMMERCE_ORDERS",
          "description": "Wireless Headphones - Black",
          "unit_amount": 99.99,
          "quantity": 1,
          "total_discount": 10,
          "tax_amount": 7.2,
          "sub_total": 89.99,
          "total_amount": 97.19
        }
      ]
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}
The Orders Data Model is designed to streamline the management and retrieval of orders information across various ecommerce platforms.

Authorizations

​
api_key
string
header
required

Query Parameters

​
limit
integer | null

The number of orders you want to retrieve

​
next
string | null

The next page of objects to retrieve

​
prev
string | null

The previous page of objects to retrieve

​
select
string | null

Comma separated fields to select. Supported values are raw_data, data_hash

​
rootfi_updated_at[gte]
string | null

Filter by rootfi_updated_at Greater than or Equal To.

​
rootfi_company_id[eq]
integer | null

Filter by rootfi_company_id. You can filter by any field using this syntax field_name[operator]

​
include_deleted_records
string | null

Include deleted records. By default, deleted records are not included. Supported values are true and false

​
return_count
string | null

Return the count of the objects. Supported values are true and false

​
sort[rootfi_created_at]
enum<string> | null

Sort by rootfi_created_at

Available options:
ASC,
DESC
​
sort[rootfi_updated_at]
enum<string> | null

Sort by rootfi_updated_at

Available options:
ASC,
DESC
​
expand
string | null

Comma separated fields to expand. Supported values are line_items

Response

The data of the orders endpoint.

​
data
ecommerceOrderObject · object[]
required
​
prev
string | null

The previous page of objects to retrieve

​
next
string | null

The next page of objects to retrieve

​
total_count
integer | null

The total count of the objects