Update Tracking Information
The tracking information of a shipment can be added and updated with one API that accepts the same structure for each task. This information can not only include the tracking number for the package, but also properties such as the carrier details, transit time, a URL to the tracking page, and more.
See the chart in the OMS Standards guide for details about formatting tracking numbers.
The .json address above can be used to access the schema within Postman. An example use of the Update Tracking Information API follows below, or view the schema or the sample Postman Collection.
This example will set a shipment’s tracking information based on the following properties:
- Shipment ID – 0123456
- Carrier Information – UPS, 1-2 days
Setting and updating tracking information requires the following properties:
|shipmentID||integer||A unique identifier for the shipment. The minimum value is "1".|
|trackingInformation||array||The tracking information for the shipment.|
|sendEmails||boolean||Should emails be sent? The default value is "true".|
The two optional properties can be used to provide more details about the shipment if desired.
|shipmentDate||string||The shipment date. Supports date-time format.|
|externalShipmentID||string||An externally defined shipment reference identifier.|
Tracking Information is an object that requires a Tracking Number, but also has additional parameters:
|trackingNumber||string||The shipment’s tracking number. The maximum length is 50.|
|deliveryType||string||The shipment’s shipping method.|
|carrierType||enum||The carrier (USPS, FedEx, etc.) delivering the shipment. See the schema for a full list of possible values.|
|carrierTypeOther||string||The carrier’s name if it is not one of Kibo’s listed carriers. The maximum length is 20.|
|transitTime||string||The time the shipment is expected to be in transit. The maximum length is 50.|
|trackingURL||string||The URL to track the shipment. The maximum length is 400.|
The Full Request
This is the entire request that will update the shipment’s tracking information to the example details.
The returned response follows the same structure as the Get Shipment API, providing information about the shipment.