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