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 | Свойства метода | |
DocumentRefs* | string[36] | Массив идентификаторов документов |
Ref | string[36] | Идентификатор реестра, если требуется добавить документы в существующий реестр |
Date | int[36] | Дата, если требуется создать реестр на определенную дату |
{
"modelName": "ScanSheet",
"calledMethod": "insertDocuments",
"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>insertDocuments</calledMethod>
<methodProperties>
<DocumentRefs>
<item>832029fe-718c-11e4-ab6d-005056801329</item>
</DocumentRefs>
</methodProperties>
</file>
Ответ 200
Всегда возвращает код 200 даже при логических ошибках.
Тело ответа на запрос
Параметр | Тип данных | Описание |
Ref | string[36] | Идентификатор |
Number | int[36] | Номер |
Date | string[36] | Дата |
{
"success": true,
"data": [
{
"Ref": "",
"Number": "",
"Date": "2015-06-01 16:06:27",
"Errors": [],
"Success": [],
"Warnings": [],
"Data": {
"Errors": [
{
"Ref": "832029fe-718c-11e4-ab6d-005056801329",
"Error": "Document not found in your scansheets",
"Number": ""
},
{
"Ref": "832029fe-718c-11e4-ab6d-005056801329",
"Error": "Document not found in your scansheets",
"Number": ""
}
],
"Success": [],
"Warnings": []
}
}
],
"errors": [],
"warnings": [],
"info": []
}
<root>
<success>true</success>
<data>
<item>
<Ref></Ref>
<Number></Number>
<Date>2015-06-01 16:10:22</Date>
<Errors />
<Success />
<Warnings />
<Data>
<Errors>
<item>
<Ref>832029fe-718c-11e4-ab6d-005056801329</Ref>
<Error>Document not found in your scansheets</Error>
<Number></Number>
</item>
</Errors>
<Success />
<Warnings />
</Data>
</item>
</data>
<errors />
<warnings />
<info />
</root>