Interface Package

A package to be shipped through a shipping service offering.

Export

Package

interface Package {
    charges?: ChargeComponent[];
    dimensions: Dimensions;
    insuredValue: Currency;
    isHazmat?: boolean;
    items: Item[];
    packageClientReferenceId: string;
    sellerDisplayName?: string;
    weight: Weight;
}

Properties

charges? dimensions insuredValue isHazmat? items packageClientReferenceId sellerDisplayName? weight

Properties

Optionalcharges

charges?: ChargeComponent[]

A list of charges based on the shipping service charges applied on a package.

Memberof

Package

dimensions

dimensions: Dimensions

Memberof

Package

insuredValue

insuredValue: Currency

Memberof

Package

OptionalisHazmat

isHazmat?: boolean

When true, the package contains hazardous materials. Defaults to false.

Memberof

Package

items

items: Item[]

A list of items.

Memberof

Package

packageClientReferenceId

packageClientReferenceId: string

A client provided unique identifier for a package being shipped. This value should be saved by the client to pass as a parameter to the getShipmentDocuments operation.

Memberof

Package

OptionalsellerDisplayName

sellerDisplayName?: string

The seller name displayed on the label.

Memberof

Package

weight

weight: Weight

Memberof

Package

Settings

Member Visibility

On This Page

Properties