Skip to main content
Anchor to DraftOrderAvailableDeliveryOptions

DraftOrderAvailableDeliveryOptions

object

Requires read_draft_orders access scope.

The available delivery options for a draft order.

Anchor to availableLocalDeliveryRatesavailableLocalDeliveryRates
•[DraftOrderShippingRate!]!
non-null

The available local delivery rates for the draft order. Requires a customer with a valid shipping address and at least one line item.

Anchor to availableLocalPickupOptionsavailableLocalPickupOptions
•[PickupInStoreLocation!]!
non-null

The available local pickup options for the draft order. Requires at least one line item.

Anchor to availableShippingRatesavailableShippingRates
•[DraftOrderShippingRate!]!
non-null

The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item.

•PageInfo!
non-null

Returns information about pagination of local pickup options.


Was this section helpful?

•query

Available delivery options for a DraftOrder based on the provided input. The query returns shipping rates, local delivery rates, and pickup locations that merchants can choose from when creating draft orders.

Accepts draft order details including LineItem objects, MailingAddress for shipping, and discounts to determine which delivery methods are available. Pagination parameters control the number of local pickup options returned.

Arguments

•DraftOrderAvailableDeliveryOptionsInput!
required

The fields for the draft order.

•String

The search term for the delivery options.

•Int

The offset for the local pickup options.

•Int

The number of local pickup options required.

•String

Unique token used to trace execution and help optimize the calculation.



Was this section helpful?