createPackages

Provide details about the packages in the specified shipment.

Path Params
string
required

The ID of the shipment.

Body Params

A list of packages in the shipment.

packages
array of objects
required
length ≥ 1

A list of packages.

packages*
string
required

An ID that uniquely identifies a package within a shipment.

dimensions
object
required

The dimensions of a package.

weight
object
required

The weight of a package.

hazmatLabels
array of strings
length ≥ 0

The optional list of HAZMAT labels applied to the package.

hazmatLabels
packageLineItems
array of objects
required

The list of line items in a package.

packageLineItems*
string
enum

The current status of the package.

Show Details
CREATEDThe package is created.
PICKUP_SLOT_RETRIEVEDThe pickup slot is retrieved.
INVOICE_GENERATEDThe invoice is generated.
SHIPLABEL_GENERATEDThe shipping label is generated.
SHIPPEDThe package is shipped.
DELIVEREDThe package is delivered.
CANCELLEDThe shipment is cancelled.
Allowed:
string
enum

Whether the package requires standard handling or extra care.

Show Details
NORMALThe package requires standard handling.
FRAGILEThe package requires extra care in handling.
Allowed:
Responses

Language
Response
Choose an example:
application/json