KIBO OMS DOCUMENTATION

Fulfill Shipment

The Fulfill Shipment action ID will set the initial tracking information when all items in the shipment have been shipped. This will also put the shipment in the final completePackage state.

The .json address above can be used to access the schema within Postman. An example use of the Fulfill Shipment API follows below, or view the schema or the sample Postman Collection.

Example

The example case will fulfill a shipment with the following properties:

• Shipment ID – 090909
• Carrier Information – UPS, 1-2 days
• Tracking Information – Tracking Number 0123456789

Required Parameters

Fulfilling a shipment requires:

Optional Parameters

There is only one optional property:

Tracking Information

The tracking information (/trackingInformation/[object]) for a shipment includes the following parameters, but only requires trackingNumber.

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 fulfill a shipment.

{
    "shipmentID": 090909, 
    "sendEmails":true, 
    "trackingInformation": [ 
     { 
        "trackingNumber": 0123456789, 
        "carrierType": "UPS", 
        "transitTime": "1-2 Days"
     } 
    ], 
    "shipmentDate": "2017-09-08T17:09:03+00:00"
}

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