Shipments

Create item

Add a new item to a package.

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

Request

Path parameters

shipmentIdstring required

Unique shipment identifier

Request body

packageIdstring nullable

Package ID this item belongs to

containerIdstring nullable

Container ID (optional)

lineNumberinteger

Line number for ordering

skustring

Stock Keeping Unit

partNumberstring

Part number

descriptionstring

Item description

quantityinteger

Quantity of items

unitOfMeasurestring

Unit of measure for quantity

unitPricenumber

Price per unit

amountnumber

Total amount

currencystring

Currency code

countryOfOriginstring

Country of origin code

hsCodestring

Harmonized System code

weightnumber

Weight per item

weightUnitstring

Unit for weight measurement

Response

Item created successfully

successboolean
messagestring

Example response

{
  "data": {
    "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.