Skip to main content
The Fulfillment Data Model tracks the physical shipment of orders from your warehouse to contacts. V4 introduces enhanced fulfillment tracking with complete carrier information, delivery estimates, and embedded tracking details.
  • Complete shipment tracking: Monitor fulfillments from label creation through delivery with detailed status updates.
  • Embedded tracking info: Carrier details and tracking URLs included directly in the fulfillment response.
  • Multi-address support: Both origin (warehouse) and destination (shipping) addresses included.
  • Line item tracking: Know exactly which items are included in each shipment.

​
Attributes

FieldTypeDescriptionRequiredExpandable
rootfi_idintegerUnique identifier for this fulfillmentYesNo
rootfi_created_atdatetimeWhen this fulfillment was created in Commenda’s systemYesNo
rootfi_updated_atdatetimeWhen this fulfillment was last updatedYesNo
rootfi_company_idintegerCompany identifier this fulfillment belongs toYesNo
platform_idstringPlatform-specific fulfillment identifierYesNo
order_idstringReference to the parent OrderYesYes
namestringFulfillment reference name (e.g., “#1001.1” for first shipment of order 1001)NoNo
statusenumOverall fulfillment lifecycle statusYesNo
shipment_statusenumCurrent shipping/delivery stateYesNo
estimated_delivery_datedatetimeExpected delivery date provided by carrierNoNo
actual_delivery_datedatetimeActual delivery date (null if not yet delivered)NoNo
weightdecimalTotal package weightNoNo
weight_unitstringUnit of measurement for weight (e.g., “lb”, “kg”, “oz”)NoNo
addressesarrayOrigin (warehouse) and destination (shipping) addressesYesYes
line_itemsarrayItems and quantities included in this shipmentYesYes
tracking_infoobjectCarrier tracking detailsNoNo
created_atdatetimeOriginal creation timestamp from platformYesNo
updated_atdatetimeLast update timestamp from platformYesNo

​
Status Enum Values

ValueDescription
pendingFulfillment has been created but not yet shipped
in_transitPackage is currently being shipped
deliveredPackage has been successfully delivered
cancelledFulfillment has been cancelled
failedDelivery attempt failed
returnedPackage has been returned to sender
unknownStatus cannot be determined

​
Shipment Status Enum Values

ValueDescription
label_printedShipping label has been generated
picked_upCarrier has picked up the package
in_transitPackage is en route to destination
out_for_deliveryPackage is on the delivery vehicle
deliveredPackage has been delivered
exceptionDelivery exception occurred (e.g., address issue)
returnedPackage is being returned
unknownShipment status cannot be determined

​
Expandable Attributes

  • expand=order - Includes full Order object
  • expand=addresses - Includes complete Address objects
  • expand=line_items - Includes detailed FulfillmentLineItem objects

​
TrackingInfo Object

The embedded tracking information:
FieldTypeDescriptionRequired
numberstringTracking number assigned by the carrierYes
companystringName of the shipping carrier (e.g., “UPS”, “FedEx”, “USPS”)Yes
urlstringDirect URL to track the shipment on the carrier’s websiteNo
statusstringCurrent tracking status from the carrierNo

​
FulfillmentLineItem Object

Each line item in a fulfillment:
FieldTypeDescriptionRequired
rootfi_idintegerUnique identifier for this fulfillment line itemYes
line_item_idstringReference to the original order line itemYes
quantityintegerQuantity of this item included in the shipmentYes

​
Filtering Fulfillments

GET /v4/fulfillments?order_id=ord_123456
GET /v4/fulfillments?status=in_transit
GET /v4/fulfillments?shipment_status=out_for_delivery

{
  "rootfi_id": 10001,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "ful_shopify_001",
  "order_id": "ord_shopify_001",
  "name": "#1001.1",
  "status": "in_transit",
  "shipment_status": "in_transit",
  "estimated_delivery_date": "2025-01-08T00:00:00Z",
  "actual_delivery_date": null,
  "weight": 2.5,
  "weight_unit": "lb",
  "addresses": [
    {
      "rootfi_id": 9001,
      "platform_id": "loc_warehouse_001",
      "type": "warehouse",
      "street": "123 Warehouse St",
      "city": "Los Angeles",
      "state": "CA",
      "postal_code": "90001",
      "country": "US"
    },
    {
      "rootfi_id": 9002,
      "platform_id": "addr_customer_001",
      "type": "shipping",
      "street": "456 Customer St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    }
  ],
  "line_items": [
    {
      "rootfi_id": 11001,
      "line_item_id": "li_123456",
      "quantity": 1
    }
  ],
  "tracking_info": {
    "number": "1Z999AA10123456784",
    "company": "UPS",
    "url": "https://www.ups.com/track?tracknum=1Z999AA10123456784",
    "status": "in_transit"
  },
  "created_at": "2024-01-22T05:07:31.465Z",
  "updated_at": "2024-01-22T05:07:31.000Z"
}

​
Delivered Fulfillment Example

Delivered Fulfillment
{
  "rootfi_id": 10002,
  "rootfi_created_at": "2024-01-20T10:00:00.000Z",
  "rootfi_updated_at": "2024-01-23T14:30:00.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "ful_shopify_002",
  "order_id": "ord_shopify_002",
  "name": "#1002.1",
  "status": "delivered",
  "shipment_status": "delivered",
  "estimated_delivery_date": "2024-01-23T00:00:00Z",
  "actual_delivery_date": "2024-01-23T14:25:00Z",
  "weight": 1.2,
  "weight_unit": "lb",
  "tracking_info": {
    "number": "9400111899223100001234",
    "company": "USPS",
    "url": "https://tools.usps.com/go/TrackConfirmAction?tLabels=9400111899223100001234",
    "status": "delivered"
  },
  "created_at": "2024-01-20T10:00:00.000Z",
  "updated_at": "2024-01-23T14:30:00.000Z"
}