Skip to main content

AddressFullDTO

A full address — country, city, district and street. Name properties come in one field per language.

This is also the body of GET /v1/open-api/address/{uuid}, which returns it without the response envelope. There, district is absent when the stored uuid was a region rather than a district, and a value that cannot be resolved at all comes back as the original string instead of an object.

country object

A country in the address reference data.

idint32

Country ID

Example: 1
zonestring

The country's time zone.

Example: Asia/Tashkent
uzstringnullable

Name (uz)

Example: O'zbekiston
rustringnullable

Name (ru)

Example: Узбекистан
enstringnullable

Name (en)

Example: Uzbekistan
krstringnullable

Name (uz-cyrl)

Example: Ўзбекистон
trstringnullable

Name (tr)

Example: Özbekistan
tjstringnullable

Name (tj)

Example: Ӯзбекистон
kystringnullable

Name (ky)

Example: Өзбекстан
city object

A city in the address reference data.

idint32

City ID

Example: 14
uuidstringnullable

City UUID — the value stored in an ADDRESS field.

Example: 0f4c1a2e-8b7d-4a11-9f3c-2d5e6a7b8c90
uzstringnullable

Name (uz)

Example: Toshkent
rustringnullable

Name (ru)

Example: Ташкент
enstringnullable

Name (en)

Example: Tashkent
krstringnullable

Name (uz-cyrl)

Example: Тошкент
trstringnullable

Name (tr)

Example: Taşkent
tjstringnullable

Name (tj)

Example: Тошканд
kystringnullable

Name (ky)

Example: Ташкент
district object

A district in the address reference data.

idint32

District ID

Example: 207
uuidstringnullable

District UUID — the value stored in an ADDRESS field.

Example: 3b9ac1de-52f4-4d7a-9c18-7e0b5f2a4d63
uzstringnullable

Name (uz)

Example: Yunusobod
rustringnullable

Name (ru)

Example: Юнусабад
enstringnullable

Name (en)

Example: Yunusabad
krstringnullable

Name (uz-cyrl)

Example: Юнусобод
trstringnullable

Name (tr)

Example: Yunusabad
tjstringnullable

Name (tj)

Example: Юнусобод
kystringnullable

Name (ky)

Example: Юнусабад
streetstringnullable

Street

Example: Amir Temur ko'chasi 12
AddressFullDTO
{
  "country": {
    "id": 1,
    "zone": "Asia/Tashkent",
    "uz": "O'zbekiston",
    "ru": "Узбекистан",
    "en": "Uzbekistan",
    "kr": "Ўзбекистон",
    "tr": "Özbekistan",
    "tj": "Ӯзбекистон",
    "ky": "Өзбекстан"
  },
  "city": {
    "id": 14,
    "uuid": "0f4c1a2e-8b7d-4a11-9f3c-2d5e6a7b8c90",
    "uz": "Toshkent",
    "ru": "Ташкент",
    "en": "Tashkent",
    "kr": "Тошкент",
    "tr": "Taşkent",
    "tj": "Тошканд",
    "ky": "Ташкент"
  },
  "district": {
    "id": 207,
    "uuid": "3b9ac1de-52f4-4d7a-9c18-7e0b5f2a4d63",
    "uz": "Yunusobod",
    "ru": "Юнусабад",
    "en": "Yunusabad",
    "kr": "Юнусобод",
    "tr": "Yunusabad",
    "tj": "Юнусобод",
    "ky": "Юнусабад"
  },
  "street": "Amir Temur ko'chasi 12"
}