Overview

The Orders Data Model represents contact purchase transactions in your e-commerce platform. V4 introduces a comprehensive order structure that embeds fulfillments, transactions, and addresses directly within the order object.

Unified order properties: Access order details including status, amounts, contact information, and line items from a single endpoint.
Embedded fulfillments: Complete shipment tracking and delivery status included directly in the order response.
Consolidated transactions: All payment and refund transactions for an order accessible without additional API calls.
Expandable relationships: Use the expand parameter to customize the level of detail returned.

Attributes

Order Attributes

Property	Type	Description	Required	Expandable
`rootfi_id`	integer	Unique identifier for this order	Yes	No
`rootfi_created_at`	datetime	When this order was created in Commenda’s system	Yes	No
`rootfi_updated_at`	datetime	When this order was last updated in Commenda’s system	Yes	No
`rootfi_company_id`	integer	Company identifier this order belongs to	Yes	No
`platform_id`	string	Platform-specific order identifier	Yes	No
`customer_id`	string	Reference to the Contact who placed this order	Yes	Yes
`currency_id`	string	ISO 4217 currency code for all monetary amounts	Yes	No
`order_number`	string	Human-readable order number (e.g., “ORD-2024-001”)	Yes	No
`status`	enum	Overall status of the order	Yes	No
`payment_status`	enum	Payment state of the order	Yes	No
`fulfillment_status`	enum	Shipping/delivery state of the order	Yes	No
`total_amount`	decimal	Final total amount including tax and shipping	Yes	No
`total_discount`	decimal	Total discount amount applied to this order	No	No
`total_tax`	decimal	Total tax amount charged	No	No
`shipping_amount`	decimal	Shipping and handling charges	No	No
`created_at`	datetime	Original creation timestamp from platform	Yes	No
`updated_at`	datetime	Last update timestamp from platform	Yes	No
`line_items`	array	Individual items included in this order	Yes	Yes
`addresses`	array	Shipping and billing addresses for this order	No	Yes
`fulfillments`	array	Complete fulfillment records including tracking information	No	Yes
`transactions`	array	All payment and refund transactions associated with this order	No	Yes

Status Enum Values

Value	Description
`PENDING`	Order has been created but not yet processed
`PROCESSING`	Order is being prepared for fulfillment
`COMPLETED`	Order has been fully fulfilled
`CANCELLED`	Order has been cancelled
`ON_HOLD`	Order is temporarily on hold
`UNKNOWN`	Status cannot be determined

Payment Status Enum Values

Value	Description
`DRAFT`	Payment created but not yet initiated
`PENDING`	Payment initiated but not confirmed
`PAID`	Payment completed successfully
`PARTIALLY_PAID`	Partial payment received
`FAILED`	Payment failed to process
`REFUNDED`	Payment refunded
`PARTIALLY_REFUNDED`	Partial refund issued
`VOIDED`	Payment voided before capture
`UNKNOWN`	Payment status cannot be determined

Fulfillment Status Enum Values

Value	Description
`UNFULFILLED`	Order has not been shipped
`PARTIALLY_FULFILLED`	Some items have been shipped
`FULFILLED`	All items have been shipped
`RETURNED`	Order has been returned to sender
`UNKNOWN`	Fulfillment status cannot be determined

Expandable Attributes

expand=customer - Includes full Contact object details
expand=line_items - Includes detailed LineItem objects with product information
expand=addresses - Includes full Address objects
expand=fulfillments - Includes complete Fulfillment objects with tracking
expand=transactions - Includes all Transaction objects (payments, refunds)

LineItem Object

Each line item in the line_items array contains:

Property	Type	Description	Required	Expandable
`rootfi_id`	integer	Unique identifier for this line item	Yes	No
`item_id`	string	Reference to the Item (product) being purchased	Yes	Yes
`variant_id`	string	Reference to the specific Variant being purchased	No	Yes
`name`	string	Display name of the product	Yes	No
`description`	string	Detailed description or notes for this line item	No	No
`quantity`	integer	Number of units ordered	Yes	No
`unit_amount`	decimal	Price per unit before taxes and discounts	Yes	No
`tax_amount`	decimal	Total tax amount for this line item	No	No
`discount_amount`	decimal	Total discount applied to this line item	No	No
`total_amount`	decimal	Final amount (quantity x unit_amount + tax - discount)	Yes	No

{
  "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",
  "customer_id": "cus_123456",
  "currency_id": "USD",
  "order_number": "ORD-2024-001",
  "status": "COMPLETED",
  "payment_status": "PAID",
  "fulfillment_status": "FULFILLED",
  "total_amount": 97.19,
  "total_discount": 10.00,
  "total_tax": 7.20,
  "shipping_amount": 5.99,
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.000Z",
  "line_items": [
    {
      "rootfi_id": 5001,
      "item_id": "prod_789",
      "variant_id": "var_001",
      "name": "Wireless Headphones - Black",
      "description": "Premium wireless headphones",
      "quantity": 1,
      "unit_amount": 99.99,
      "tax_amount": 7.20,
      "discount_amount": 10.00,
      "total_amount": 97.19
    }
  ],
  "addresses": [
    {
      "rootfi_id": 278264,
      "platform_id": "addr_123456",
      "type": "SHIPPING",
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    },
    {
      "rootfi_id": 278265,
      "platform_id": "addr_123457",
      "type": "BILLING",
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    }
  ],
  "fulfillments": [
    {
      "rootfi_id": 10001,
      "platform_id": "ful_001",
      "status": "DELIVERED",
      "shipment_status": "DELIVERED",
      "tracking_info": {
        "number": "1Z999AA10123456784",
        "company": "UPS",
        "url": "https://www.ups.com/track?tracknum=1Z999AA10123456784"
      }
    }
  ],
  "transactions": [
    {
      "rootfi_id": 8001,
      "platform_id": "pay_001",
      "type": "PAYMENT",
      "amount": 97.19,
      "status": "PAID",
      "payment_method_type": "CARD"
    }
  ]
}

General

Server Side SDKs

Core API

Unified API

Attributes

Order Attributes

Status Enum Values

Payment Status Enum Values

Fulfillment Status Enum Values

Expandable Attributes

LineItem Object

General

Server Side SDKs

Core API

Unified API

​Attributes

​Order Attributes

​Status Enum Values

​Payment Status Enum Values

​Fulfillment Status Enum Values

​Expandable Attributes

​LineItem Object

Attributes

Order Attributes

Status Enum Values

Payment Status Enum Values

Fulfillment Status Enum Values

Expandable Attributes

LineItem Object