Retrieve Address

Beta

GET/v1/sales/addresses/{id}

This endpoint is idempotent. Learn more

Retrieves an address by ID.

Permissions requiredValues:addresses:readcustomers:readsuppliers:read

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

idstring

Address ID.

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

200

Successful response for Retrieve Address

Retrieve 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.retrieve('ad_j8cz0b79pwdb');

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.retrieve('ad_j8cz0b79pwdb');

console.log(address.id);

200 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"
}

Retrieve Address

Authorization

Path Parameters

Returns

Responses