Navigation :

Shipments

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. Options “to site”, “from site”, “to provider”, “to other location”
carrier	object	"carrier":{}	Shipments > Tracking number and Carrier information.
name	string	"name":"other"	Shipments > Carrier. Options “ups”, “fedex”, “usps”, “other”
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.
location	object	"location":{}	Shipments > Location information. Required only if direction = to other location .
name	string	"name":"ABC Corp"	Shipments > Location > Location name. Optional.
address1	string	"address1":"123 Main Street"	Shipments > Location > Street Address.
address2	string	"address2":"Building 4C"	Shipments > Location > Address 2. Optional.
city	string	"city":"Phoenix"	Shipments > Location > State
state	string	"state":"AZ"	Shipments > Location > State.
zip	string	"zip":"85001"	Shipments > Location > Zip.
Country	string	"country":"US"	Shipments > Location > Country. Refer to Country Codes for a list of codes.
task_id	integer	"task_id":0	Task id associated with this shipment. Optional.
status	string	"status":"New"	Shipment Status.

Examples

Shipment Object, No Shipments

{
    "metadata": {
        "total": 0,
        "per_page": 0,
        "pages": 1,
        "page": 1
    },
    "results": [],
    "correlation_id": "a34bace68519d11e4b44c74b65c3bbbc3e6e7239",
    "actions": [
        "add"
    ]
}

Shipment Object, Shipping to job site, Other Carrier

{
   “id”:216,
   “user”:{
      “id”:756,
      “first_name”:“API”,
      “last_name”:“User”
   },
   “name”:“Parts”,
   “actions”:[
      “edit”,
      “delete”
   ],
   “direction”:“to site”,
   “carrier”:{
      “name”:“other”,
      “other”:“ABC Shipping”,
      “link_href”:“”,
      “tracking”:“10025A45”,
      “arrival”:{
         “utc”:“”,
         “local”:{
            “date”:“”,
            “time”:“”
         }
      },
      “arrived”:{
         “utc”:“”,
         “local”:{
            “date”:“”,
            “time”:“”
         }
      }
   },
   “created”:{
      “utc”:“2018-12-12 17:09:24”,
      “local”:{
         “date”:“2018-12-12”,
         “time”:“10:09:24”
      }
   },
   “task_id”:0,
   “status”:“New”
}



    
        
        
        
        
        Shipment Object, Shipping to other location, Other Carrier
        
        
    
    
{
   "id":216,
   "user":{
      "id":756,
      "first_name":"API",
      "last_name":"User"
   },
   "name":"Parts",
   "actions":[
      "edit",
      "delete"
   ],
   "direction":"to site",
   "carrier":{
      "name":"other",
      "other":"ABC Shipping",
      "link_href":"",
      "tracking":"10025A45",
      "arrival":{
         "utc":"",
         "local":{
            "date":"",
            "time":""
         }
      },
      "arrived":{
         "utc":"",
         "local":{
            "date":"",
            "time":""
         }
      }
   },
   "location": {
      "name": "",
      "address1": "6671 Southwest Fwy",
      "address2": "",
      "city": "Houston",
      "state": "TX",
      "zip": "77074",
      "country": "US",
      "distance": null,
      "map_href": "https://www.google.com/maps/search/6671+Southwest+Fwy+Houston+TX+77074+US/@29.6898,-95.5266,13z",
      "coordinates": {
         "latitude": 29.6898,
         "longitude": -95.5266,
         "exact": true
      },
      "mode": "location"
   },
   "created":{
      "utc":"2018-12-12 17:09:24",
      "local":{
         "date":"2018-12-12",
         "time":"10:09:24"
      }
   },
   "task_id":0,
   "status":"New"
}





    Work Order Shipments Response

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

"shipments": { } 


    
        
        
        
        
        Work Order Shipments Response
        
        
    
    
"shipments": {
   "metadata":{
      "total":1,
      "per_page":1,
      "pages":1,
      "page":1
   },
   "results":[
      {
         "id":216,
         "user":{
            "id":756,
            "first_name":"API",
            "last_name":"User"
         },
         "name":"Parts",
         "actions":[
            "edit",
            "delete"
         ],
         "direction":"to site",
         "carrier":{
            "name":"other",
            "other":"ABC Shipping",
            "link_href":"",
            "tracking":"10025A45",
            "arrival":{
               "utc":"",
               "local":{
                  "date":"",
                  "time":""
               }
            },
            "arrived":{
               "utc":"",
               "local":{
                  "date":"",
                  "time":""
               }
            }
         },
         "created":{
            "utc":"2018-12-12 17:09:24",
            "local":{
               "date":"2018-12-12",
               "time":"10:09:24"
            }
         },
         "task_id":0,
         "status":"New"
      }
   ],
   "correlation_id":"cb928f12927792b26e271b2edbcfb876586cd05b",
   "actions":[
      "add"
   ]
} 

    


    
        
        
        
        
        Work Order Shipments To Other Location Response
        
        
    
    
"shipments": {
   "metadata":{
      "total":1,
      "per_page":1,
      "pages":1,
      "page":1
   },
   "results":[
      {
         "id":216,
         "user":{
            "id":756,
            "first_name":"API",
            "last_name":"User"
         },
         "name":"Parts",
         "actions":[
            "edit",
            "delete"
         ],
         "direction":"to site",
         "carrier":{
            "name":"other",
            "other":"ABC Shipping",
            "link_href":"",
            "tracking":"10025A45",
            "arrival":{
               "utc":"",
               "local":{
                  "date":"",
                  "time":""
               }
            },
            "arrived":{
               "utc":"",
               "local":{
                  "date":"",
                  "time":""
               }
            }
         },
         "location": {
            "name": "",
            "address1": "6671 Southwest Fwy",
            "address2": "",
            "city": "Houston",
            "state": "TX",
            "zip": "77074",
            "country": "US",
            "distance": null,
            "map_href": "https://www.google.com/maps/search/6671+Southwest+Fwy+Houston+TX+77074+US/@29.6898,-95.5266,13z",
            "coordinates": {
               "latitude": 29.6898,
               "longitude": -95.5266,
            "exact": true
            },
            "mode": "location"
         },
         "created":{
            "utc":"2018-12-12 17:09:24",
            "local":{
               "date":"2018-12-12",
               "time":"10:09:24"
            }
         },
         "task_id":0,
         "status":"New"
      }
   ],
   "correlation_id":"cb928f12927792b26e271b2edbcfb876586cd05b",
   "actions":[
      "add"
   ]
}