Interface CreateLabelOptions

Hierarchy

  • CreateLabelOptions

Properties

displayScheme? labelDownloadType? labelFormat? labelLayout? shipFromServicePointId? shipToServicePointId? validateAddress?

Properties

Optional displayScheme

displayScheme?: SE.LabelDisplayScheme

displayScheme is an optional string to control the display scheme of the label.

Optional labelDownloadType

labelDownloadType?: string

labelDownloadType is an optional string to control the download type of the label.

e.g. url or inline

Optional labelFormat

labelFormat?: string

labelFormat is an optional string to control the format of the label.

e.g. pdf or zpl

Optional labelLayout

labelLayout?: SE.LabelLayout

labelLayout is an optional string to control the layout of the label.

e.g. 4x6 or 8.5x11

Optional shipFromServicePointId

shipFromServicePointId?: string

A unique identifier for a carrier drop-off point where a merchant plans to deliver packages. This will take precedence over a shipment's Ship From address.

Optional shipToServicePointId

shipToServicePointId?: string

A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's Ship To address.

Optional validateAddress

validateAddress?: string

validateAddress is an optional string to control address validation during label purchase.

Settings

Member Visibility

Theme

Generated using TypeDoc