Interface ShipmentIdentifierOptionInternal

An ID for the shipment

Tip

This maps to an input with a GraphQL @oneOf directive.

This means you have to specify exactly one of the keys:

interface ShipmentIdentifierOption {
    dhl_package_id: string;
    labelgenius_id: string;
    shipment_id: string;
    tracking_number: string;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

dhl_package_id labelgenius_id shipment_id tracking_number

Properties

dhl_package_id

dhl_package_id: string

Only applicable to DHL packages.

The package id printed on the label

labelgenius_id

labelgenius_id: string

The ID of the shipment in the Shipgenius OMS database

This value is returned in DomesticLabel.id

shipment_id

shipment_id: string

The shipment id, if supported by the carrier.

If not supported by the carrier, this is the same as the tracking number

tracking_number

tracking_number: string

The tracking number assigned to the shipment by the carrier

Settings

Member Visibility

On This Page

Properties