Skip to main content
The Orders Data Model simplifies the handling and retrieval of orders from different ecommerce platforms. The model provides a unified representation of orders, enabling you to easily access and manage orders data from different platforms.
  • Unified orders properties: The model provides a unified representation of orders from different ecommerce gateways, enabling you to easily access and manage orders data from different platforms.
  • Comprehensive orders information: The model provides a comprehensive representation of orders.

​
Attributes

​
Order Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the order
rootfi_created_atstringThe ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_atstringThe ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_idintegerThe RootFi company ID associated with the order
platform_idstringThe Platform’s ID for the order
platform_unique_idstringThe platform’s unique identifier for the order
currency_idstringThe currency ID of the order
referencestringThe reference of the order
created_atstringThe date and time the order was created
updated_atstringThe date and time the order was last updated
order_namestringThe name of the order
order_numberstringThe order number
descriptionstringThe description of the order
total_discountnumberThe total discount amount of the order
sub_totalnumberThe subtotal of the order before taxes and shipping
tax_amountnumberThe tax amount of the order
total_amountnumberThe total amount of the order
amount_duenumberThe amount due for the order
order_statusstringThe status of the order
payment_statusstringThe payment status of the order
customer_idstringThe customer ID associated with the order
shipping_amountnumberThe shipping amount for the order
line_itemsLine Item[]The line items of the order
addressesAddress[]The addresses associated with the order
shipping_line_itemsShipping Line Item[]The shipping line items of the order

​
Line Item Attributes

PropertyTypeDescription
platform_idstringThe Platform’s ID for the line item
item_idstringThe ID of the item in the ecommerce platform
tax_idstringThe ID of the tax in the ecommerce platform
line_item_type_idstringThe ID of the line item type in the ecommerce platform
line_item_typeenumThe line item type (e.g., ECOMMERCE_ORDERS, ECOMMERCE_REFUNDS)
descriptionstringThe description of the line item
unit_amountnumberThe unit amount of the line item
quantitynumberThe quantity of the line item
total_discountnumberThe total discount of the line item
tax_amountnumberThe tax amount of the line item
sub_totalnumberThe subtotal of the line item
total_amountnumberThe total amount of the line item

​
Address Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the address
platform_idstringThe Platform’s ID for the address
platform_unique_idstringThe platform’s unique identifier for the address
typestringThe type of the address (e.g., SHIPPING, BILLING)
data_model_idstringThe ID of the data model this address belongs to
streetstringThe street address
localitystringThe locality of the address
citystringThe city of the address
statestringThe state of the address
countrystringThe country of the address
pincodestringThe postal code of the address
data_modelstringThe data model type this address belongs to
updated_atstringThe date and time the address was last updated

​
Shipping Line Item Attributes

PropertyTypeDescription
platform_idstringThe Platform’s ID for the shipping line item
parent_data_modelstringThe parent data model type (e.g., ECOMMERCE_ORDERS, ECOMMERCE_REFUNDS)
parent_data_model_idstringThe ID of the parent data model in the ecommerce platform
titlestringThe title of the shipping line item
descriptionstringThe description of the shipping line item
sub_totalnumberThe subtotal of the shipping line item
tax_amountnumberThe tax amount on the shipping subtotal
total_amountnumberThe total amount including shipping and taxes

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the order
currency_idstringThe currency ID of the order
referencestringThe reference of the order
created_atstringThe date and time the order was created
updated_atstringThe date and time the order was last updated
order_namestringThe name of the order
order_numberstringThe order number
descriptionstringThe description of the order
total_discountnumberThe total discount amount of the order
sub_totalnumberThe subtotal of the order before taxes and shipping
tax_amountnumberThe tax amount of the order
total_amountnumberThe total amount of the order
amount_duenumberThe amount due for the order
order_statusstringThe status of the order
payment_statusstringThe payment status of the order
customer_idstringThe customer ID associated with the order
shipping_amountnumberThe shipping amount for the order
line_itemsobject[]The line items of the order
addressesobject[]The addresses associated with the order
shipping_line_itemsobject[]The shipping line items of the order
{
  "rootfi_id": 157,
  "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.00,
  "sub_total": 89.99,
  "tax_amount": 7.20,
  "total_amount": 97.19,
  "amount_due": 0.00,
  "order_status": "FULFILLED",
  "payment_status": "PAID",
  "customer_id": "cus_123456",
  "shipping_amount": 5.99,
  "line_items": [
    {
      "platform_id": "li_123456",
      "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.00,
      "tax_amount": 7.20,
      "sub_total": 89.99,
      "total_amount": 97.19
    }
  ],
  "addresses": [
    {
      "rootfi_id": 278264,
      "platform_id": "addr_123456",
      "platform_unique_id": "ADDR-2024-001",
      "type": "SHIPPING",
      "data_model_id": "ord_123456",
      "street": "123 Main Street",
      "locality": "Downtown",
      "city": "New York",
      "state": "NY",
      "country": "USA",
      "pincode": "10001",
      "data_model": "ECOMMERCE_ORDERS",
      "updated_at": "2024-01-22T05:07:31.000Z"
    }
  ],
  "shipping_line_items": [
    {
      "platform_id": "sli_123456",
      "parent_data_model": "ECOMMERCE_ORDERS",
      "parent_data_model_id": "ord_123456",
      "title": "Standard Shipping",
      "description": "Standard shipping via USPS",
      "sub_total": 5.99,
      "tax_amount": 0.48,
      "total_amount": 6.47
    }
  ]
}