Last updated

Update a Shipment

Updating a shipment includes either

  • Adding information to an existing shipment through a POST request.
  • Fully replacing a shipment through a PUT request.

Add Information to an Existing Shipment

Requirements

To add information to an existing shipment, have the following information:

  • Shipment ID (European Rail Identifiers: WAGON_ID, TRAIN_NUMBER; North American Rail Identifiers: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID, BILL_OF_LADING, WAYBILL)
  • New shipment information

Workflow

  1. Prepare a POST request to /api/v4/shipments/tracking.
  2. Send the request.

Fields and Objects

ElementDescriptionTypeNotes
identifiersA list of the shipment's identifying information.array of identifiers
identifiers.typeThe type of shipment identifier.stringValid values for European Rail identifiers include: WAGON_ID, TRAIN_NUMBER. Valid values for North American Rail identifiers include: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID, BILL_OF_LADING, WAYBILL.
identifiers.valueThe value of the shipment identifier.string

Expected System Response

You have successfully submitted the request when you receive a 200 OK response.

{
  "id": "string",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    }
  ]
}

This is an example of what could be returned in the response. Null fields will not show up in the response. Please refer to the API Reference documentation for more information on required and potential null fields.

Fields and Objects

ElementDescriptionTypeNotes
idThe shipment's master shipment ID.stringThe id will always be populated in the POST response.
identifiersA list of the shipment's identifying information.array of identifiers
identifiers.typeThe type of shipment identifier.stringValid values for European Rail identifiers include: WAGON_ID, TRAIN_NUMBER. Valid values for North American Rail identifiers include: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID, BILL_OF_LADING, WAYBILL.
identifiers.valueThe value of the shipment identifier.string

Errors

If there was a problem with your request, you will receive one of the following error codes

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

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Replace an Existing Shipment

Fully replace an existing shipment.

Requirements

To add information to an existing shipment, have the following information:

  • Shipment ID (European Rail Identifiers: WAGON_ID, TRAIN_NUMBER; North American Rail Identifiers: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID, BILL_OF_LADING, WAYBILL)

Workflow

  1. Prepare a PUT request to /api/v4/shipments/tracking.
{
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    }
  ]
}

This only shows the minimum required request schema to create a rail shipment. To view the full request schema, see the API Reference documentation for this endpoint.

  1. Send the request.

Fields and Objects

ElementDescriptionTypeNotes
identifiersA list of the shipment's identifying information.array of identifiers
identifiers.typeThe type of shipment identifier.stringValid values for European Rail identifiers include: WAGON_ID, TRAIN_NUMBER. Valid values for North American Rail identifiers include: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID, BILL_OF_LADING, WAYBILL.
identifiers.valueThe value of the shipment identifier.string

Expected System Response

You have successfully submitted the request when you receive a 200 OK response.

{
  "id": "string",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    }
  ]
}

This is an example of what could be returned in the response. Null fields will not show up in the response. Please refer to the API Reference documentation for more information on required and potential null fields.

Fields and Objects

ElementDescriptionTypeNotes
idThe shipment's master shipment ID.stringThe id will always be populated in the POST response.
identifiersA list of the shipment's identifying information.array of identifiers
identifiers.typeThe type of shipment identifier.stringValid values for European Rail identifiers include: WAGON_ID, TRAIN_NUMBER. Valid values for North American Rail identifiers include: CONTAINER_ID, TRAILER_ID, RAIL_CAR_ID, BILL_OF_LADING, WAYBILL.
identifiers.valueThe value of the shipment identifier.string

Errors

If there was a problem with your request, you will receive one of the following error codes

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

See Error Response Codes in the Appendix for more information on the meaning of these error codes.

Previous page
Next page