Skip to main content
objectDeliveryPackage

Fields

id
ID!

The ID of the package.

deliveryNoteId
ID!

The delivery note of the package.

salesOrderId
ID!

The sales order of the delivery note.

shippingMethodId
ID

The shipping method. Absent when none is set.

weight
Decimal!

The weight in kilograms.

trackingNumber
String

The tracking number of the carrier.

trackingUrl
String

The tracking link, built from the tracking link template of the shipping method, the tracking number, the shipping date and the postal code of the delivery address. Absent when one of them is missing. Computed.

isShipped
Boolean!

Whether the package has a shipping date. Computed.

shippedAt
DateTime

When the package was shipped.

packedAt
DateTime!

When the package was created (packed).

expectedDeliveryDate
DateTime

The expected delivery date reported by the carrier.

note
String

A free note on the package.

carrierName
String

The name of the carrier.

shipmentReference
String

The reference of the shipment at the shipping service.

enclosedReturnTrackingNumber
String

The tracking number of a return label enclosed in the package.

returnShippingMethodId
ID

The shipping method of the enclosed return label.

transferStatus

Result of the last transfer of the package to a shipping service.

hasShippingLabel
Boolean!

Whether a shipping label document is stored for the package. Computed.

trackingState
String

The current tracking state key when the package is registered for tracking, for example Delivered. See GetPackageTrackingByPackageId.