A created shipping label.

Type Parameters

Hierarchy (View Summary)

Implements

Properties

__typename: "DomesticLabel" = ...

A typename that can be used as a typeguard if preferred over isinstance

account_number: null | string

The carrier account being used for the shipment

If null, a Shipgenius-provided account was used. Otherwise, your own account was used.

base_price: `${number}`

The price for the shipment before extras and fees.

billing_weight: number

The billed weight of the package.

This is the greater of the package's physical weight and its dimensional weight.

carrier: CarrierName

The carrier who is accepting the shipment

carrier_specific: JsonObject

Carrier-specific extra fields with metadata about the shipment

disclaimers: string[]

Disclaimers issued by the carrier about the shipment

estimated_delivery: null | string

An ISO date specifying the expected delivery date

See getEstimatedDeliveryDate for this value in other representations.

guaranteed_delivery: null | boolean

Whether the carrier is offering a guarntee on their delivery date

id: string

The id of the label in the Shipgenius OMS database.

Can be used in ShipmentIdentifier.labelgenius_id

itemized_charges: ItemizedCharge[]

An itemized list of charges for the label

label: Format extends NONE ? null : LabelImage<Format>

An image of the label

Note

Fields here are dependent on what was selected as the label format in the call to fetch the label.

By default, no label image is returned and this field is null.

label_uuid: string

The UUID that can be used to find the label in the /media endpoints

labelgenius_charge: `${number}`

The amount charged by Shipgenius for the label.

Includes card fees, but does not include fees charged directly by carriers when using your own carrier account.

Tip

If you want the total price including what you're being charged by the carrier on your own account, see total_price

service_code: string

The carrier service being used for the shipment

shipment_id: string

The ID of the shipment in the carrier's system.

For most carriers, this is the same value as the tracking number.

total_price: `${number}`

The total price for the shipment after extras, but not including card fees.

Tip

This is the total price for the shipment including charges from both the carrier and from Shipgenius.

If you're looking for the price being charged by Shipgenius including card fees, see labelgenius_charge

tracking_number: string

The tracking number for the shipment

transaction_id: string

The UUID of the label-creation transaction.

Can be used with recoverLabel to recover the label if the label data is lost.

warnings: CarrierWarning[]

A list of warnings the carrier issued about the shipment

Methods