Anchor to section titled 'undefined'

customerUpdateDefaultAddress
mutation

Requires write_customers access scope.

Updates a customer's default address.


Anchor to addressId
addressId
required

The ID of the customer's new default address.

Anchor to customerId
customerId
required

The ID of the customer whose default address is being updated.


Was this section helpful?

The customer whose address was updated.

The list of errors that occurred from executing the mutation.


Was this section helpful?

Examples

Hide code
Copy
mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {
customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {
customer {
id
defaultAddress {
id
address1
city
}
}
userErrors {
field
message
}
}
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) { customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) { customer { id defaultAddress { id address1 city } } userErrors { field message } } }",
"variables": {
"customerId": "gid://shopify/Customer/624407574",
"addressId": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress"
}
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
`#graphql
mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {
customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {
customer {
id
defaultAddress {
id
address1
city
}
}
userErrors {
field
message
}
}
}`,
{
variables: {
"customerId": "gid://shopify/Customer/624407574",
"addressId": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress"
},
},
);
session = ShopifyAPI::Auth::Session.new(
shop: "your-development-store.myshopify.com",
access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
session: session
)

query = <<~QUERY
mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {
customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {
customer {
id
defaultAddress {
id
address1
city
}
}
userErrors {
field
message
}
}
}
QUERY

variables = {
"customerId": "gid://shopify/Customer/624407574",
"addressId": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress"
const client = new shopify.clients.Graphql({session});
const data = await client.query({
data: {
"query": `mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {
customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {
customer {
id
defaultAddress {
id
address1
city
}
}
userErrors {
field
message
}
}
}`,
"variables": {
"customerId": "gid://shopify/Customer/624407574",
"addressId": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress"
},
},
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
mutation CustomerAddressDefault($addressId: ID!, $customerId: ID!) {
customerUpdateDefaultAddress(addressId: $addressId, customerId: $customerId) {
customer {
id
defaultAddress {
id
address1
city
}
}
userErrors {
field
message
}
}
}
QUERY;

$variables = [
"customerId" => "gid://shopify/Customer/624407574",
"addressId" => "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress",
];

$response = $client->query(["query" => $query, "variables" => $variables]);

Hide code
Input variables
Copy
{
"customerId": "gid://shopify/Customer/624407574",
"addressId": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress"
}

Hide code
Response
JSON
{
"customerUpdateDefaultAddress": {
"customer": {
"id": "gid://shopify/Customer/624407574",
"defaultAddress": {
"id": "gid://shopify/MailingAddress/624407574?model_name=CustomerAddress",
"address1": "124 Amoebobacterieae St",
"city": "Ottawa"
}
},
"userErrors": []
}
}