Last updated

Update a Drayage Visibility Shipment

Updating shipments with Drayage Visibility follows the standard ocean shipment update process based on your original shipment type:

You can add identifiers, modify attributes, or add events using the same API endpoints and workflows for your shipment type.

All update operations available for standard ocean shipments are also available for Drayage Visibility shipments. The enhanced drayage tracking will continue to be provided automatically.

Update Methods

Drayage Visibility supports all the same update methods as standard ocean tracking:

1. Adding Drayage Carrier to Existing Shipment

Add Identifiers - Append drayage carrier identifiers like IMPORT_DRAYAGE_CARRIER_SCAC to an existing shipment through a POST request. This enables drayage tracking for shipments that were initially created without drayage visibility.

2. Updating Drayage Carrier Information

Update Carrier Information - Modify existing drayage carrier identifiers by sending a POST request with the updated IMPORT_DRAYAGE_CARRIER_SCAC value. This allows changing drayage providers or correcting carrier information.

API Endpoints

All updates use the same API endpoints as standard ocean shipments:

  • POST /api/v4/shipments/tracking - Add information to existing shipment
  • PUT /api/v4/shipments/tracking - Replace existing shipment
  • GET /api/v4/shipments/tracking/{id} - Retrieve current shipment data

Update Examples

Adding Drayage Carrier to Existing Shipment

Add import drayage carrier information to a shipment that was initially created without drayage tracking:

{
  "id": "2b1911da-d58c-4f1a-8c6b-55dc1e06df39",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "213953651"
    },
    {
      "type": "CARRIER_SCAC",
      "value": "MSCU"
    },
    {
      "type": "IMPORT_DRAYAGE_CARRIER_SCAC",
      "value": "ITSO"
    }
  ]
}

Updating Drayage Carrier Information

Change an existing drayage carrier to a different provider:

{
  "id": "2b1911da-d58c-4f1a-8c6b-55dc1e06df39",
  "identifiers": [
    {
      "type": "CONTAINER_ID",
      "value": "MATU2284241"
    },
    {
      "type": "IMPORT_DRAYAGE_CARRIER_SCAC",
      "value": "NEW_DRAYAGE_SCAC"
    }
  ]
}

Adding Multiple Drayage Identifiers

Add different drayage carriers for different legs (when supported):

{
  "id": "2b1911da-d58c-4f1a-8c6b-55dc1e06df39",
  "identifiers": [
    {
      "type": "CONTAINER_ID",
      "value": "MATU2284241"
    },
    {
      "type": "IMPORT_DRAYAGE_CARRIER_SCAC",
      "value": "ITSO"
    },
    {
      "type": "EXPORT_DRAYAGE_CARRIER_SCAC",
      "value": "ITSB"
    }
  ]
}

Currently only IMPORT_DRAYAGE_CARRIER_SCAC provides active tracking. EXPORT_DRAYAGE_CARRIER_SCAC is for future export drayage support.

The response will include the updated identifiers, and if the container reaches the Port of Discharge or last rail terminal, enhanced drayage tracking will automatically be applied.

Error Handling

Error handling follows the same pattern as standard ocean shipments:

  • 400 Invalid request
  • 401 Invalid or missing credentials
  • 403 User not authorized to perform this operation

See Error Response Codes for more information.

For complete information on all update workflows and examples, refer to the Ocean Port to Port update guide. All workflows apply to Drayage Visibility tracking.