KIBO OMS DOCUMENTATION

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.

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.

Example

This example will set a shipment’s tracking information based on the following properties:

• Shipment ID – 0123456
• Carrier Information – UPS, 1-2 days

Required Parameters

Setting and updating tracking information requires the following properties:

Optional Parameters

The two optional properties can be used to provide more details about the shipment if desired.

Tracking Information

Tracking Information is an object that requires a Tracking Number, but also has additional parameters:

Shipment Tracking Numbers

The tracking number formats that OMS supports are based on each carrier’s unique rules. If OMS cannot validate a tracking number based on its known rules, it will attempt to validate the number on the carrier’s system. The chart below describes the typical tracking numbers in OMS, but be aware that there may be some variations from the carriers.

The Full Request

This is the entire request that will update the shipment’s tracking information to the example details.

{ 
 "shipmentID":0123456,
 "sendEmails":false,
 "trackingInformation":[ 
     { 
       "trackingNumber":"1Z9999999999999999",
       "carrierType":"UPS",
       "transitTime":"1-2 Days"
     },
  ],
 "shipmentDate":"2014-08-28T10:12:00+08:00"
}

The returned response follows the same structure as the Get Shipment API, providing information about the shipment.