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.

Version2.0
Callhttps://integration.shopatron.com/api/v2/shipment/action/updateTracking
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/shipment/action/updateTracking.json

The .json address above can be used to access the schema within Postman. An example use of the Update Tracking Information API follows here — or go directly to 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:

ParameterTypeDescription
shipmentIDintegerA unique identifier for the shipment. The minimum value is "1".
trackingInformationarrayThe tracking information for the shipment.
sendEmailsbooleanShould emails be sent? The default value is "true".

Optional Parameters

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

ParameterTypeDescription
shipmentDatestringThe shipment date. Supports date-time format.
externalShipmentIDstringAn externally defined shipment reference identifier.

Tracking Information

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

ParameterTypeDescription
trackingNumberstringThe shipment’s tracking number. The maximum length is 50.
deliveryTypestringThe shipment’s shipping method.
carrierTypeenumThe carrier (USPS, FedEx, etc.) delivering the shipment. See the schema for a full list of possible values.
carrierTypeOtherstringThe carrier’s name if it is not one of Kibo’s listed carriers. The maximum length is 20.
transitTimestringThe time the shipment is expected to be in transit. The maximum length is 50.
trackingURLstringThe 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.

{ 
 "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.


Megan MayfieldOMS Dev: Update Tracking Information