API Справочники

Работа со справочниками.

Виды плательщиков

Метод «getTypesOfPayers», работает в модели «Common», этот метод необходим для загрузки списка видов плательщиков услуги доставки на украинском и на русском языках: Отправитель, Получатель, Третье лицо. Вид плательщика "Третье лицо" возможно заказать только после заключения договора с компанией "Новая Почта".
Для обновления данных, справочник необходимо загружать один раз в месяц.

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

Try it

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

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

string

Форматы JSON, XML

(дополнительный)
string

Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?

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

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

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

Параметр Тип данных Описание
apiKey* string[36] Ваш ключ API 2.0
modelName* string Имя модели
calledMethod* string Имя вызываемого метода
methodProperties string Свойства метода
* Обозначение обязательного параметра

{
"modelName": "Common",
"calledMethod": "getTypesOfPayers",
"methodProperties": {}
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<calledMethod>getTypesOfPayers</calledMethod>
<methodProperties />
<modelName>Common</modelName>
</file>

Ответ 200

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


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

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

{
  "success": true,
  "data": [
    {
      "Description": "Відправник",
      "Ref": "Sender"
    },
    {
      "Description": "Одержувач",
      "Ref": "Recipient"
    },
    {
      "Description": "Третя особа",
      "Ref": "ThirdPerson"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<root>
	<success>true</success>
	<data>
		<item>
			 <Description>Відправник</Description>
                         <Ref>Sender</Ref>
		</item>
		<item>
			 <Description>Одержувач</Description>
			<Ref>Recipient</Ref>
		</item>
		<item>
			<Description>Третя особа</Description>
			<Ref>ThirdPerson</Ref>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>