Skip to main content

OrderDelivery

A delivery of an Order: the shipping method, shipping address, shipping costs and delivery state. Most orders have exactly one; the order's deliveryState and trackingCodes are read from its primary delivery.

type OrderDelivery implements Node {
id: ID!
createdAt: DateTime!
orderId: ID!
shippingAdditionalAddressLine1: String
shippingAdditionalAddressLine2: String
shippingCity: String
shippingCompany: String
shippingCosts: JSON
shippingCountryId: ID
shippingDateEarliest: DateTime!
shippingDateLatest: DateTime!
shippingDepartment: String
shippingFirstName: String
shippingLastName: String
shippingMethodId: ID!
shippingPhoneNumber: String
shippingSalutationId: ID
shippingStreet: String
shippingTitle: String
shippingZipcode: String
state: String!
trackingCodes: JSON!
updatedAt: DateTime
order: Order
primaryOrder: Order
shippingMethod: ShippingMethod
}

Fields​

OrderDelivery.id ● ID! non-null scalar​

Global identifier for this entity.

OrderDelivery.createdAt ● DateTime! non-null scalar​

Timestamp the delivery was created.

OrderDelivery.orderId ● ID! non-null scalar​

ID of the order the delivery belongs to.

OrderDelivery.shippingAdditionalAddressLine1 ● String scalar​

First additional address line of the shipping address.

OrderDelivery.shippingAdditionalAddressLine2 ● String scalar​

Second additional address line of the shipping address.

OrderDelivery.shippingCity ● String scalar​

City of the shipping address.

OrderDelivery.shippingCompany ● String scalar​

Company on the shipping address.

OrderDelivery.shippingCosts ● JSON scalar​

Shipping costs of the delivery in the order's currency, as a JSON object with unitPrice, quantity, totalPrice, calculatedTaxes and taxRules.

OrderDelivery.shippingCountryId ● ID scalar​

ID of the country of the shipping address.

OrderDelivery.shippingDateEarliest ● DateTime! non-null scalar​

Earliest date the delivery is expected to ship.

OrderDelivery.shippingDateLatest ● DateTime! non-null scalar​

Latest date the delivery is expected to ship.

OrderDelivery.shippingDepartment ● String scalar​

Department on the shipping address.

OrderDelivery.shippingFirstName ● String scalar​

First name on the shipping address.

OrderDelivery.shippingLastName ● String scalar​

Last name on the shipping address.

OrderDelivery.shippingMethodId ● ID! non-null scalar​

ID of the shipping method of the delivery.

OrderDelivery.shippingPhoneNumber ● String scalar​

Phone number on the shipping address.

OrderDelivery.shippingSalutationId ● ID scalar​

ID of the salutation on the shipping address.

OrderDelivery.shippingStreet ● String scalar​

Street and house number of the shipping address.

OrderDelivery.shippingTitle ● String scalar​

Academic or honorific title on the shipping address (e.g. Dr.).

OrderDelivery.shippingZipcode ● String scalar​

Postal code of the shipping address.

OrderDelivery.state ● String! non-null scalar​

Name of the delivery's state (e.g. open, shipped, shipped_partially, returned, cancelled). Filterable.

OrderDelivery.trackingCodes ● JSON! non-null scalar​

Tracking codes of the delivery, as a JSON array of strings.

OrderDelivery.updatedAt ● DateTime scalar​

Timestamp of the last update to the delivery.

OrderDelivery.order ● Order object​

OrderDelivery.primaryOrder ● Order object​

OrderDelivery.shippingMethod ● ShippingMethod object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

orderDelivery query

Member Of​

Order object ● OrderDeliveryEdge object