Skip to main content
Anchor to DeliveryMethod

DeliveryMethod

object

Requires read_orders access scope, read_assigned_fulfillment_orders access scope, read_merchant_managed_fulfillment_orders access scope, read_third_party_fulfillment_orders access scope or read_marketplace_fulfillment_orders access scope.

Information about the delivery method selected for a FulfillmentOrder. 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

Anchor to additionalInformationadditionalInformation
•DeliveryMethodAdditionalInformation

The Additional information to consider when performing the delivery.

Anchor to brandedPromisebrandedPromise
•DeliveryBrandedPromise

The branded promise that was presented to the buyer during checkout. For example: Shop Promise.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to maxDeliveryDateTimemaxDeliveryDateTime
•DateTime

The latest delivery date and time when the fulfillment is expected to arrive at the buyer's location.

Anchor to methodTypemethodType
•DeliveryMethodType!
non-null

The type of the delivery method.

Anchor to minDeliveryDateTimeminDeliveryDateTime
•DateTime

The earliest delivery date and time when the fulfillment is expected to arrive at the buyer's location.

Anchor to presentedNamepresentedName
•String

The name of the delivery option that was presented to the buyer during checkout.

Anchor to serviceCodeserviceCode
•String

A reference to the shipping method.

Anchor to sourceReferencesourceReference
•String

Source reference is promise provider specific data associated with delivery promise.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?