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.

Show

deprecated fields Deprecated

Anchor to countrycountry • StringDeprecated: The name of the country. Use countryCode instead.
Anchor to idid • IDDeprecated: Not needed for 90% of mutations, and provided separately where it is needed.
Anchor to provinceprovince • StringDeprecated: The region of the address, such as the province, state, or district. Use provinceCode instead.

Was this section helpful?

Anchor to Mutations using this inputMutations using this input

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 addresses for a customer.
Anchor to DraftOrderInput.billingAddress DraftOrderInput.billingAddress • INPUT OBJECT: The mailing address associated with the payment method.
Anchor to DraftOrderInput.shippingAddress DraftOrderInput.shippingAddress • INPUT OBJECT: The mailing address to where the order will be shipped.
Anchor to OrderCreateOrderInput.billingAddress OrderCreateOrderInput.billingAddress • INPUT OBJECT: The mailing address associated with the payment method. This address is an optional field that won't be available on orders that don't require a payment method.

Note
If a customer is provided, this field or shipping_address (which has precedence) will be set as the customer's default address. Additionally, if the provided customer is new or hasn't created an order yet then their name will be set to the first/last name from this address (if provided).
Anchor to OrderCreateOrderInput.shippingAddress OrderCreateOrderInput.shippingAddress • INPUT OBJECT: The mailing address to where the order will be shipped.

Note
If a customer is provided, this field (which has precedence) or billing_address will be set as the customer's default address. Additionally, if the provided customer doesn't have a first or last name then it will be set to the first/last name from this address (if provided).
Anchor to OrderInput.shippingAddress OrderInput.shippingAddress • INPUT OBJECT: The new shipping address for the order. Overwrites the existing shipping address.
Anchor to ShopifyPaymentsDisputeEvidenceUpdateInput.shippingAddress ShopifyPaymentsDisputeEvidenceUpdateInput.shippingAddress • INPUT OBJECT: The shipping address associated with the dispute evidence.
Anchor to SubscriptionDeliveryMethodLocalDeliveryInput.address SubscriptionDeliveryMethodLocalDeliveryInput.address • INPUT OBJECT: The address to deliver to.
Anchor to SubscriptionDeliveryMethodShippingInput.address SubscriptionDeliveryMethodShippingInput.address • INPUT OBJECT: The address to ship to.

Was this section helpful?