Update Shipment

PATCHhttps://api.cargopanel.co/v1/shipments/{shipmentId}

PATCHhttps://sandbox-api.cargopanel.co/v1/shipments/{shipmentId}

Update an existing shipment's package and content information.

This API requires a contract. Get in touch with cargopanel Support Team.

Request Fields

packagesarrayoptional

Update the package details of the shipment. Each package object can include:

quantity - Number of pieces (number)
weight - Weight (number)
dimensions.width - Width (number)
dimensions.length - Length (number)
dimensions.height - Height (number)

itemsarrayoptional

Update the content (line items) of the shipment. Each item must include:

description - Item description (string)
hsCode - HS code (string)
countryOfOrigin - Origin country (string)
quantity - Quantity (number)
unitPrice - Unit price (number)
totalPrice - Total price (number)

Request Body

The request body should be a JSON object containing only the fields you wish to update:

{
  "packages": [
    {
      "quantity": <number>,
      "weight": <number>,
      "dimensions": {
        "width": <number>,
        "length": <number>,
        "height": <number>
      }
    }
  ]
}

Example Response

200

{
  "packages": [
    {
      "quantity": 1,
      "weight": 1,
      "dimensions": {
        "width": 10,
        "length": 10,
        "height": 10
      }
    }
  ]
}

Responses

200Shipment successfully updated

400Invalid request (missing or incorrect parameters)

401Unauthorized (invalid or missing token)

404Shipment not found

422Validation error (submitted data is not valid)

500Internal server error

Create Shipment

Cancel Shipment