API Реестры

Работа с реестрами экспресс-накладных

Загрузить информацию по одному реестру

Работа с реестрами приема-передачи отправлений

Для передачи оформленных отправлений по Реестру, интегрируется функционал формирования и удаления реестров приема-передачи отправлений.

При передаче отправлений по Реестру необходимо на каждом отправлении размещать маркировку и распечатать два экземпляра Реестра.

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
Тип формата текста, отправляемого в API.

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

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

{
  "modelName": "ScanSheet",
  "calledMethod": "getScanSheet",
  "methodProperties": {
    "Ref": "acf7a47c-73b6-11e4-ab6d-005056801329"
  },
  "apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?> <file> <apiKey>[ВАШ КЛЮЧ]</apiKey> <modelName>ScanSheet</modelName> <calledMethod>getScanSheet</calledMethod> <methodProperties> <Ref> <item>acf7a47c-73b6-11e4-ab6d-005056801329</item> </Ref> </methodProperties> </file>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор
Number int[36] Номер реестра
DateTime int[36] Дата создания
Count int[36] Kоличество документов в реестре
CitySenderRef string[36] Идентификатор города отправителя
CitySender string[36] Текстовое представление города отправителя
SenderAddressRef string[36] Идентификатор адреса отправителя
SenderAddress string[36] Текстовое представление адреса отправителя
SenderRef string[36] Идентификатор контрагента отправителя
Sender string[36] Текстовое представление контрагента отправителя

{
  "success": true,
  "data": [
    {
      "Ref": "956aeca5-cef6-11e4-bdb5-005056801329",
      "Number": "105-00003134",
      "DateTime": "2015-03-20T13:45:19+00:00",
      "Count": "2",
      "CitySenderRef": "8d5a980d-391c-11dd-90d9-001a92567626",
      "CitySender": "Київ",
      "SenderAddressRef": "0d545ecf-e1c2-11e3-8c4a-0050568002cf",
      "SenderAddress": "м. Київ, Відділення №87 (до 30 кг), вул. Княжий Затон, 14б",
      "SenderRef": "5953fb16-08d8-11e4-8958-0025909b4e33",
      "Sender": "CBS-369138 "
    }
  ],
  "errors": [],
  "warnings": [],
  "info": []
}
<?xml version="1.0" encoding="UTF-8"?> <root> <data> <element> <CitySender>Київ</CitySender> <CitySenderRef>8d5a980d-391c-11dd-90d9-001a92567626</CitySenderRef> <Count>2</Count> <DateTime>2015-03-20 13:45:19</DateTime> <Number>105-00003134</Number> <Ref>956aeca5-cef6-11e4-bdb5-005056801329</Ref> <Sender>CBS-369138</Sender> <SenderAddress>м. Київ, Відділення №87 (до 30 кг), вул. Княжий Затон, 14б</SenderAddress> <SenderAddressRef>0d545ecf-e1c2-11e3-8c4a-0050568002cf</SenderAddressRef> <SenderRef>5953fb16-08d8-11e4-8958-0025909b4e33</SenderRef> </element> </data> <errors /> <info /> <success>true</success> <warnings /> </root>