Appendix: Address Data Types
In methods whose payload contains an address object, the address format can be selected during integration, according to the system used by the courier service. Types of address data are currently supported:
- Coordinate-based (coord); location is transmitted using coordinates, i.e. latitude and longitude take priority;
- Custom (custom); location is transmitted using parts of the address and the full free-text address, supplemented with coordinates.
Detail tables of the parameters for the various address object types are presented below:
Coordinate-Based
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| addressType | const: coord | 1 | A coordinate-based address object | Filled in as: "coord" |
| fullAddress | string | 1 | Full address in string format | Example: "214014, Smolensk, Mira St., 7" |
| cityFias | string (36) UUID | 0 | FIAS code of the city (Russia only) | Example: "2763c110-cb8b-416a-9dac-ad28a55b4402" |
| latitude | decimal | 1 | Latitude of the object in decimal degrees | 128-bit, fixed precision |
| longitude | decimal | 1 | Longitude of the object in decimal degrees | 128-bit, fixed precision |
| flat | string | 0 | Apartment or unit number | Optional if the address is passed for a PP |
| addressComment | string (250) | 0 | Comment on the address | May match the PP comment |
Custom
| Parameter | Data type | Required | Description | Comment |
|---|---|---|---|---|
| addressType | const: custom | 1 | A custom address object | Filled in as: "custom" |
| fullAddress | string | 1 | Full address in string format | Example: "214014, Smolensk, Mira St., 7" |
| countryCodeIso | string (2) | 0 | Country code for the address object | Per the "ISO 3166-1, alpha-2" standard |
| regionCodeIso | string (6) | 0 | Region code for the address object | Per the "ISO 3166-2" standard |
| regionName | string (100) | 1 | Region name | Example: "Sverdlovsk" |
| cityType | string (100) | 1 | City type | Example: "city" |
| cityName | string (100) | 1 | City name | Example: "Yekaterinburg" |
| localityType | string (30) | 0 | Type of destination locality | If this is a locality within another city |
| localityName | string (100) | 0 | Name of the destination locality | Example: "Kudrovo," "Zheleznodorozhny" |
| postalCode | string (6) | 0 | Postal code | Example: 620007 |
| streetType | string (30) | 0 | Street type | Example: "Lane," "Street," "Passage" |
| streetName | string (100) | 0 | Street name | Example: "Bobruyskaya," "John Lennon" |
| houseNumber | string (6) | 0 | House number | Example: "42," "9," "3/4" |
| flat | string | 0 | Apartment or unit number | Optional if the address is passed for a PP |
| latitude | decimal | 0 | Latitude of the object in decimal degrees | 128-bit, fixed precision |
| longitude | decimal | 0 | Longitude of the object in decimal degrees | 128-bit, fixed precision |
| nearestStation | string (100) | 0 | Nearest surface-transport station | For example, "MGA," platform "65km," etc. |
| nearestSubwayStation | string (100) | 0 | Nearest metro station | Only for localities with a metro system |
| addressComment | string (250) | 0 | Comment on the address | May match the PP comment |