Choose a version:

MailingAddressInput

input_object

The input fields to create or update a mailing address.

Anchor to FieldsFields

Anchor to address1address1 •String: The first line of the address. Typically the street address or PO Box number.
Anchor to address2address2 •String: The second line of the address. Typically the number of the apartment, suite, or unit.
Anchor to citycity •String: The name of the city, district, village, or town.
Anchor to companycompany •String: The name of the customer's company or organization.
Anchor to countryCodecountryCode •CountryCode: The two-letter code for the country of the address.
Anchor to firstNamefirstName •String: The first name of the customer.
Anchor to lastNamelastName •String: The last name of the customer.
Anchor to phonephone •String: A unique phone number for the customer.

Formatted using E.164 standard. For example, +16135551111.
Anchor to provinceCodeprovinceCode •String: The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada.
Anchor to zipzip •String: The zip or postal code of the address.

Deprecated fields

Anchor to countrycountry •String Deprecated
Anchor to idid •ID Deprecated
Anchor to provinceprovince •String Deprecated

Was this section helpful?

Anchor to Mutations using this inputMutations using this input

Anchor to customerAddressCreate.address customerAddressCreate.address •MUTATION
Anchor to customerAddressUpdate.address customerAddressUpdate.address •MUTATION
Anchor to customerPaymentMethodCreditCardCreate.billingAddress customerPaymentMethodCreditCardCreate.billingAddress •MUTATION
Anchor to customerPaymentMethodCreditCardUpdate.billingAddress customerPaymentMethodCreditCardUpdate.billingAddress •MUTATION
Anchor to customerPaymentMethodPaypalBillingAgreementCreate.billingAddress customerPaymentMethodPaypalBillingAgreementCreate.billingAddress •MUTATION
Anchor to customerPaymentMethodPaypalBillingAgreementUpdate.billingAddress customerPaymentMethodPaypalBillingAgreementUpdate.billingAddress •MUTATION

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to CustomerInput.addresses CustomerInput.addresses •INPUT OBJECT: The input fields and values to use when creating or updating a customer.
Anchor to CustomerSetInput.addresses CustomerSetInput.addresses •INPUT OBJECT: The input fields and values to use when creating or updating a customer.
Anchor to DraftOrderInput.billingAddress DraftOrderInput.billingAddress •INPUT OBJECT: The input fields used to create or update a draft order.
Anchor to DraftOrderInput.shippingAddress DraftOrderInput.shippingAddress •INPUT OBJECT: The input fields used to create or update a draft order.
Anchor to OrderCreateOrderInput.billingAddress OrderCreateOrderInput.billingAddress •INPUT OBJECT: The input fields for creating an order.
Anchor to OrderCreateOrderInput.shippingAddress OrderCreateOrderInput.shippingAddress •INPUT OBJECT: The input fields for creating an order.
Anchor to OrderInput.shippingAddress OrderInput.shippingAddress •INPUT OBJECT: The input fields for specifying the information to be updated on an order when using the orderUpdate mutation.
Anchor to ShopifyPaymentsDisputeEvidenceUpdateInput.shippingAddress ShopifyPaymentsDisputeEvidenceUpdateInput.shippingAddress •INPUT OBJECT: The input fields required to update a dispute evidence object.
Anchor to SubscriptionDeliveryMethodLocalDeliveryInput.address SubscriptionDeliveryMethodLocalDeliveryInput.address •INPUT OBJECT: The input fields for a local delivery method.

This input accepts partial input. When a field is not provided, its prior value is left unchanged.
Anchor to SubscriptionDeliveryMethodShippingInput.address SubscriptionDeliveryMethodShippingInput.address •INPUT OBJECT: Specifies shipping delivery method fields.

This input accepts partial input. When a field is not provided, its prior value is left unchanged.

Was this section helpful?