Anchor to companyAddressDeletecompany
companyAddressDelete
mutation
Requires access scope or
access scope. Also: The API client must be installed on a Shopify Plus store.
Deletes a company address.
Anchor to Arguments
Arguments
- Anchor to addressIdaddress•
Id ID!required The ID of the address to delete.
Was this section helpful?
Anchor to CompanyAddressDeletePayload returnsCompanyAddressDeletePayload returns
- Anchor to deletedAddressIddeleted•
Address Id The ID of the deleted address.
- Anchor to userErrorsuser•
Errors [BusinessCustomer non-nullUser Error!]! The list of errors that occurred from executing the mutation.
Was this section helpful?
Mutation Reference
mutation companyAddressDelete($addressId: ID!) {
companyAddressDelete(addressId: $addressId) {
deletedAddressId
userErrors {
field
message
}
}
}
Input
{
"addressId": "gid://shopify/<objectName>/10079785100"
}
{
"addressId": "gid://shopify/<objectName>/10079785100"
}