Skip to main content

BaseShipping

The fields shared by order shippings and return shippings.

interface 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
id: ID
isoCountry: String
labels: [ShippingLabel!]
lastName: String
number: String
parcels: [ShippingParcel!]
province: String
status: ShippingStatus
telephone: String
trackingNumber: String
trackingUrl: String
updatedAt: ISO8601DateTime
warehouse: Warehouse
zipCode: String
}

Fields​

BaseShipping.address1 ● String scalar​

The street address.

BaseShipping.address2 ● String scalar​

A secondary address line.

BaseShipping.bookingStatus ● ShippingBookingStatus enum​

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

BaseShipping.carrier ● ShippingCarrier object​

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

BaseShipping.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.

BaseShipping.city ● String scalar​

The city.

BaseShipping.companyName ● String scalar​

The company name of the recipient.

BaseShipping.country ● String scalar​

The extended country name (for example Italy).

BaseShipping.createdAt ● ISO8601DateTime scalar​

When the record was created.

BaseShipping.email ● String scalar​

The email address of the recipient.

BaseShipping.events ● [ShippingEvent!] list object​

The tracking events received from the carrier.

BaseShipping.firstName ● String scalar​

The first name of the recipient.

BaseShipping.id ● ID scalar​

The unique identifier of the record.

BaseShipping.isoCountry ● String scalar​

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

BaseShipping.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.

BaseShipping.lastName ● String scalar​

The last name of the recipient.

BaseShipping.number ● String scalar​

The shipping number.

BaseShipping.parcels ● [ShippingParcel!] list object​

The parcels of the shipping.

BaseShipping.province ● String scalar​

The province.

BaseShipping.status ● ShippingStatus enum​

The carrier tracking state of the parcel. Null until the first tracking information is received from the carrier.

BaseShipping.telephone ● String scalar​

The telephone number of the recipient.

BaseShipping.trackingNumber ● String scalar​

The tracking code assigned by the carrier.

BaseShipping.trackingUrl ● String scalar​

The tracking URL on the carrier's website.

BaseShipping.updatedAt ● ISO8601DateTime scalar​

When the record was last updated.

BaseShipping.warehouse ● Warehouse object​

The warehouse the shipping is dispatched from.

BaseShipping.zipCode ● String scalar​

The postal code.

Implemented By​

RepaymentShipping object ● Shipping object