Shipment: Tracking

Initialize a shipment for tracking, or replace data for an existing shipment.

If the shipment does not exist, this will create a new shipment.

If the shipment is already being tracked (and the corresponding id field is provided), this operation will <b>fully replace</b> user provided data.Note: This modifies only data that the <b>user has provided</b>.

In addition, if a change occurs through this endpoint that makes a shipment no longer trackable via some source (AIR, OCEAN, RAIL, etc.) then previously received data from that source will be removed.For example, if a user creates a shipment via an AIR identifier (AIR_WAYBILL) and subsequently uses this endpoint to update the same shipment, replacing the AIR identifier with an OCEAN identifier, then any AIR data is expected to be removed from the shipment, as it is no longer tracking via AIR.

<h4><b>Important Notes:</b></h4><ul><li>Only the following identifier types are accepted when creating or updating a shipment:<ul><li>Air</li><ul><li>AIR_WAYBILL</li><li>HOUSE_AIR_WAYBILL - an additional, valid CARRIER_SCAC identifier is mandatory for HOUSE_AIR_WAYBILL tracking</li><li>CARRIER_SCAC</li></ul><li>European Rail</li><ul><li>WAGON_ID</li><li>TRAIN_NUMBER</li></ul><li>North American Rail</li><ul><li>CONTAINER_ID</li><li>TRAILER_ID</li><li>RAIL_CAR_ID</li><li>BILL_OF_LADING</li><li>WAYBILL</li></ul><li>Ocean</li><ul><li>BILL_OF_LADING</li><li>BOOKING_NUMBER</li><li>CARRIER_SCAC</li><li>CONTAINER_ID</li></ul><li>Parcel</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>TRACKING_NUMBER</li><li>CARRIER_SCAC</li></ul><li>LTL</li><ul><li>CAPACITY_PROVIDER_ACCOUNT_GROUP</li><li>CAPACITY_PROVIDER_ACCOUNT_CODE</li><li>PRO_NUMBER</li><li>BILL_OF_LADING</li><li>PICKUP</li><li>PURCHASE_ORDER</li></ul></ul></li></ul><h4><b>Required Fields</h4></b> <ul><li><b> identifiers: </b> (at least one) </li><ul><li> type </li><li> value </li></ul></ul>
put/api/v4/shipments/tracking

Request

Request body

createdDateTimestring date-time

The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.

idstring uuid

Master shipment id of the shipment. Will always be populated on the response.

lastModifiedDateTimestring date-time

The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.

shipmentShareLinkstring

Public link to view the shipment in the VOC.

Response

OK

createdDateTimestring date-time

The date and time when this shipment was created. This value is read only and will be ignored during shipment creation.

idstring uuid

Master shipment id of the shipment. Will always be populated on the response.

lastModifiedDateTimestring date-time

The date and time when this shipment was last modified. This value is read only and will be ignored during shipment creation or modification.

shipmentShareLinkstring

Public link to view the shipment in the VOC.

Changes

No recorded changes to this operation across all 1 revision of this API.