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 Identifiers. This includes
- One PRO, BILL_OF_LADING, CUSTOMER_REFERENCE, PICKUP, PURCHASE_ORDER, or EXTERNAL
- AND one CAPACITY_PROVIDER_ACCOUNT_CODE
- (Optional) one CAPACITY_PROVIDER_ACCOUNT_GROUP
Origin and Destination Stop Information

Workflow

Prepare a POST request to /api/v4/shipments/tracking.

{
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "string",
        "type": "ORIGIN",
        "location": {}
      },
      {
        "id": "string",
        "type": "DESTINATION",
        "location": {}
      }
    ]
  }
}

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

Send the request.

Fields and Objects

Element	Description	Type	Notes
`identifiers`	A list of the shipment's identifying information.	`array` of identifiers
`identifiers.type`	The type of shipment identifier.	`string`	Valid values include one `PRO`, `BILL_OF_LADING`, `CUSTOMER_REFERENCE`, `PICKUP`, `PURCHASE_ORDER`, or `EXTERNAL` AND one `CAPACITY_PROVIDER_ACCOUNT_CODE`. `CAPACITY_PROVIDER_ACCOUNT_GROUP` is an optional identifier.
`identifiers.value`	The value of the shipment identifier.	`string`
`routeInfo.stop`	An array of stop information.	`array` of `strings` and/or `integers`	Include stop information for the Origian and Destination. For more information on fields within this array, see the API Reference Documentation.

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"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "string",
        "type": "ORIGIN",
        "location": {}
      },
      {
        "id": "string",
        "type": "DESTINATION",
        "location": {}
      }
    ]
  }
}

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

Element	Description	Type	Notes
`id`	The shipment's master shipment ID.	`string`	The `id` will always be populated in the `POST` response.
`identifiers`	A list of the shipment's identifying information.	`array` of identifiers
`identifiers.type`	The type of shipment identifier.	`string`	Valid values include one `PRO`, `BILL_OF_LADING`, `CUSTOMER_REFERENCE`, `PICKUP`, `PURCHASE_ORDER`, or `EXTERNAL` AND one `CAPACITY_PROVIDER_ACCOUNT_CODE`. `CAPACITY_PROVIDER_ACCOUNT_GROUP` is an optional identifier.
`identifiers.value`	The value of the shipment identifier.	`string`
`routeInfo.stop`	An array of stop information.	`array` of `strings` and/or `integers`	Include stop information for the Origian and Destination. For more information on fields within this array, see the API Reference Documentation.

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

Requirements

To replace an existing shipment, have the following information:

Shipment Identifiers. This includes
- One PRO, BILL_OF_LADING, CUSTOMER_REFERENCE, PICKUP, PURCHASE_ORDER, or EXTERNAL
- AND one CAPACITY_PROVIDER_ACCOUNT_CODE
- (Optional) one CAPACITY_PROVIDER_ACCOUNT_GROUP
Origin and Destination Stop Information

Workflow

Prepare a PUT request to /api/v4/shipments/tracking.

{
  "id": "string",
  "identifiers": [
    {
      "type": "BILL_OF_LADING",
      "value": "string"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "string",
        "type": "ORIGIN",
        "location": {}
      },
      {
        "id": "string",
        "type": "DESTINATION",
        "location": {}
      }
    ]
  }
}

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

Send the request.

Fields and Objects

Element	Description	Type	Notes
`identifiers`	A list of the shipment's identifying information.	`array` of identifiers
`identifiers.type`	The type of shipment identifier.	`string`	Valid values include one `PRO`, `BILL_OF_LADING`, `CUSTOMER_REFERENCE`, `PICKUP`, `PURCHASE_ORDER`, or `EXTERNAL` AND one `CAPACITY_PROVIDER_ACCOUNT_CODE`. `CAPACITY_PROVIDER_ACCOUNT_GROUP` is an optional identifier.
`identifiers.value`	The value of the shipment identifier.	`string`
`routeInfo.stops`	An array of stop information.	`array` of `strings` and/or `integers`	Include stop information for the Origian and Destination. For more information on fields within this array, see the API Reference Documentation.

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"
    },
    {
      "type": "CAPACITY_PROVIDER_ACCOUNT_CODE",
      "value": "string"
    }
  ],
  "routeInfo": {
    "stops": [
      {
        "id": "string",
        "type": "ORIGIN",
        "location": {}
      },
      {
        "id": "string",
        "type": "DESTINATION",
        "location": {}
      }
    ]
  }
}

Fields and Objects

Element	Description	Type	Notes
`id`	The shipment's master shipment ID.	`string`	The `id` will always be populated in the `POST` response.
`identifiers`	A list of the shipment's identifying information.	`array` of identifiers
`identifiers.type`	The type of shipment identifier.	`string`	Valid values include one `PRO`, `BILL_OF_LADING`, `CUSTOMER_REFERENCE`, `PICKUP`, `PURCHASE_ORDER`, or `EXTERNAL` AND one `CAPACITY_PROVIDER_ACCOUNT_CODE`. `CAPACITY_PROVIDER_ACCOUNT_GROUP` is an optional identifier.
`identifiers.value`	The value of the shipment identifier.	`string`
`routeInfo.stop`	An array of stop information.	`array` of `strings` and/or `integers`	Include stop information for the Origian and Destination. For more information on fields within this array, see the API Reference Documentation.

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.

Update a Shipment

Add Information to an Existing Shipment

Requirements

Workflow

Expected System Response

Errors

Replace an Existing Shipment

Requirements

Workflow

Expected System Response

Errors

Was this helpful?