Skip to main content
GET
/
ecommerce
/
fulfillments
Get All Fulfillments
curl --request GET \
  --url https://api.rootfi.dev/v4/ecommerce/fulfillments \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "rootfi_id": 10001,
      "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": "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"
    }
  ],
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}
The Fulfillments 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.

Authorizations

api_key
string
header
required

Query Parameters

limit
integer | null

The number of fulfillments 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

Response

The data of the fulfillments endpoint.

data
ecommerceFulFillmentsObject · 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