Skip to main content
Anchor to DeliveryAddressInput

DeliveryAddressInput

input_object

The input fields for delivery address preferences.

Anchor to FieldsFields

Anchor to customerAddressIdcustomerAddressId
•ID

The ID of a customer address that is associated with the buyer that is interacting with the cart.

Anchor to deliveryAddressdeliveryAddress
•MailingAddressInput

A delivery address preference of a buyer that is interacting with the cart.

Anchor to deliveryAddressValidationStrategydeliveryAddressValidationStrategy
•DeliveryAddressValidationStrategyDefault:COUNTRY_CODE_ONLY

Defines what kind of address validation is requested.

Anchor to oneTimeUseoneTimeUse
•BooleanDefault:false

Whether the given delivery address is considered to be a one-time use address. One-time use addresses do not get persisted to the buyer's personal addresses when checking out.

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to CartBuyerIdentityInput.deliveryAddressPreferencesCartBuyerIdentityInput.deliveryAddressPreferences
•INPUT OBJECTDeprecated

An ordered set of delivery addresses tied to the buyer that is interacting with the cart. The rank of the preferences is determined by the order of the addresses in the array. Preferences can be used to populate relevant fields in the checkout flow.

As of the 2025-01 release, buyerIdentity.deliveryAddressPreferences is deprecated. Delivery addresses are now part of the CartDelivery object and managed with three new mutations:

  • cartDeliveryAddressAdd
  • cartDeliveryAddressUpdate
  • cartDeliveryAddressDelete

The input must not contain more than 250 values.

Was this section helpful?