Delivery
Requires access scope, access scope, access scope, access scope or access scope.
Information about the delivery method selected for a . Includes the method type, expected delivery timeframe, and any additional information needed for delivery.
The delivery method stores details from checkout such as the carrier, branded promises like Shop Promise, and the delivery option name shown to the buyer. Additional information like delivery instructions or contact phone numbers helps fulfill the Order correctly.
Anchor to FieldsFields
- additionalInformation (DeliveryMethodAdditionalInformation)
- brandedPromise (DeliveryBrandedPromise)
- deliveryOptionGeneratorPickupPoint (DeliveryOptionGeneratorPickupPoint)
- id (ID!)
- maxDeliveryDateTime (DateTime)
- metafield (Metafield)
- metafields (MetafieldConnection!)
- metafieldsByIdentifiers ([Metafield]!)
- methodType (DeliveryMethodType!)
- minDeliveryDateTime (DateTime)
- presentedName (String)
- serviceCode (String)
- sourceReference (String)
- Anchor to additionalInformationadditional•Delivery
Information Method Additional Information The Additional information to consider when performing the delivery.
- Anchor to brandedPromisebranded•Delivery
Promise Branded Promise The branded promise that was presented to the buyer during checkout. For example: Shop Promise.
- Anchor to deliveryOptionGeneratorPickupPointdelivery•Delivery
Option Generator Pickup Point Option Generator Pickup Point This represents the pickup point for the delivery. It returns null when the delivery method doesn't utilize a pickup point generated by a delivery option generator, or when the used pickup point isn't generated by a delivery option generator owned by the requesting app.
- •ID!non-null
A globally-unique ID.
- Anchor to maxDeliveryDateTimemax•Date
Delivery Date Time Time The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
- •String!required
The key for the metafield.
Arguments
- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namespacenamespace•String
The metafield namespace to filter by. If omitted, all metafields are returned.
- Anchor to keyskeys•[String!]
List of keys of metafields in the format
namespace.key, will be returned in the same format.- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
Arguments
- Anchor to methodTypemethod•Delivery
Type Method Type! non-null The type of the delivery method.
- Anchor to minDeliveryDateTimemin•Date
Delivery Date Time Time The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.
- Anchor to presentedNamepresented•String
Name The name of the delivery option that was presented to the buyer during checkout.
- Anchor to serviceCodeservice•String
Code A reference to the shipping method.
- Anchor to sourceReferencesource•String
Reference Source reference is promise provider specific data associated with delivery promise.