data-src=../../../../../includes/commerce-only.md

deleteCompanyAddress mutation

data-variant=info

data-slots=text1

This mutation is part of the B2B Storefront Compatibility Package and is only available on Adobe Commerce as a Cloud Service.

The deleteCompanyAddress mutation allows a company admin or user who is assigned a role that contains the Magento_CompanyAddressStorefrontCompatibility::delete permission to delete an existing company address using a provided company UID.

This mutation requires a valid customer authentication token.

Syntax

mutation {
    deleteCompanyAddress(
        id: ID!
    ) {
        Boolean
    }
}

Example usage

Delete a company address

The following example deletes an existing company address.

Request:

mutation DeleteCompanyAddress {
    deleteCompanyAddress(id: "MTI=")
}

Response:

{
  "data": {
    "deleteCompanyAddress": true
  }
}