Submit Documentation FeedbackJoin Developer CommunityLog In

Shipment tracking

This topic describes how to track shipments.


B2B Commerce Cloud provides an option to display shipment/order tracking information both on the website and in the Admin Console. Displaying this information requires data to exist within the Shipment database tables. Use the information in this article to enable this functionality.

Examples when tracking is enabled

This screen capture shows how the tracking information is displayed on the website within the Order Details section of My Account.

To view the data within the Admin Console, go to Sales > Order History, click View Only for an order and scroll to the Shipping Details section under the Order Lines.


To see these views, data must exist in the Shipment and ShipmentPackage tables. The ShipmentPackageLines table is an optional table to provide details of products that are within each shipment package.

Shipment refreshes are required to integrate data between B2B Commerce Cloud and the ERP.

For testing purposes, populate the Shipment tables to view shipment information in the Admin Console or website. The following queries can be used to populate some test data into the database:

//This adds a shipment
INSERT INTO [dbo].[Shipment]
           ,'WEB001001' //This web order or ERP order number should be an existing web or ERP order. The ERPOrderNumber column can also be used instead. 
//This adds a shipment package related to a shipment
INSERT INTO [dbo].[ShipmentPackage]
           ,[Carrier] //The value entered in this field needs to match the Name field for a Carrier. //These require specific values. See below
           ('F478E1A3-DC88-E711-9487-80000B2CEBFA' //relative to the Shipment Id

Carriers require specific values to populate the base link for the tracking number.

The following Carrier values will use the links below, as they are hard-coded into the platform:

When using one of the conventional carriers above this will create an Application Setting TrackingUrl_UseCustomUrls set to False

If TrackingUrl_UseCustomUrls is set to True, then you have the ability to use custom links.

You can add an Application Setting for each carrier with this format

Application SettingValue
TrackingUrl_[carrier]URL + [tracking number]

For example, if you set the record to have a Carrier with the value of "truck", then your Application Setting should be set to something similar to what's shown below:

Application SettingValue
TrackingUrl_truckhttp://www.mytesttruck.com?package=\[tracking number]

It is important to include "[tracking number]" in the URL for the actual tracking number to be replaced in the URL.

Once these generic records are created, you can log in as the respective customer/user and see the shipment information in the Order History detail of an order.

The Carrier names listed in the table below are examples only. The only requirement is that a Carrier name in the Name field within the Admin Console must match the value entered in the Carrier field in the ShipmentPackage table (referenced above).

If a matching tracking number is not found, the tracking number will not be hyperlinked.

Did this page help you?