Delivery options GraphQL

Served by DeliveryOptionsModule on commercetools and DeliveryOptionsModule on medusa.

Each operation has its own page with its arguments, an example and the engines that serve it. The types link to their fields on the delivery options types page.

Operations

Operation	Description	Served by
`cartSetDeliveryPreference`Mutation	Choose whether the cart ships complete or split, and the date the buyer asks to receive it on.	commercetoolsmedusa
`cartSetDeliverySlot`Mutation	Choose when the cart is delivered.	commercetoolsmedusa
`cartSetPickupPoint`Mutation	Choose where the cart is collected.	commercetoolsmedusa

Types

Type	Description
`CartSetDeliveryPreferenceError`Union	Error union for setting a delivery preference
`CartSetDeliveryPreferenceResponse`Object	Response for setting how and when a cart is delivered
`CartSetDeliverySlotError`Union	Error union for choosing a delivery slot
`CartSetDeliverySlotResponse`Object	Response for choosing a delivery slot
`CartSetPickupPointError`Union	Error union for choosing a pickup point
`CartSetPickupPointResponse`Object	Response for choosing a pickup point
`Coordinates`Object	A position on earth, in decimal degrees (WGS 84).
`CoordinatesInput`Input object	A position on earth, in decimal degrees (WGS 84).
`DeliveryDate`Object	A calendar date on which a cart may be delivered.
`DeliveryError`Object	A recoverable error that occurred while choosing how or when a cart is delivered.
`DeliveryErrorCodeType`Enum	Error codes for choosing a delivery slot, a pickup point or a delivery preference.
`DeliveryEstimate`Object	When a delivery arrives: one date, or a range when the carrier gives one.
`DeliveryPromise`Object	What a product page can promise about delivery.
`DeliverySlot`Object	A time window on a date in which a carrier delivers.
`DeliverySplitType`Enum	How a cart with backordered lines is shipped.
`DeliveryUnavailableReason`Object	Why a delivery date or slot cannot be chosen.
`DeliveryUnavailableReasonCodeType`Enum	Why a delivery date or slot cannot be chosen.
`PickupPoint`Object	A place a shopper collects a parcel from.
`PickupPointLocationInput`Input object	Where to search for pickup points.
`PickupPointOpeningDate`Object	The hours a pickup point is open on one date.
`PickupPointType`Enum	What kind of place a pickup point is.
`TimeWindow`Object	A stretch of time between two instants, given in UTC.

Fields on other types

This domain adds these fields to types that another domain defines.

`Cart`

Field	Type	Description
`deliveryDates`	`[DeliveryDate!]!`	The dates the cart can be delivered on, each with its time slots, starting at from (today when absent) and covering the given number of days. Every date in the range is listed, including those with nothing to offer, so a date picker can show them disabled with their reason. Empty while the cart has no shipping address to deliver to.Arguments: `from`, `days`
`deliverySlot`	`DeliverySlot`	The delivery slot chosen for the cart. Null until one is chosen.
`pickupPoints`	`[PickupPoint!]!`	Pickup points the cart can be collected from, nearest first, including those that cannot be chosen. Searched around near, or the shipping address when near is absent; empty when there is neither. carrierKeys narrows the list to those carriers.Arguments: `near`, `carrierKeys`, `limit`
`pickupPoint`	`PickupPoint`	The pickup point chosen for the cart. Null until one is chosen.
`deliverySplit`	`DeliverySplitType!`	Whether the cart ships once, when every line is in stock, or ships what is in stock now and the backordered rest later. COMPLETE until chosen.
`requestedDeliveryDate`	`Date`	The date the buyer asked to receive the delivery on. Null until asked.
`earliestCompleteDeliveryDate`	`Date`	The first date every line is in stock, which is when a complete delivery can leave at the earliest. Null when nothing is backordered, or when a backordered line has no expected date; the lines say which.

`Order`

Field	Type	Description
`deliverySlot`	`DeliverySlot`	The delivery slot chosen in checkout, as it was when the order was placed. Null when the order is collected from a pickup point or none was chosen.
`pickupPoint`	`PickupPoint`	The pickup point chosen in checkout, as it was when the order was placed. Null when the order is delivered or none was chosen.

`ProductVariant`

Field	Type	Description
`deliveryPromise`	`DeliveryPromise`	When this variant arrives if it is ordered now, at a country and optional postal code: the earliest date, the deadline to order for it, the carrier and the price. The same source as the cart's delivery dates, so the product page promises what checkout offers. Null when the delivery provider makes no promises.Arguments: `country`, `postalCode`

`ShippingMethod`

Field	Type	Description
`carrier`	`Carrier`	Who delivers with this method, for the delivery step to show by name and, through its key, by logo. Null when the delivery provider does not say.
`deliveryEstimate`	`DeliveryEstimate`	When an order placed now with this method arrives, if every line is in stock. Null when the delivery provider gives no estimate. A cart with backordered lines arrives no earlier than its earliestCompleteDeliveryDate.