draft
Requires access scope.
Available delivery options for a 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 objects, for shipping, and discounts to determine which delivery methods are available. Pagination parameters control the number of local pickup options returned.
Arguments
- input (DraftOrderAvailableDeliveryOptionsInput!)
- localPickupCount (Int)
- localPickupFrom (Int)
- search (String)
- sessionToken (String)
- Anchor to inputinput•Draft
Order Available Delivery Options Input! required The fields for the draft order.
- Anchor to localPickupCountlocal•Int
Pickup Count The number of local pickup options required.
- Anchor to localPickupFromlocal•Int
Pickup From The offset for the local pickup options.
- Anchor to searchsearch•String
The search term for the delivery options.
- Anchor to sessionTokensession•String
Token Unique token used to trace execution and help optimize the calculation.
Anchor to Possible returnsPossible returns
- DraftOrderAvailableDeliveryOptions (DraftOrderAvailableDeliveryOptions!)
- Anchor to DraftOrderAvailableDeliveryOptionsDraft•Draft
Order Available Delivery Options Order Available Delivery Options! The available delivery options for a draft order.
- Anchor to availableLocalDeliveryRatesavailable•[Draft
Local Delivery Rates Order Shipping Rate!]! 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 availableLocalPickupOptionsavailable•[Pickup
Local Pickup Options In Store Location!]! non-null The available local pickup options for the draft order. Requires at least one line item.
- Anchor to availableShippingRatesavailable•[Draft
Shipping Rates Order Shipping Rate!]! non-null The available shipping rates for the draft order. Requires a customer with a valid shipping address and at least one line item.
- Anchor to pageInfopage•Page
Info Info! non-null Returns information about pagination of local pickup options.