Delete Address

Beta

DELETE/v1/sales/addresses/{id}

This endpoint is idempotent. Learn more

Deletes an address.

Deletion fails if the address is in use as a billing or shipping address on a sales order, invoice, or shipment, or as a default account address.

Permission requiredValues:addresses:delete

In your own account, the role behind your API key or agent must grant this permission.

In a customer's accountValues:customers:update

When the OpenMRP-Account header names one of your customers, the role must grant this permission instead.

In a supplier's accountValues:suppliers:update

When the OpenMRP-Account header names one of your suppliers, the role must grant this permission instead.

idstring

Address ID.

Responses

200

Successful response for Delete Address

Delete Address

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const address = await client.sales.addresses.delete('ad_j8cz0b79pwdb');

console.log(address);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const address = await client.sales.addresses.delete('ad_j8cz0b79pwdb');

console.log(address);

200 example

{}

{}

Delete Address

Authorization

Path Parameters

Responses