Retrieve Address

Beta
GET/v1/sales/addresses/{id}

This endpoint is idempotent. Learn more

Retrieves an address by ID.

Permission requiredValues:addresses:read
In your own account, the role behind your API key or agent must grant this permission.
In a customer's accountValues:customers:read
When the OpenMRP-Account header names one of your customers, the role must grant this permission instead.
In a supplier's accountValues:suppliers:read
When the OpenMRP-Account header names one of your suppliers, the role must grant this permission instead.
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