Interface DomesticLabelInterface<Format>Internal

Interface version of DomesticLabel

interface DomesticLabelInterface<Format extends LabelFormat = NONE> {
    __typename: "DomesticLabel";
    account_number: null | string;
    base_price: `${number}`;
    billing_weight: number;
    carrier: CarrierName;
    carrier_specific: JsonObject;
    disclaimers: string[];
    estimated_delivery: null | string;
    guaranteed_delivery: null | boolean;
    id: string;
    itemized_charges: ItemizedChargeInterface[];
    label: Format extends NONE ? null : LabelImageInterface<Format>;
    label_uuid: string;
    labelgenius_charge: `${number}`;
    service_code: string;
    shipment_id: string;
    total_price: `${number}`;
    tracking_number: string;
    transaction_id: string;
    warnings: CarrierWarningInterface[];
}

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

__typename account_number base_price billing_weight carrier carrier_specific disclaimers estimated_delivery guaranteed_delivery id itemized_charges label label_uuid labelgenius_charge service_code shipment_id total_price tracking_number transaction_id warnings

Properties

__typename

__typename: "DomesticLabel"

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

Readonlyaccount_number

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.

Readonlybase_price

base_price: `${number}`

The price for the shipment before extras and fees.

Readonlybilling_weight

billing_weight: number

The billed weight of the package.

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

Readonlycarrier

carrier: CarrierName

The carrier who is accepting the shipment

Readonlycarrier_specific

carrier_specific: JsonObject

Carrier-specific extra fields with metadata about the shipment

Readonlydisclaimers

disclaimers: string[]

Disclaimers issued by the carrier about the shipment

Readonlyestimated_delivery

estimated_delivery: null | string

An ISO date specifying the expected delivery date

See getEstimatedDeliveryDate for this value in other representations.

Readonlyguaranteed_delivery

guaranteed_delivery: null | boolean

Whether the carrier is offering a guarntee on their delivery date

Readonlyid

id: string

The id of the label in the Shipgenius OMS database.

Can be used in ShipmentIdentifier.labelgenius_id

Readonlyitemized_charges

itemized_charges: ItemizedChargeInterface[]

An itemized list of charges for the label

Readonlylabel

label: Format extends NONE ? null : LabelImageInterface<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.

Readonlylabel_uuid

label_uuid: string

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

Readonlylabelgenius_charge

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

Readonlyservice_code

service_code: string

The carrier service being used for the shipment

Readonlyshipment_id

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.

Readonlytotal_price

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

Readonlytracking_number

tracking_number: string

The tracking number for the shipment

Readonlytransaction_id

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.

Readonlywarnings

warnings: CarrierWarningInterface[]

A list of warnings the carrier issued about the shipment

Settings

Member Visibility

On This Page

Properties