Найти узловые точки по адресу
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Передайте data.address. Для поиска заведённой точки нужен data.forwarderId организации, в которой есть право can_exp_create_nodal_point. Без него метод не ищет заведённые точки. Найдите вариант с заполненным nodalPoint в data.foundAddresses.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/nodalPoint/suggestWithGeoDataByAddress/v0
Тестовый стенд
Body
application/json
{
"data": {
"address": "example",
"forwarderId": "example"
}
}
|
Name |
Description |
|
data |
Type: NodalPointSuggestWithGeoDataByAddressV0Request Example |
NodalPointSuggestWithGeoDataByAddressV0Request
|
Name |
Description |
|
address |
Type: string Example: |
|
forwarderId |
Type: string | null Example: |
Example
{
"address": "example",
"forwarderId": "example"
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"foundAddresses": [
{
"accuracy": "example",
"address": "example",
"area": "example",
"displayAddress": "example",
"house": "example",
"lat": 0.5,
"locality": "example",
"lon": 0.5,
"nodalPoint": {},
"province": "example",
"street": "example"
}
]
}
}
|
Name |
Description |
|
data |
Type: NodalPointSuggestWithGeoDataByAddressV0Response Example |
NodalPointSuggestWithGeoDataByAddressV0PersonalData
|
Name |
Description |
|
|
Type: string Example: |
|
id |
Type: string Example: |
|
name |
Type: string Example: |
|
phone |
Type: string Example: |
Example
{
"email": "example",
"id": "example",
"name": "example",
"phone": "example"
}
NodalPointSuggestWithGeoDataByAddressV0NodalPointContact
|
Name |
Description |
|
id |
Type: string Example: |
|
npId |
Type: string Example: |
|
personalData |
Type: NodalPointSuggestWithGeoDataByAddressV0PersonalData Example |
Example
{
"id": "example",
"npId": "example",
"personalData": {
"email": "example",
"id": "example",
"name": "example",
"phone": "example"
}
}
NodalPointSuggestWithGeoDataByAddressV0NodalPoint
|
Name |
Description |
|
createdAt |
Type: string Example: |
|
forwarderId |
Type: string Example: |
|
id |
Type: string Example: |
|
lastUsedAt |
Type: string Example: |
|
npLegalType |
Type: string Example: |
|
npName |
Type: string Example: |
|
npTin |
Type: string Example: |
|
timezoneIdentifier |
Type: string Example: |
|
utcOffset |
Type: string Example: |
|
addressComment |
Type: string | null Example: |
|
legalAddress |
Type: string | null Example: |
|
legalPhone |
Type: string | null Example: |
|
nodalPointContacts |
Type: NodalPointSuggestWithGeoDataByAddressV0NodalPointContact[] | null Example |
|
npCountry |
Type: string | null Example: |
|
transshipmentTypes |
Type: string[] | null Example |
Example
{
"addressComment": "example",
"createdAt": "2025-07-22T20:21:19.773333823Z",
"forwarderId": "example",
"id": "example",
"lastUsedAt": "2025-07-22T20:21:19.773333823Z",
"legalAddress": "example",
"legalPhone": "example",
"nodalPointContacts": [
{
"id": "example",
"npId": "example",
"personalData": {
"email": "example",
"id": "example",
"name": "example",
"phone": "example"
}
}
],
"npCountry": "example",
"npLegalType": "example",
"npName": "example",
"npTin": "example",
"timezoneIdentifier": "example",
"transshipmentTypes": [
"example"
],
"utcOffset": "example"
}
NodalPointSuggestWithGeoDataByAddressV0FoundAddress
|
Name |
Description |
|
accuracy |
Type: string уровень точности Example: |
|
address |
Type: string адрес, например Example: |
|
displayAddress |
Type: string адрес для основного отображения, например Example: |
|
lat |
Type: number широта |
|
lon |
Type: number долгота |
|
area |
Type: string | null район Example: |
|
house |
Type: string | null дом Example: |
|
locality |
Type: string | null город Example: |
|
nodalPoint |
Any of 2 types
Example |
|
province |
Type: string | null провинция Example: |
|
street |
Type: string | null улица Example: |
Example
{
"accuracy": "example",
"address": "example",
"area": "example",
"displayAddress": "example",
"house": "example",
"lat": 0.5,
"locality": "example",
"lon": 0.5,
"nodalPoint": {
"addressComment": "example",
"createdAt": "2025-07-22T20:21:19.773333823Z",
"forwarderId": "example",
"id": "example",
"lastUsedAt": "2025-07-22T20:21:19.773333823Z",
"legalAddress": "example",
"legalPhone": "example",
"nodalPointContacts": [
{
"id": "example",
"npId": "example",
"personalData": {}
}
],
"npCountry": "example",
"npLegalType": "example",
"npName": "example",
"npTin": "example",
"timezoneIdentifier": "example",
"transshipmentTypes": [
"example"
],
"utcOffset": "example"
},
"province": "example",
"street": "example"
}
NodalPointSuggestWithGeoDataByAddressV0Response
|
Name |
Description |
|
foundAddresses |
Type: NodalPointSuggestWithGeoDataByAddressV0FoundAddress[] | null Example |
Example
{
"foundAddresses": [
{
"accuracy": "example",
"address": "example",
"area": "example",
"displayAddress": "example",
"house": "example",
"lat": 0.5,
"locality": "example",
"lon": 0.5,
"nodalPoint": {
"addressComment": "example",
"createdAt": "2025-07-22T20:21:19.773333823Z",
"forwarderId": "example",
"id": "example",
"lastUsedAt": "2025-07-22T20:21:19.773333823Z",
"legalAddress": "example",
"legalPhone": "example",
"nodalPointContacts": [
null
],
"npCountry": "example",
"npLegalType": "example",
"npName": "example",
"npTin": "example",
"timezoneIdentifier": "example",
"transshipmentTypes": [
null
],
"utcOffset": "example"
},
"province": "example",
"street": "example"
}
]
}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |
Error
|
Name |
Description |
|
info |
Type: object Example |
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |