API Реестры
Работа с реестрами экспресс-накладных
- Добавить экспресс-накладные
- Загрузить информацию по одному реестру
- Загрузить список реестров
- Удалить (расформировать) реестр отправлений
- Удалить экспресс-накладные из реестра
Удалить (расформировать) реестр отправлений
После удаления реестра, из информационной системы "Новая Почта" удаляется номер реестра, а экспресс-накладные, которые были включены в него освобождаются, но не удаляются (происходит расформирование реестра). Для удаления реестра необходимо сформировать соответствующий запрос.
Работа с реестрами приема-передачи отправлений
Для передачи оформленных отправлений по Реестру, интегрируется функционал формирования и удаления реестров приема-передачи отправлений.
При передаче отправлений по Реестру необходимо на каждом отправлении размещать маркировку и распечатать два экземпляра Реестра.
URL для входа https://api.novaposhta.ua/v2.0/{format}/ [json or xml]
Формат, обязательно, должен указываться нижним регистром (маленькими буквами), например https://api.novaposhta.ua/v2.0/json/
Доступность: Требует использования API-ключа.
URL-адрес запроса
Параметры запроса
Форматы JSON, XML
Точка входа для сервисов в формате JSON с форматом ответа JSONP ?callback=?
Заголовки запросов
Текст запроса
Параметр | Тип данных | Описание |
apiKey* | string[36] | Ваш ключ API 2.0 |
modelName* | string | Имя модели |
calledMethod* | string | Имя вызываемого метода |
methodProperties | string | Свойство метода |
ScanSheetRefs* | string | Массив идентификаторов реестров |
{
"modelName": "ScanSheet",
"calledMethod": "deleteScanSheet",
"methodProperties": {
"ScanSheetRefs": [
"832029fe-718c-11e4-ab6d-005056801329",
"832029fe-718c-11e4-ab6d-005056801329"
]
},
"apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ScanSheet</modelName>
<calledMethod>deleteScanSheet</calledMethod>
<methodProperties>
<ScanSheetRefs>
<item>ffb95548-b071-11e4-ac12-005056801333</item>
<item>ffb95548-b071-11e4-ac12-005056801334</item>
<item>ffb95548-b071-11e4-ac12-005056801335</item>
</ScanSheetRefs>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор |
Number | string[36] | Идентификатор |
{
"success": true,
"data": {
"ScanSheetRefs": {
"Errors": [
{
"Ref": "832029fe-718c-11e4-ab6d-005056801329",
"Error": "ScanSheet is invalid",
"Number": "832029fe-718c-11e4-ab6d-005056801329"
},
{
"Ref": "832029fe-718c-11e4-ab6d-005056801329",
"Error": "ScanSheet is invalid",
"Number": "832029fe-718c-11e4-ab6d-005056801329"
}
],
"Success": []
}
},
"errors": [],
"warnings": [],
"info": []
}
<root>
<success>true</success>
<data>
<ScanSheetRefs>
<Errors>
<item>
<Ref>ffb95548-b071-11e4-ac12-005056801333</Ref>
<Error>ScanSheet is invalid</Error>
<Number>105-00020571</Number>
</item>
<item>
<Ref>ffb95548-b071-11e4-ac12-005056801334</Ref>
<Error>ScanSheet is invalid</Error>
<Number>ffb95548-b071-11e4-ac12-005056801334</Number>
</item>
<item>
<Ref>ffb95548-b071-11e4-ac12-005056801335</Ref>
<Error>ScanSheet is invalid</Error>
<Number>ffb95548-b071-11e4-ac12-005056801335</Number>
</item>
</Errors>
<Success />
</ScanSheetRefs>
</data>
<errors />
<warnings />
<info />
</root>