For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • MUTcreateCart
          • MUTdeleteCart
          • MUTaddCartLineItems
          • MUTupdateCartLineItem
          • MUTdeleteCartLineItem
          • MUTupdateCartCurrency
          • MUTassignCartToCustomer
          • MUTunassignCartFromCustomer
          • MUTcreateCartMetafield
          • MUTupdateCartMetafield
          • MUTdeleteCartMetafield
          • MUTcreateCartRedirectUrls
          • MUTcreateCheckout
          • MUTupdateCheckout
          • MUTaddCheckoutBillingAddress
          • MUTupdateCheckoutBillingAddress
          • MUTupdateCheckoutCustomerMessage
          • MUTselectCheckoutShippingOption
          • MUTapplyCheckoutCoupon
          • MUTunapplyCheckoutCoupon
          • MUTapplyCheckoutGiftCertificate
          • MUTunapplyCheckoutGiftCertificate
          • MUTapplyCheckoutSpamProtection
          • MUTaddCheckoutShippingConsignments
          • MUTupdateCheckoutShippingConsignment
          • MUTdeleteCheckoutConsignment
          • MUTcompleteCheckout
          • MUTlogin
          • MUTlogout
          • MUTcreateWishlist
          • MUTaddWishlistItems
          • MUTdeleteWishlistItems
          • MUTupdateWishlist
          • MUTdeleteWishlists
          • MUTloginWithCustomerLoginJwt
          • MUTsubmitContactUs
          • MUTgenerateSessionSyncJwt
          • MUTvalidateSessionSyncJwt
          • MUTproductViewedEvent
          • MUTpageViewedEvent
          • MUTvisitStartedEvent
          • MUTsearchProductEvent
          • MUTpreviewGiftCertificate
          • MUTregisterCompany
          • MUTaddProductReview
          • MUTchangePassword
          • MUTrequestResetPassword
          • MUTresetPassword
          • MUTregisterCustomer
          • MUTupdateCustomer
          • MUTaddCustomerAddress
          • MUTupdateCustomerAddress
          • MUTdeleteCustomerAddress
          • MUTpayment
          • MUTsubscribe
          • MUTunsubscribe
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontMutations

updateCustomerAddress

Example Query
1mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: UpdateCustomerAddressInput) {
2 updateCustomerAddress(reCaptchaV2: $reCaptchaV2, input: $input) {
3 address {
4 entityId
5 firstName
6 lastName
7 address1
8 address2
9 addressType
10 city
11 country
12 countryId
13 countryCode
14 }
15 errors
16 }
17}
Variables
1{
2 "reCaptchaV2": {
3 "token": "example"
4 },
5 "input": {
6 "addressEntityId": 0,
7 "data": {
8 "firstName": "example",
9 "lastName": "example",
10 "address1": "example",
11 "address2": "example",
12 "city": "example",
13 "company": "example",
14 "countryCode": "example",
15 "stateOrProvince": "example",
16 "phone": "example",
17 "postalCode": "example"
18 }
19 }
20}
Example response
1{
2 "data": {
3 "updateCustomerAddress": {
4 "address": {
5 "entityId": 0,
6 "firstName": "example",
7 "lastName": "example",
8 "address1": "example",
9 "address2": "example",
10 "addressType": "COMMERCIAL",
11 "city": "example",
12 "country": "example",
13 "countryId": 0,
14 "countryCode": "example"
15 },
16 "errors": [
17 {
18 "message": "example"
19 }
20 ]
21 }
22 }
23}
Update a customer address.
Was this page helpful?
Previous

addCustomerAddress

Next

deleteCustomerAddress

Built with

Arguments

reCaptchaV2ReCaptchaV2InputOptional
Recaptcha token.
inputUpdateCustomerAddressInputRequired
Input for updating a customer address.

Returns

an UpdateCustomerAddressResult
errorslist of UpdateCustomerAddressErrors
List of response errors when attempting to update an address.
addressCustomerAddress
Customer address that was updated.