customerAddressDelete

Permanently deletes a specific MailingAddress for a Customer. Requires a valid customer access token to authenticate the request.

Use it in a workflow

Query

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

mutation CustomerAddressDelete($id: ID!, $customerAccessToken: String!) {
  customerAddressDelete(id: $id, customerAccessToken: $customerAccessToken) {
    customerUserErrors {
      code
      field
      message
    }
    deletedCustomerAddressId
    userErrors {
      field
      message
    }
  }
}

Variables

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

{
  "id": "string",
  "customerAccessToken": "string"
}

Response

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

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