WOwove
Shipments

Create package

Add a new package to a shipment (either in a container or as a loose package).

post/api/v1/external/shipments/{shipmentId}/packages

Request

Path parameters

shipmentIdstring required

Unique shipment identifier

Request body

containerIdstring nullable

Container ID (null for loose packages)

packageNumberstring

Package number/identifier

packageTypestring

Type of package (e.g., CARTON, PALLET)

descriptionstring

Package description

packageCountinteger

Number of packages

lineNumberinteger

Line number for ordering

grossWeightnumber

Gross weight of package

netWeightnumber

Net weight of package

volumenumber

Volume of package

weightUnitstring

Unit for weight measurements

volumeUnitstring

Unit for volume measurements

Response

Package created successfully

successboolean
messagestring

Example response

{
  "data": {
    "id": "1014810279825727493",
    "packageNumber": "PKG001",
    "packageType": "CARTON",
    "packageCount": 1,
    "items": [
      {
        "id": "1014810279825727491",
        "lineNumber": 1,
        "sku": "SKU-12345",
        "partNumber": "PN-67890",
        "description": "Electronic Component",
        "quantity": 100,
        "unitOfMeasure": "PCS",
        "unitPrice": 25.5,
        "amount": 2550,
        "currency": "USD",
        "countryOfOrigin": "CN",
        "hsCode": "8541.10.00",
        "weight": 150.5,
        "weightUnit": "KG",
        "volume": 2.5,
        "volumeUnit": "CBM",
        "packageNumber": "PKG-001",
        "dimensions": {
          "length": 100,
          "width": 50,
          "height": 50,
          "unit": "CM"
        }
      }
    ]
  }
}

Changes

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