A shipment object includes the shipment description, carrier information, and shipment dates. The table below describes each parameter and how it maps to the Field Nation Platform.

Shipment Object

Parameter Type Example Mapping/Notes
id integer "id":216 Shipment ID.
user object "user":{} User id, first_name, and last_name of shipment creator.
name string "name":"Parts" Shipments > Item description.
direction string "direction": "to site" Shipments > To site or From site.
carrier object "carrier":{} Shipments > Tracking number and Carrier information.
name string "name":"other" Shipments > Carrier.
other string "other":"ABC Shipping" Carrier Name. Required only if carrier name = other.
link_href string "link_href":"" Link to tracking information. Automatically populated if available.
tracking string "tracking":"10025A45" Shipments > Tracking number.
arrival object "arrival":{} Estimated arrival date in UTC and local time.
arrived object "arrived":{} Delivered date in UTC and local time.
task_id integer "task_id":0 Task id associated with this shipment. Optional.
status string "status":"New" Shipment Status.


Shipment Object, No Shipments
Shipment Object, Shipping to job site, Other Carrier

Work Order Shipments Response

You can locate shipment information in the work order > shipments object.

"shipments": { }
Work Order Shipments Response