Skip to main content

Shipping

A shipping destination of an order: recipient address, carrier and tracking data, the three shipping statuses (carrier tracking, warehouse fulfilment, label booking), the item quantities dispatched, the parcels and the documents (shipping labels and proforma).

type Shipping implements BaseShipping {
address1: String
address2: String
bookingStatus: ShippingBookingStatus
carrier: ShippingCarrier
carrierName: String
city: String
companyName: String
country: String
createdAt: ISO8601DateTime
email: String
events: [ShippingEvent!]
firstName: String
fulfillmentPacking: FulfillmentPacking
fulfillmentStatus: ShippingFulfillmentStatus
id: ID
isoCountry: String
itemLines: [ShippingLine!]
labels: [ShippingLabel!]
lastName: String
lines: [ShippingLine!]
number: String
parcels: [ShippingParcel!]
proforma: AccountingOrderProforma
province: String
status: ShippingStatus
telephone: String
trackingNumber: String
trackingUrl: String
updatedAt: ISO8601DateTime
warehouse: Warehouse
zipCode: String
}

Fields​

Shipping.address1 ● String scalar​

The street address.

Shipping.address2 ● String scalar​

A secondary address line.

Shipping.bookingStatus ● ShippingBookingStatus enum​

The state of the shipping label (waybill) booking process. Null until the booking process starts.

Shipping.carrier ● ShippingCarrier object​

The carrier OMS assigned to the shipping, resolved from the shipping method submitted at import. Null until a carrier is assigned.

Shipping.carrierName ● String scalar​

The name of the assigned carrier, the same value as carrier.name, for reading it without selecting the carrier object. Null until a carrier is assigned.

Shipping.city ● String scalar​

The city.

Shipping.companyName ● String scalar​

The company name of the recipient.

Shipping.country ● String scalar​

The extended country name (for example Italy).

Shipping.createdAt ● ISO8601DateTime scalar​

When the record was created.

Shipping.email ● String scalar​

The email address of the recipient.

Shipping.events ● [ShippingEvent!] list object​

The tracking events of the shipping, received from the carrier or reported through the API by an external carrier, in the order they were recorded. Sort them by receivedAt for the order in which they occurred.

Shipping.firstName ● String scalar​

The first name of the recipient.

Shipping.fulfillmentPacking ● FulfillmentPacking object​

The packing declared by the warehouse when it confirmed the fulfilment (parcels and fulfilled quantities). Null until then, and after a cancelled fulfilment.

Shipping.fulfillmentStatus ● ShippingFulfillmentStatus enum​

How much of the shipping has been fulfilled by the warehouse. Fulfilment happens before carrier shipping (tracked by status).

Shipping.id ● ID scalar​

The unique identifier of the record.

Shipping.isoCountry ● String scalar​

The country, as an ISO 3166-1 alpha-2 code (for example IT).

Shipping.itemLines ● [ShippingLine!] list object​

The shipping lines of item order lines only — the goods a warehouse fulfils. Lines of other kinds (shipping charges, coupons…) are excluded: use this list when confirming the fulfilment.

Shipping.labels ● [ShippingLabel!] list object​

The waybills (shipping labels) of the shipping. A multi-parcel shipping may have one label per parcel or a single label for all of them, depending on the carrier.

Shipping.lastName ● String scalar​

The last name of the recipient.

Shipping.lines ● [ShippingLine!] list object​

The shipping lines: the item order line quantities dispatched by this shipping.

Shipping.number ● String scalar​

The shipping number.

Shipping.parcels ● [ShippingParcel!] list object​

The parcels of the shipping.

Shipping.proforma ● AccountingOrderProforma object​

The proforma of the shipping. A shipping has at most one proforma.

Shipping.province ● String scalar​

The province.

Shipping.status ● ShippingStatus enum​

The carrier tracking state of the parcel. Null until the first tracking information is received from the carrier (for example while the order is still being prepared and no shipping label has been generated yet).

Shipping.telephone ● String scalar​

The telephone number of the recipient.

Shipping.trackingNumber ● String scalar​

The tracking code assigned by the carrier.

Shipping.trackingUrl ● String scalar​

The tracking URL on the carrier's website.

Shipping.updatedAt ● ISO8601DateTime scalar​

When the record was last updated.

Shipping.warehouse ● Warehouse object​

The warehouse the shipping is dispatched from.

Shipping.zipCode ● String scalar​

The postal code.

Interfaces​

BaseShipping interface​

The fields shared by order shippings and return shippings.

Returned By​

shippingFulfillmentCancel mutation ● shippingTrackingSet mutation

Member Of​

FulfillmentPacking object ● Order object ● ShippingLine object