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.

Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

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.

Supported Carriers and Tracking Numbers

The full list of carrier options that OMS supports are:

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 how to format tracking numbers for some of the most common carriers, but be aware that there may be some variations.

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.