For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

GraphQL Storefront Mutations

deleteAddress

Deprecated

Example Query

1 mutation ExampleMutation($input: DeleteCompanyAddressInput!) {
2   company {
3     deleteAddress(input: $input) {
4       entityId
5       errors {
6         message
7         code
8       }
9     }
10   }
11 }

Variables

1 {
2   "input": {
3     "entityId": 0
4   }
5 }

Example response

1 {
2   "data": {
3     "company": {
4       "deleteAddress": {
5         "entityId": 0,
6         "errors": [
7           {
8             "message": "example",
9             "code": "example"
10           }
11         ]
12       }
13     }
14   }
15 }

Delete an existing company address.

Deprecated: Alpha version. Do not use in production.

Was this page helpful?

Arguments

inputDeleteCompanyAddressInputRequired

The id of the address to delete.

Returns

a DeleteCompanyAddressResult

errorslist of DeleteCompanyAddressErrors

Errors encountered while deleting the address, empty on success.

entityIdIntegerOptional

The id of the address that was deleted, or null if the mutation failed.