Skip to main content

Shipping

Permission required: shipping:read

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 of the shipping.

Shipping.carrierName ● String scalar​

The name of the carrier.

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 received from the carrier.

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: one label per parcel, so a multi-parcel shipping has multiple labels.

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​

Normalized to the 00 international notation at import (for example +390212345678 is stored as 00390212345678).

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​

Returned By​

shippingFulfillmentCancel mutation

Member Of​

FulfillmentPacking object ● Order object ● ShippingLine object