API Справочники
Работа со справочниками.
- Виды временных интервалов
- Виды груза
- Виды обратной доставки груза
- Виды паллет
- Виды плательщиков
- Виды плательщиков обратной доставки
- Виды упаковки
- Виды шин и дисков
- Описания груза
- Перечень ошибок
- Технологии доставки
- Типы контрагентов
- Формы оплаты
- Формы собственности
Виды паллет
Метод «getPalletsList», работает в модели «Common», этот метод необходим для получения списка видов паллет. Для обновления данных, справочник необходимо загружать один раз в месяц.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
string
Форматы JSON, XML
(дополнительный)
string
Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?
Заголовки запросов
(дополнительный)
string
Тип формата текста, отправляемого в API.
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
{
"modelName": "Common",
"calledMethod": "getPalletsList",
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<calledMethod>getPalletsList</calledMethod>
<modelName>Common</modelName>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор паллеты |
Description | string[36] | Описание паллеты на Украинском |
DescriptionRu | string[36] | Описание паллеты на русском |
Weight | string[36] | Вес |
{
"success": true,
"data": [
{
"Ref": "627b0c23-d110-11dd-8c0d-001d92f78697",
"Description": "Палета від 1,5 м2 до 2 м2",
"DescriptionRu": "Паллета свыше 1,5 м2",
"Weight": "816.00"
},
{
"Ref": "627b0c24-d110-11dd-8c0d-001d92f78697",
"Description": "Палета від 1 м2 до 1,49 м2",
"DescriptionRu": "Паллета от 1 м2 до 1,5 м2",
"Weight": "612.00"
},
{
"Ref": "627b0c25-d110-11dd-8c0d-001d92f78697",
"Description": "Палета від 0,5 м2 до 0,99 м2",
"DescriptionRu": "Паллета от 0,5 м2 до 1м2",
"Weight": "408.00"
},
{
"Ref": "627b0c26-d110-11dd-8c0d-001d92f78697",
"Description": "Палета до 0,49 м2",
"DescriptionRu": "Паллета до 0,49 м2",
"Weight": "204.00"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>627b0c23-d110-11dd-8c0d-001d92f78697</Ref>
<Description>Палета від 1,5 м2 до 2 м2</Description>
<DescriptionRu>Паллета свыше 1,5 м2</DescriptionRu>
<Weight>816.00</Weight>
</item>
<item>
<Ref>627b0c24-d110-11dd-8c0d-001d92f78697</Ref>
<Description>Палета від 1 м2 до 1,49 м2</Description>
<DescriptionRu>Паллета от 1 м2 до 1,5 м2</DescriptionRu>
<Weight>612.00</Weight>
</item>
<item>
<Ref>627b0c25-d110-11dd-8c0d-001d92f78697</Ref>
<Description>Палета від 0,5 м2 до 0,99 м2</Description>
<DescriptionRu>Паллета от 0,5 м2 до 1м2</DescriptionRu>
<Weight>408.00</Weight>
</item>
<item>
<Ref>627b0c26-d110-11dd-8c0d-001d92f78697</Ref>
<Description>Палета до 0,49 м2</Description>
<DescriptionRu>Паллета до 0,49 м2</DescriptionRu>
<Weight>204.00</Weight>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>