Address management

Methods to manage and update account addresses stored on a customer's account.

List addresses

Use to get a list of addresses on file for the account. These are stored automatically when a non-guest user checks out and chooses to save their information for later.

Returns all addresses. The parameters for this query are _locale and _currency.

query getAccountAddresses {
  account {
    addresses {
      results {
        name
        address1
        city
        state
        zip
        country
        phone
      }
    }
  }
}

Create an address

Use to add a new address to the account. Returns the newly created address object.

The parameter for this mutation is input (required).

mutation createAccountAddress {
  addAccountAddress(
    input: {
      name: "Ancotar"
      address1: "1234 Fort Caractacus"
      city: "Imperial City"
      state: "FL"
      country: "US" ## Two letter ISO country code
    }
  ) {
    name
    address1
    city
    state
    country
  }
}

Update an address

Use to update an existing address from the account by ID. Returns the updated address object.

The parameter for this mutation is addressId (required) and input (required).

mutation updateAccountAddress {
  updateAccountAddress(
    addressId: "62fe8f954711c20012d6a5c7"
    input: { zip: "32216", phone: "904-504-4760" }
  ) {
    name
    zip
    phone
  }
}

Delete an address

Use to remove an existing address from the account by ID. Returns the deleted address object.

The parameter for this mutation is addressId (required).

mutation deleteAccountAddress {
  deleteAccountAddress(addressId: "62fe8f954711c20012d6a5c7") {
    name
    address1
    city
    state
    zip
    country
    phone
  }
}