Skip to main content
PUT
/
ecommerce
/
fulfillments
/
{id}
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.465Z",
  "rootfi_company_id": 1089,
  "platform_id": "ful_123456",
  "order_id": "ord_123456",
  "status": "in_transit",
  "tracking_number": "1234567890",
  "carrier_name": "USPS"
}
Update an existing fulfillment (shipment) in the e-commerce platform. Only provided fields will be updated.

​
Path Parameters

ParameterTypeRequiredDescription
idstringYesThe rootfi_id or platform_id of the fulfillment to update

​
Request Body

FieldTypeRequiredDescription
statusstringNoFulfillment status (pending, in_transit, delivered, canceled, failed, returned)
shipment_statusstringNoCurrent shipping/delivery state
estimated_delivery_datestringNoExpected delivery date (ISO 8601)
actual_delivery_datestringNoActual delivery date (ISO 8601)
tracking_infoobjectNoCarrier tracking details including tracking number and carrier name
See Fulfillment Overview for complete field details.

Authorizations

​
api_key
string
header
required

Path Parameters

​
id
string
required

The rootfi_id or platform_id of the fulfillment

Body

application/json

The body is of type any.

Response

Fulfillment updated successfully

V4 Fulfillment object with comprehensive tracking

​
rootfi_id
number<double>
required

The unique ID we assign for that data's information

Example:

157

​
rootfi_created_at
string<date-time>
required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

​
rootfi_updated_at
string<date-time>
required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

​
rootfi_company_id
number<double>
required

The ID of the company in the accounting platform

Example:

1089

​
platform_id
string
required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

​
rootfi_deleted_at
string<date-time> | null

The date at which the data was deleted in the accounting platform

​
platform_unique_id
string | null

The ID of the data in the accounting platform.

​
raw_data
object

A JSON containing fields that you can directly get from the accounting platform.

​
data_hash
string | null

The hash of the data

​
order_id
string | null

Reference to the parent Order

​
name
string | null

Fulfillment reference name (e.g., "#1001.1" for first shipment of order 1001)

​
status
enum<string> | null

Overall fulfillment lifecycle status

Available options:
pending,
in_transit,
delivered,
canceled,
failed,
returned,
unknown
​
shipment_status
enum<string> | null

Current shipping/delivery state

Available options:
label_printed,
picked_up,
in_transit,
out_for_delivery,
delivered,
exception,
returned,
unknown
​
estimated_delivery_date
string | null

Expected delivery date provided by carrier (ISO 8601)

​
actual_delivery_date
string | null

Actual delivery date (null if not yet delivered)

​
weight
number<double> | null

Total package weight

​
weight_unit
string | null

Unit of measurement for weight (e.g., "lb", "kg", "oz")

​
addresses
ecommerceV4AddressObject · object[] | null

Origin (warehouse) and destination (shipping) addresses

​
line_items
ecommerceFulfillmentLineItem · object[] | null

Items and quantities included in this shipment

​
tracking_info
ecommerceTrackingInfoObject · object

Carrier tracking details

​
created_at
string | null

Original creation timestamp from platform

​
updated_at
string | null

Last update timestamp from platform