Interface Package

A package that is created to ship one or more of a shipment's line items.

interface Package {
    dimensions: PackageDimensions;
    hazmatLabels?: string[];
    id: string;
    packageHandlingRequirements?: PackagePackageHandlingRequirementsEnum;
    packageLineItems: PackageLineItem[];
    status?: PackageStatusEnum;
    weight: Weight;
}

Index

Properties

dimensions hazmatLabels? id packageHandlingRequirements? packageLineItems status? weight

Properties

dimensions

dimensions: PackageDimensions

`Optional`hazmatLabels

hazmatLabels?: string[]

The optional list of HAZMAT labels applied to the package.

id

id: string

An ID that uniquely identifies a package within a shipment.

`Optional`packageHandlingRequirements

packageHandlingRequirements?: PackagePackageHandlingRequirementsEnum

Whether the package requires standard handling or extra care.

packageLineItems

packageLineItems: PackageLineItem[]

The list of line items in a package.

`Optional`status

status?: PackageStatusEnum

The current status of the package.

weight

weight: Weight