WOwove
Shipments

Update shipment information

Update shipment-level details only. To update containers, packages, or items, use the respective CRUD endpoints:

  • Containers: PUT /shipments/{shipmentId}/containers/{containerId}
  • Packages: PUT /shipments/{shipmentId}/packages/{packageId}
  • Items: PUT /shipments/{shipmentId}/items/{itemId}
put/api/v1/external/shipments/{shipmentId}/details

Request

Path parameters

shipmentIdstring required

Unique shipment identifier

Request body

Example request

{
  "shipment": {
    "invoiceDate": "2024-03-15",
    "dueDate": "2024-04-15",
    "issueDate": "2024-03-10",
    "shipmentDate": "2024-03-20",
    "expectedDeliveryDate": "2024-04-05",
    "readyDate": "2024-03-18",
    "dateOfSignature": "2024-03-10",
    "placeOfReceiptPort": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfReceiptAirport": {
      "airportCode": "LAX",
      "airportName": "Los Angeles International Airport",
      "countryCode": "US"
    },
    "placeOfReceiptAddress": {
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "placeOfDeliveryPort": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfDeliveryAirport": {
      "airportCode": "LAX",
      "airportName": "Los Angeles International Airport",
      "countryCode": "US"
    },
    "placeOfDeliveryAddress": {
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "referenceNumbers": [
      {
        "id": "1014810279825727493",
        "type": "booking",
        "displayNumber": "BOOK-2024-001",
        "cleanedNumber": "BOOK2024001"
      }
    ],
    "totalWeight": 1500.5,
    "weightUnit": "KG",
    "totalVolume": 25.5,
    "volumeUnit": "CBM",
    "totalPieces": 500,
    "totalPacks": 7,
    "totalPacksPackageType": "Pallets",
    "totalValue": 25000,
    "currency": "USD"
  }
}

Response

Shipment details updated successfully

successboolean
messagestring

Example response

{
  "data": {
    "creation": {
      "source": "email"
    },
    "emailUpdates": {
      "threads": 2
    },
    "sync": {
      "method": "manual",
      "status": "success",
      "syncedBy": {
        "name": "Jane Smith",
        "email": "jane@example.com"
      },
      "tmsReference": "C00012345"
    },
    "id": "1014810279825727490",
    "status": "draft",
    "name": "External API Test Shipment",
    "shipmentType": "LCL",
    "commodity": "Electronics",
    "portOfLoading": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "portOfDischarge": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfReceiptPort": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfReceiptAirport": {
      "airportCode": "LAX",
      "airportName": "Los Angeles International Airport",
      "countryCode": "US"
    },
    "placeOfReceiptAddress": {
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "placeOfDeliveryPort": {
      "portCode": "USLAX",
      "portName": "Los Angeles",
      "countryCode": "US"
    },
    "placeOfDeliveryAirport": {
      "airportCode": "LAX",
      "airportName": "Los Angeles International Airport",
      "countryCode": "US"
    },
    "placeOfDeliveryAddress": {
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "New York",
      "province": "NY",
      "postalCode": "10001",
      "country": "US"
    },
    "documentCount": 5,
    "carrier": {
      "code": "MAEU",
      "name": "Maersk Line"
    },
    "vessel": "MSC OSCAR",
    "voyage": "123W",
    "incoterm": "FOB",
    "serviceType": "CY-CY",
    "referenceNumbers": [
      {
        "id": "1014810279825727493",
        "type": "booking",
        "displayNumber": "BOOK-2024-001",
        "cleanedNumber": "BOOK2024001"
      }
    ]
  }
}

Changes

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