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 Имя вызываемого метода
* Обозначение обязательного параметра

{
  "modelName": "ScanSheet",
  "calledMethod": "getScanSheetList",
  "apiKey": "[ВАШ КЛЮЧ]"
}
<?xml version="1.0" encoding="utf-8"?> <file> <apiKey>[ВАШ КЛЮЧ]</apiKey> <modelName>ScanSheet</modelName> <calledMethod>getScanSheetList</calledMethod> </file>

Ответ 200

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


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

Параметр Тип данных Описание
Ref string[36] Идентификатор адреса
Number int[50] Номер реестра
DateTime int[50] Дата создания
Printed int[50] Признак, распечатан ли реестр

{
  "success": true,
  "data": [
    {
      "Ref": "956aeca5-cef6-11e4-bdb5-005056801329",
      "Number": "105-00003134",
      "DateTime": "2015-03-20T13:45:19+00:00",
      "Printed": "0"
    },
    {
      "Ref": "21badca6-ceda-11e4-bdb5-005056801329",
      "Number": "105-00003131",
      "DateTime": "2015-03-20T10:21:39+00:00",
      "Printed": "0"
    },
    {
      "Ref": "745bad26-ce45-11e4-bdb5-005056801329",
      "Number": "105-00003125",
      "DateTime": "2015-03-19T16:37:22+00:00",
      "Printed": "0"
    },
    {
      "Ref": "df204c73-ce38-11e4-bdb5-005056801329",
      "Number": "105-00003124",
      "DateTime": "2015-03-19T15:07:18+00:00",
      "Printed": "0"
    },
    {
      "Ref": "34889997-ce38-11e4-bdb5-005056801329",
      "Number": "105-00003123",
      "DateTime": "2015-03-19T15:02:32+00:00",
      "Printed": "0"
    },
    {
      "Ref": "21a8eb5b-ce38-11e4-bdb5-005056801329",
      "Number": "105-00003122",
      "DateTime": "2015-03-19T15:02:00+00:00",
      "Printed": "0"
    },
    {
      "Ref": "9db895db-ce37-11e4-bdb5-005056801329",
      "Number": "105-00003121",
      "DateTime": "2015-03-19T14:58:19+00:00",
      "Printed": "0"
    },
    {
      "Ref": "de872c3c-ce30-11e4-bdb5-005056801329",
      "Number": "105-00003120",
      "DateTime": "2015-03-19T14:10:01+00:00",
      "Printed": "0"
    },
    {
      "Ref": "ed676f43-ce1e-11e4-bdb5-005056801329",
      "Number": "105-00003119",
      "DateTime": "2015-03-19T12:01:35+00:00",
      "Printed": "0"
    },
    {
      "Ref": "bf5b9647-7156-11e4-ab6d-005056801329",
      "Number": "105-00003055",
      "DateTime": "2014-11-21T10:16:53+00:00",
      "Printed": "1"
    },
    {
      "Ref": "62f578cb-6fea-11e4-ab6d-005056801329",
      "Number": "105-00003054",
      "DateTime": "2014-11-19T14:48:18+00:00",
      "Printed": "0"
    },
    {
      "Ref": "4bb1528f-6fea-11e4-ab6d-005056801329",
      "Number": "105-00003053",
      "DateTime": "2014-11-19T14:48:00+00:00",
      "Printed": "0"
    }
  ],
  "errors": [],
  "warnings": [],
  "info": []
}
<?xml version="1.0" encoding="UTF-8"?> <root> <data> <element> <DateTime>2015-03-20 13:45:19</DateTime> <Number>105-00003134</Number> <Printed>0</Printed> <Ref>956aeca5-cef6-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-20 10:21:39</DateTime> <Number>105-00003131</Number> <Printed>0</Printed> <Ref>21badca6-ceda-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 16:37:22</DateTime> <Number>105-00003125</Number> <Printed>0</Printed> <Ref>745bad26-ce45-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 15:07:18</DateTime> <Number>105-00003124</Number> <Printed>0</Printed> <Ref>df204c73-ce38-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 15:02:32</DateTime> <Number>105-00003123</Number> <Printed>0</Printed> <Ref>34889997-ce38-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 15:02:00</DateTime> <Number>105-00003122</Number> <Printed>0</Printed> <Ref>21a8eb5b-ce38-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 14:58:19</DateTime> <Number>105-00003121</Number> <Printed>0</Printed> <Ref>9db895db-ce37-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 14:10:01</DateTime> <Number>105-00003120</Number> <Printed>0</Printed> <Ref>de872c3c-ce30-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2015-03-19 12:01:35</DateTime> <Number>105-00003119</Number> <Printed>0</Printed> <Ref>ed676f43-ce1e-11e4-bdb5-005056801329</Ref> </element> <element> <DateTime>2014-11-21 10:16:53</DateTime> <Number>105-00003055</Number> <Printed>1</Printed> <Ref>bf5b9647-7156-11e4-ab6d-005056801329</Ref> </element> <element> <DateTime>2014-11-19 14:48:18</DateTime> <Number>105-00003054</Number> <Printed>0</Printed> <Ref>62f578cb-6fea-11e4-ab6d-005056801329</Ref> </element> <element> <DateTime>2014-11-19 14:48:00</DateTime> <Number>105-00003053</Number> <Printed>0</Printed> <Ref>4bb1528f-6fea-11e4-ab6d-005056801329</Ref> </element> </data> <errors /> <info /> <success>true</success> <warnings /> </root>