Create Address

Beta

POST/v1/sales/addresses

Idempotent with Idempotency-Key header. Learn more

Creates an address.

The address is saved to the account you are acting in, which may be your own account or a customer or supplier account you manage, and can then be used as a billing or shipping address on sales orders, invoices, and shipments.

Permissions requiredValues:addresses:createcustomers:updatesuppliers:update

The role behind your API key or agent must grant every one of these permissions.

namestring

Display name of the address.

phoneoptional string

Phone number associated with the address.

emailoptional string

Email address associated with the address.

typeoptional stringenumValues:standarddrop_ship

How the address is used. Defaults to standard.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

receive_calendar_idoptional string

The operating calendar naming the days this dock accepts freight, overriding the customer's own.

street_line_1optional string

First line of the street address.

street_line_2optional string

Second line of the street address.

localityoptional string

City or locality.

stateoptional string

State or administrative area.

postal_codeoptional string

Postal or ZIP code.

countrystring

Two-letter ISO 3166-1 country code, such as US.

idstring

Address ID.

objectstringenumValues:address

Resource type identifier.

namestring

Display name of the address.

phonestringnullable

Phone number associated with the address.

emailstringnullable

Email address associated with the address.

typestringenumValues:standarddrop_ship

How the address is used.

standard: a normal shipping or billing address.
drop_ship: an address an order is shipped to directly, typically a third party or end customer rather than the account itself.

receive_calendar_idstringnullable

The operating calendar naming the days this dock accepts freight.

The most specific link in the receiving chain: set it when one of a customer's sites keeps different days from the rest. Null falls through to the customer, then their group, then the account default.

geolocationgeolocationnullable

Street-level location details for the address.

idstring

Geolocation ID.

objectstringenumValues:geolocation

Resource type identifier.

street_line_1stringnullable

First line of the street address.

street_line_2stringnullable

Second line of the street address.

localitystringnullable

City or locality.

statestringnullable

State or administrative area.

postal_codestringnullable

Postal or ZIP code.

countrystring

Two-letter country code.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Address

Create 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.create({
  country: 'US',
  name: 'Headquarters',
  email: 'warehouse@acme.com',
  locality: 'Springfield',
  phone: '555-123-4567',
  postal_code: '62701',
  state: 'IL',
  street_line_1: '123 Main St',
  street_line_2: 'Suite 400',
  type: 'standard',
});

console.log(address.id);

import OpenMRP from '@openmrp/sdk';

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

const address = await client.sales.addresses.create({
  country: 'US',
  name: 'Headquarters',
  email: 'warehouse@acme.com',
  locality: 'Springfield',
  phone: '555-123-4567',
  postal_code: '62701',
  state: 'IL',
  street_line_1: '123 Main St',
  street_line_2: 'Suite 400',
  type: 'standard',
});

console.log(address.id);

201 example

{
  "id": "ad_j8cz0b79pwdb",
  "object": "address",
  "name": "Headquarters",
  "phone": "+1-614-555-0142",
  "email": "receiving@acme.example.com",
  "type": "standard",
  "receive_calendar_id": null,
  "geolocation": {
    "id": "gl_betrf3v346k5",
    "object": "geolocation",
    "street_line_1": "4200 Industrial Pkwy",
    "street_line_2": null,
    "locality": "Columbus",
    "state": "OH",
    "postal_code": "43204",
    "country": "US"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ad_j8cz0b79pwdb",
  "object": "address",
  "name": "Headquarters",
  "phone": "+1-614-555-0142",
  "email": "receiving@acme.example.com",
  "type": "standard",
  "receive_calendar_id": null,
  "geolocation": {
    "id": "gl_betrf3v346k5",
    "object": "geolocation",
    "street_line_1": "4200 Industrial Pkwy",
    "street_line_2": null,
    "locality": "Columbus",
    "state": "OH",
    "postal_code": "43204",
    "country": "US"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Address

Authorization

Request Body

Returns

Responses