customerDefaultAddressUpdate

Updates the default address of an existing Customer. Requires a customer access token to identify the customer and an address ID to specify which address to set as the new default.

Use it in a workflow

Add a step and choose the Shopify Storefront connector.
Pick the customerDefaultAddressUpdate action (under Customer).
Fill in the fields below, then reference the result from later steps as {{customerdefaultaddressupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CustomerDefaultAddressUpdate($customerAccessToken: String!, $addressId: ID!) {
  customerDefaultAddressUpdate(
    customerAccessToken: $customerAccessToken
    addressId: $addressId
  ) {
    customer {
      acceptsMarketing
      avatarUrl
      createdAt
      defaultAddress {
        address1
        address2
        city
        company
        country
        countryCode
        countryCodeV2
        firstName
        formattedArea
        id
        lastName
        latitude
        longitude
        name
        phone
        province
        provinceCode
        zip
      }
      displayName
      email
      firstName
      id
      lastName
      numberOfOrders
      phone
      socialLoginProvider {
        handle
      }
      tags
      updatedAt
    }
    customerUserErrors {
      code
      field
      message
    }
    userErrors {
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

customerAccessTokenstringrequired

The access token used to identify the customer.

addressIdstringrequired

ID of the address to set as the new default for the customer.

json

{
  "customerAccessToken": "string",
  "addressId": "string"
}

Response

Read the result with {{customerdefaultaddressupdate.response.data.data.customerDefaultAddressUpdate}}. If the API returns errors, the step fails and they are at {{customerdefaultaddressupdate.response.data.errors}}.

customerobject

acceptsMarketingboolean

avatarUrlstring

createdAtstring

defaultAddressobject18 fields

displayNamestring

emailstring

firstNamestring

idstring

lastNamestring

numberOfOrdersstring

phonestring

socialLoginProviderobject1 fields

tagsarray<object>

updatedAtstring

customerUserErrorsarray<object>

codeobject

fieldobject

messageobject

userErrorsarray<object>

fieldobject

messageobject

Need more? See the Shopify Storefront guide for connection setup and behaviour shared by every action.

Was this page helpful?