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

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

Виды груза

Метод «getCargoTypes», работает в модели «Common», этот метод необходим для скачивания списка типов груза на Украинском языке.
Для обновления данных, справочник необходимо загружать один раз в месяц.

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

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

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

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

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

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

{
"modelName": "Common",
"calledMethod": "getCargoTypes",
"methodProperties": {},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getCargoTypes</calledMethod>
<methodProperties />
<modelName>Common</modelName>
</file>

Ответ 200

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


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

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

{
  "success": true,
  "data": [
    {
      "Description": "Вантаж",
      "Ref": "Cargo"
    },
    {
      "Description": "Документи",
      "Ref": "Documents"
    },
    {
      "Description": "Шини-диски",
      "Ref": "TiresWheels"
    },
    {
      "Description": "Палети",
      "Ref": "Pallet"
    },
    {
      "Description": "Посилка",
      "Ref": "Parcel"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": [],
  "messageCodes": [],
  "errorCodes": [],
  "warningCodes": [],
  "infoCodes": []
}
<root>
	<success>true</success>
	<data>
		<item>
			<Description>Вантаж</Description>
			<Ref>Cargo</Ref>
		</item>
		<item>
			<Description>Документи</Description>
			<Ref>Documents</Ref>
		</item>
		<item>
			<Description>Шини-диски</Description>
			<Ref>TiresWheels</Ref>
		</item>
		<item>
			<Description>Палети</Description>
			<Ref>Pallet</Ref>
		</item>
<item>
			<Description>Посилка</Description>
			<Ref>Parcel</Ref>
		</item>
	</data>
	<errors />
	<warnings />
	<info />
</root>