Interface ReferenceNumber

A reference number connecting a shipment to an external id

interface ReferenceNumber {
    number: string;
    print?: boolean;
    [field_name: string]: undefined | JsonValue;
}

Hierarchy (View Summary)

Indexable

Properties

number print?

Properties

number

number: string

The reference number to associate with the shipment

Optionalprint

print?: boolean

Whether to print the reference number on the label.

If the carrier limits how many references numbers can be printed on the label, the first reference numbers specified will be given priority.

Caution

Do not use this field to hide sensitive information.

This does not guarantee the presence or absence of a reference number on the label.

Some carriers do not have an option to prevent reference numbers from being displayed on the label, and some carriers do not have an option to display reference numbers on a the label at all.

Default

true

Settings

Member Visibility

On This Page

Properties