ShippingAddressInput

Destination address used to evaluate which shipping methods are available for a cart. Country is required; the rest are optional and improve carrier rate accuracy when provided.

input ShippingAddressInput {
  city: String
  country: CountryCode!
  email: String
  firstName: String
  lastName: String
  phone: String
  postalCode: String
  state: String
  streetLine1: String
}

Fields

ShippingAddressInput.city ● String scalar

City / town.

ShippingAddressInput.country ● CountryCode! non-null enum

Destination country (ISO 3166-1 alpha-2). Required — drives carrier eligibility and tax/region rules.

ShippingAddressInput.email ● String scalar

Buyer email — useful when the shipping carrier needs notification contact details.

ShippingAddressInput.firstName ● String scalar

Buyer first name.

ShippingAddressInput.lastName ● String scalar

Buyer last name.

ShippingAddressInput.phone ● String scalar

Buyer phone number (free-form).

ShippingAddressInput.postalCode ● String scalar

Postal / ZIP code — required by most carriers for accurate rates.

ShippingAddressInput.state ● String scalar

State / province / region.

ShippingAddressInput.streetLine1 ● String scalar

First line of the street address (street and house / building number).

Member Of

availableShippingMethods query ● availableShippingRates query