Interface LabelCreationInput

Information needed to specify a shipment to be made

interface LabelCreationInput {
    additional?: null | AdditionalDomesticInfoInput;
    carrier_specific?: null | LabelCarrierInput;
    order_info?: null | OrderInfo;
    override_service?: null | CarrierServiceLabelInput;
    package: DomesticPackageLabelInput;
    transaction_id: string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

additional? carrier_specific? order_info? override_service? package transaction_id

Properties

Optionaladditional

additional?: null | AdditionalDomesticInfoInput

Additional information about the package

Optionalcarrier_specific

carrier_specific?: null | LabelCarrierInput

Shipment information only needed/supported by specific carriers

Optionalorder_info

order_info?: null | OrderInfo

Additional information and requests for the shipment

Optionaloverride_service

override_service?: null | CarrierServiceLabelInput

Use a different service for this shipment than what was specified for the batch

Required if no service was specified for the batch

package

package: DomesticPackageLabelInput

The package to be shipped

transaction_id

transaction_id: string

A UUID that uniquely identifies this shipment.

This ID can be used in ShipGeniusOmsClient.recoverLabel to recover the label if the label is lost in the transaction.

Warning

This ID must be a UUID and must be unique. If either of these assumptions are not met, and error will be returned.

You can use crypto.randomUUID to generate UUIDs

Settings

Member Visibility

On This Page

Properties