API Адреса

Работа с адресами

Создать адрес контрагента (отправитель/получатель)

Метод «Save» , работает в модели «Address» , этот метод сохраняет адреса контрагента отправителя/получателя.

URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]/
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/


Доступность: Требует использования API-ключа.

Try it

URL-адрес запроса

Параметры запроса

string

Форматы JSON, XML

Заголовки запросов

(дополнительный)
string
Тип формата текста, отправляемого в API.

Текст запроса

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties*   Свойства метода
CounterpartyRef* string[36] Идентификатор контрагента
StreetRef* string[36] Идентификатор улицы
BuildingNumber* string Номер дома
Flat* string Квартира
Note string[40] Комментарий
* Обозначение обязательного параметра

{
"modelName": "Address",
"calledMethod": "save",
"methodProperties": {
"CounterpartyRef": "5ace4a2e-13ee-11e5-add9-005056887b8d",
"StreetRef": "d4450bdb-0a58-11de-b6f5-001d92f78697",
"BuildingNumber": "7",
"Flat": "2", 
"Note": "Комментарий" 
},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
 <modelName>Address</modelName>
 <calledMethod>save</calledMethod>
  <methodProperties>
    <CounterpartyRef>5ace4a2e-13ee-11e5-add9-005056887b8d</CounterpartyRef>
    <StreetRef>d4450bdb-0a58-11de-b6f5-001d92f78697</StreetRef>
    <BuildingNumber>7</BuildingNumber>
    <Flat>2</Flat>
    <Note></Note>
 </methodProperties>
</file>

Ответ 200

Всегда возвращает код 200 даже при логических ошибках.


Тело ответа на запрос

Параметр Тип данных Описание
Ref string[36] Идентификатор адреса
Description string[50] Адрес

{
    "success": true,
    "data": [
        {
            "Ref": "e57f8afb-55f1-11e5-ad08-005056801333",
            "Description": "Жовтнева (Новобіличі) вул. 7 кв. 2 Комментарий"
        }
    ],
    "errors": [],
    "warnings": [
        "Building already exists",
        "Address already exists"
    ],
    "info": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
   <success>true</success>
   <data>
      <item>
         <Ref>d492290b-55f2-11e5-ad08-005056801333</Ref>
         <Description>Жовтнева (Новобіличі) вул. 7 кв. 2</Description>
      </item>
   </data>
   <errors />
   <warnings>
      <item>Building already exists</item>
   </warnings>
   <info />
</root>