companyAddressDelete
mutation

Choose a version:

Requires write_customers access scope or write_companies access scope. Also: The API client must be installed on a Shopify Plus store.

Deletes a company address.

Anchor to section titled 'Arguments'

Arguments

Anchor to addressId addressId ID! required: The ID of the address to delete.

Was this section helpful?

Anchor to section titled 'CompanyAddressDeletePayload returns'

CompanyAddressDeletePayload returns

Anchor to CompanyAddressDeletePayload.deletedAddressId deletedAddressId ID: The ID of the deleted address.
Anchor to CompanyAddressDeletePayload.userErrors userErrors [BusinessCustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: companyAddressDelete

Query Reference for MUTATION: companyAddressDelete

"mutation companyAddressDelete($addressId: ID!) {\n  companyAddressDelete(addressId: $addressId) {\n    deletedAddressId\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: companyAddressDelete

"{\n  \"addressId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: companyAddressDelete

""

Display Examples for MUTATION: companyAddressDelete

[]

companyAddressDeletemutation

Arguments

CompanyAddressDeletePayload returns

companyAddressDelete
mutation