ShippingLabel Object

Description

Shipping label purchased from the carrier aggregator (Sendcloud/Shippo).

Declaration

type ShippingLabel {
    provider: String
    shipmentId: String
    parcelId: String
    trackingNumber: String
    url: String
    panelUrl: String
    method: String
    carrier: String
    customsDocUrl: String
}

Fields

Name	Type	Description
provider	String	Aggregator the label was bought from. Valid values are "sendcloud" or "shippo".
shipmentId	String	Provider-side shipment identifier.
parcelId	String	Provider-side parcel identifier (used to fetch parcel documents).
trackingNumber	String	Carrier tracking number for the parcel.
url	String	URL to download the label document (PDF).
panelUrl	String	Deep link to the parcel in the provider's panel.
method	String	Friendly name of the service the label was bought with (may differ from the checkout method).
carrier	String	Carrier name (e.g. "PostNL", "Colissimo").
customsDocUrl	String	URL to download the customs document (CN23 / commercial invoice) for international shipments.