Interface OrderInfo

Extra information and requests for the shipment

interface OrderInfo {
    carrier_dependent?: null | CarrierDependentOrderInfo;
    carrier_specific?: null | CarrierSpecificOrderInfo;
    reference_numbers?: null | GraphqlList<ReferenceNumber>;
    tracking_subscriptions?: null | GraphqlList<Trackingsubscription>;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

carrier_dependent? carrier_specific? reference_numbers? tracking_subscriptions?

Properties

Optionalcarrier_dependent

carrier_dependent?: null | CarrierDependentOrderInfo

Information that carriers may or may not ignore, but which aren't specific to any one carrier.

Optionalcarrier_specific

carrier_specific?: null | CarrierSpecificOrderInfo

Information that only specific carriers use

Optionalreference_numbers

reference_numbers?: null | GraphqlList<ReferenceNumber>

Reference numbers for identifying the shipment with other external ids

Warning

Some carriers limit the number of reference number that can be associated with a shipment.

If the carrier has this limit, numbers specified first receive priority. The same goes for reference numbers printed on the label.

Optionaltracking_subscriptions

tracking_subscriptions?: null | GraphqlList<Trackingsubscription>

Requests to send notifications about tracking updates

Settings

Member Visibility

On This Page

Properties