> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/reyestri.md). # Реєстри :link:[*Початок роботи з API*](https://api-portal.novapost.com/api-docs-ua) ## Додати експрес-накладні до реєстру (JSON) > Метод \*\*insertDocuments\*\* працює в моделі \*\*ScanSheetGeneral\*\* і застосовується для передачі оформлених відправлень за реєстром. У відповідь на запит формування реєстру повертається номер реєстру та номери відправлень зі статусом «Додано» або «Не додано».\ > \ > \
\ > \Обмеження під час роботи з реєстрами\\ > \ > \- До реєстру можна додати інтернет-документ (ІД), якщо дані відправника (місто, контрагент, адреса) ідентичні для всіх відправлень, що додаються.\ > \- ІД можна додати лише до одного реєстру, тобто один і той самий документ не можна одночасно додати до кількох реєстрів.\ > \- До реєстру не можна додати ІД, якщо за документом вже отримано друковану форму і дата відправлення (друку) є меншою за дату, що передує даті формування реєстру.\ > \- ІД можна додати до реєстру лише до моменту створення експрес-накладної на основі ІД або проведення сканувань цього відправлення у відділенні/підрозділі компанії «Нова пошта».\ > \- До реєстру не можна додати ІД, що помічено на видалення.\ > \- Після отримання друкованої форми реєстру додання документів до нього блокується.\ > \ > \
\ > \ > \
\ > \Робота з реєстрами приймання-передачі відправлень\\ > \ > Для передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ScanSheet"],"operationId":"insertDocumentsJson","summary":"Додати експрес-накладні до реєстру (JSON)","description":"Метод **insertDocuments** працює в моделі **ScanSheetGeneral** і застосовується для передачі оформлених відправлень за реєстром. У відповідь на запит формування реєстру повертається номер реєстру та номери відправлень зі статусом «Додано» або «Не додано».\n\n
\nОбмеження під час роботи з реєстрами\n\n- До реєстру можна додати інтернет-документ (ІД), якщо дані відправника (місто, контрагент, адреса) ідентичні для всіх відправлень, що додаються.\n- ІД можна додати лише до одного реєстру, тобто один і той самий документ не можна одночасно додати до кількох реєстрів.\n- До реєстру не можна додати ІД, якщо за документом вже отримано друковану форму і дата відправлення (друку) є меншою за дату, що передує даті формування реєстру.\n- ІД можна додати до реєстру лише до моменту створення експрес-накладної на основі ІД або проведення сканувань цього відправлення у відділенні/підрозділі компанії «Нова пошта».\n- До реєстру не можна додати ІД, що помічено на видалення.\n- Після отримання друкованої форми реєстру додання документів до нього блокується.\n\n
\n\n
\nРобота з реєстрами приймання-передачі відправлень\n\nДля передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\n\n
\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsertDocumentsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsertDocumentsResponse"}}}}}}}},"components":{"schemas":{"InsertDocumentsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["insertDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/InsertDocumentsMethodProperties"}}},"InsertDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs"],"properties":{"DocumentRefs":{"type":"array","description":"Масив ідентифікаторів (REF) документів для додавання в реєстр","items":{"type":"string","format":"uuid","maxLength":36}},"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) реєстру, якщо потрібно додати документ у вже створений реєстр"},"Date":{"type":"string","maxLength":36,"description":"Дата, якщо потрібно створити реєстр на певну дату (у форматі ДД.ММ.РРРР)"}}},"InsertDocumentsResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив даних результату формування/оновлення реєстру","items":{"$ref":"#/components/schemas/ScanSheetResultItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"ScanSheetResultItem":{"type":"object","additionalProperties":false,"properties":{"Description":{"type":"string","maxLength":128,"description":"Назва реєстру (якщо була вказана під час створення)"},"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) реєстру"},"Number":{"type":"string","maxLength":36,"description":"Номер реєстру"},"Date":{"type":"string","maxLength":36,"description":"Дата реєстру"},"Errors":{"type":"array","description":"Масив, у якому вказані логічні помилки щодо збереження або оновлення реєстру","items":{"type":"string"}},"Warnings":{"type":"array","description":"Масив, у якому вказана додаткова інформація про помилки щодо збереження або оновлення реєстру","items":{"type":"string"}},"Data":{"type":"object","nullable":true,"description":"Об'єкт, у якому вказана інформація про помилки щодо документів, які не вдалось додати до реєстру"},"Success":{"type":"array","description":"Масив успішно доданих до реєстру документів","items":{"$ref":"#/components/schemas/SuccessDocumentItem"}}}},"SuccessDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) успішно доданого документа"},"Number":{"type":"string","maxLength":36,"description":"Номер успішно доданої експрес-накладної"}}}}}} ``` ## Додати експрес-накладні до реєстру (XML) > Метод \*\*insertDocuments\*\* працює в моделі \*\*ScanSheetGeneral\*\* і застосовується для передачі оформлених відправлень за реєстром. У відповідь на запит формування реєстру повертається номер реєстру та номери відправлень зі статусом «Додано» або «Не додано».\ > \ > \
\ > \Обмеження під час роботи з реєстрами\\ > \ > \- До реєстру можна додати інтернет-документ (ІД), якщо дані відправника (місто, контрагент, адреса) ідентичні для всіх відправлень, що додаються.\ > \- ІД можна додати лише до одного реєстру, тобто один і той самий документ не можна одночасно додати до кількох реєстрів.\ > \- До реєстру не можна додати ІД, якщо за документом вже отримано друковану форму і дата відправлення (друку) є меншою за дату, що передує даті формування реєстру.\ > \- ІД можна додати до реєстру лише до моменту створення експрес-накладної на основі ІД або проведення сканувань цього відправлення у відділенні/підрозділі компанії «Нова пошта».\ > \- До реєстру не можна додати ІД, що помічено на видалення.\ > \- Після отримання друкованої форми реєстру додання документів до нього блокується.\ > \ > \
\ > \ > \
\ > \Робота з реєстрами приймання-передачі відправлень\\ > \ > Для передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ScanSheet"],"operationId":"insertDocumentsXml","summary":"Додати експрес-накладні до реєстру (XML)","description":"Метод **insertDocuments** працює в моделі **ScanSheetGeneral** і застосовується для передачі оформлених відправлень за реєстром. У відповідь на запит формування реєстру повертається номер реєстру та номери відправлень зі статусом «Додано» або «Не додано».\n\n
\nОбмеження під час роботи з реєстрами\n\n- До реєстру можна додати інтернет-документ (ІД), якщо дані відправника (місто, контрагент, адреса) ідентичні для всіх відправлень, що додаються.\n- ІД можна додати лише до одного реєстру, тобто один і той самий документ не можна одночасно додати до кількох реєстрів.\n- До реєстру не можна додати ІД, якщо за документом вже отримано друковану форму і дата відправлення (друку) є меншою за дату, що передує даті формування реєстру.\n- ІД можна додати до реєстру лише до моменту створення експрес-накладної на основі ІД або проведення сканувань цього відправлення у відділенні/підрозділі компанії «Нова пошта».\n- До реєстру не можна додати ІД, що помічено на видалення.\n- Після отримання друкованої форми реєстру додання документів до нього блокується.\n\n
\n\n
\nРобота з реєстрами приймання-передачі відправлень\n\nДля передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\n\n
\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/InsertDocumentsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/InsertDocumentsXmlResponse"}}}}}}}},"components":{"schemas":{"InsertDocumentsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["insertDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/InsertDocumentsXmlMethodProperties"}}},"InsertDocumentsXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/InsertDocumentsMethodProperties"}],"xml":{"name":"methodProperties"},"properties":{"DocumentRefs":{"type":"array","description":"Масив ідентифікаторів документів","xml":{"name":"DocumentRefs","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"InsertDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs"],"properties":{"DocumentRefs":{"type":"array","description":"Масив ідентифікаторів (REF) документів для додавання в реєстр","items":{"type":"string","format":"uuid","maxLength":36}},"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) реєстру, якщо потрібно додати документ у вже створений реєстр"},"Date":{"type":"string","maxLength":36,"description":"Дата, якщо потрібно створити реєстр на певну дату (у форматі ДД.ММ.РРРР)"}}},"InsertDocumentsXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив даних результату формування/оновлення реєстру","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/ScanSheetResultXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"ScanSheetResultXmlItem":{"allOf":[{"$ref":"#/components/schemas/ScanSheetResultItem"}],"xml":{"name":"item"},"properties":{"Errors":{"type":"array","xml":{"name":"Errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"Warnings":{"type":"array","xml":{"name":"Warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"Success":{"type":"array","xml":{"name":"Success","wrapped":true},"items":{"$ref":"#/components/schemas/SuccessDocumentXmlItem"}}}},"ScanSheetResultItem":{"type":"object","additionalProperties":false,"properties":{"Description":{"type":"string","maxLength":128,"description":"Назва реєстру (якщо була вказана під час створення)"},"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) реєстру"},"Number":{"type":"string","maxLength":36,"description":"Номер реєстру"},"Date":{"type":"string","maxLength":36,"description":"Дата реєстру"},"Errors":{"type":"array","description":"Масив, у якому вказані логічні помилки щодо збереження або оновлення реєстру","items":{"type":"string"}},"Warnings":{"type":"array","description":"Масив, у якому вказана додаткова інформація про помилки щодо збереження або оновлення реєстру","items":{"type":"string"}},"Data":{"type":"object","nullable":true,"description":"Об'єкт, у якому вказана інформація про помилки щодо документів, які не вдалось додати до реєстру"},"Success":{"type":"array","description":"Масив успішно доданих до реєстру документів","items":{"$ref":"#/components/schemas/SuccessDocumentItem"}}}},"SuccessDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) успішно доданого документа"},"Number":{"type":"string","maxLength":36,"description":"Номер успішно доданої експрес-накладної"}}},"SuccessDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/SuccessDocumentItem"}],"xml":{"name":"item"}}}}} ``` ## Отримати інформацію за вибраним реєстром (JSON) > Метод \*\*getScanSheet\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для отримання інформації за одним вибраним реєстром.\ > \ > \
\ > \Робота з реєстрами приймання-передачі відправлень\\ > \ > Для передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ScanSheet"],"operationId":"getScanSheetJson","summary":"Отримати інформацію за вибраним реєстром (JSON)","description":"Метод **getScanSheet** працює в моделі **ScanSheetGeneral** і використовується для отримання інформації за одним вибраним реєстром.\n\n
\nРобота з реєстрами приймання-передачі відправлень\n\nДля передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\n\n
\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScanSheetJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScanSheetJsonResponse"}}}}}}}},"components":{"schemas":{"GetScanSheetJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getScanSheet"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetScanSheetMethodProperties"}}},"GetScanSheetMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","CounterpartyRef"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) реєстру"},"CounterpartyRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента"}}},"GetScanSheetJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив з інформацією про вибраний реєстр","items":{"$ref":"#/components/schemas/GetScanSheetItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"GetScanSheetItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Number":{"type":"string","maxLength":36,"description":"Номер реєстру"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення"},"Count":{"type":"string","maxLength":36,"description":"Кількість документів у реєстрі"},"CitySenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"CitySender":{"type":"string","maxLength":36,"description":"Текстовий опис міста відправника"},"SenderAddressRef":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Текстовий опис адреси відправника"},"SenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента відправника"},"Sender":{"type":"string","maxLength":36,"description":"Текстовий опис контрагента відправника"}}}}}} ``` ## Отримати інформацію за вибраним реєстром (XML) > Метод \*\*getScanSheet\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для отримання інформації за одним вибраним реєстром.\ > \ > \
\ > \Робота з реєстрами приймання-передачі відправлень\\ > \ > Для передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ScanSheet"],"operationId":"getScanSheetXml","summary":"Отримати інформацію за вибраним реєстром (XML)","description":"Метод **getScanSheet** працює в моделі **ScanSheetGeneral** і використовується для отримання інформації за одним вибраним реєстром.\n\n
\nРобота з реєстрами приймання-передачі відправлень\n\nДля передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\n\n
\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetScanSheetXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetScanSheetXmlResponse"}}}}}}}},"components":{"schemas":{"GetScanSheetXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getScanSheet"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetScanSheetXmlMethodProperties"}}},"GetScanSheetXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetScanSheetMethodProperties"}],"xml":{"name":"methodProperties"}},"GetScanSheetMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","CounterpartyRef"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) реєстру"},"CounterpartyRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента"}}},"GetScanSheetXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив з інформацією про вибраний реєстр","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/GetScanSheetXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"GetScanSheetXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetScanSheetItem"}],"xml":{"name":"item"}},"GetScanSheetItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор"},"Number":{"type":"string","maxLength":36,"description":"Номер реєстру"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення"},"Count":{"type":"string","maxLength":36,"description":"Кількість документів у реєстрі"},"CitySenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"CitySender":{"type":"string","maxLength":36,"description":"Текстовий опис міста відправника"},"SenderAddressRef":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Текстовий опис адреси відправника"},"SenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента відправника"},"Sender":{"type":"string","maxLength":36,"description":"Текстовий опис контрагента відправника"}}}}}} ``` ## Завантажити список реєстрів (JSON) > Метод \*\*getScanSheetList\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для отримання списку реєстрів.\ > \ > \
\ > \Робота з реєстрами приймання-передачі відправлень\\ > \ > Для передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ScanSheet"],"operationId":"getScanSheetListJson","summary":"Завантажити список реєстрів (JSON)","description":"Метод **getScanSheetList** працює в моделі **ScanSheetGeneral** і використовується для отримання списку реєстрів.\n\n
\nРобота з реєстрами приймання-передачі відправлень\n\nДля передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\n\n
\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScanSheetListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetScanSheetListJsonResponse"}}}}}}}},"components":{"schemas":{"GetScanSheetListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getScanSheetList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetScanSheetListMethodProperties"}}},"GetScanSheetListMethodProperties":{"type":"object","additionalProperties":false,"description":"Об'єкт додаткових параметрів запиту (для даного методу порожній)"},"GetScanSheetListJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив із переліком реєстрів","items":{"$ref":"#/components/schemas/GetScanSheetListItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"GetScanSheetListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"Number":{"type":"string","maxLength":50,"description":"Номер реєстру"},"DateTime":{"type":"string","maxLength":50,"description":"Дата створення"},"Printed":{"type":"string","maxLength":50,"enum":["0","1"],"description":"Ознака друку реєстру (1 — реєстр роздруковано, 0 — реєстр не друкувався)"}}}}}} ``` ## Завантажити список реєстрів (XML) > Метод \*\*getScanSheetList\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для отримання списку реєстрів.\ > \ > \
\ > \Робота з реєстрами приймання-передачі відправлень\\ > \ > Для передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ScanSheet"],"operationId":"getScanSheetListXml","summary":"Завантажити список реєстрів (XML)","description":"Метод **getScanSheetList** працює в моделі **ScanSheetGeneral** і використовується для отримання списку реєстрів.\n\n
\nРобота з реєстрами приймання-передачі відправлень\n\nДля передачі оформлених відправлень за реєстром реалізовано функціонал формування та видалення реєстрів приймання-передачі відправлень. Під час передачі відправлень за реєстром необхідно нанести маркування на кожне відправлення та роздрукувати два примірники реєстру.\n\n
\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetScanSheetListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetScanSheetListXmlResponse"}}}}}}}},"components":{"schemas":{"GetScanSheetListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getScanSheetList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetScanSheetListXmlMethodProperties"}}},"GetScanSheetListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetScanSheetListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetScanSheetListMethodProperties":{"type":"object","additionalProperties":false,"description":"Об'єкт додаткових параметрів запиту (для даного методу порожній)"},"GetScanSheetListXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив із переліком реєстрів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/GetScanSheetListXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"GetScanSheetListXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetScanSheetListItem"}],"xml":{"name":"item"}},"GetScanSheetListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"Number":{"type":"string","maxLength":50,"description":"Номер реєстру"},"DateTime":{"type":"string","maxLength":50,"description":"Дата створення"},"Printed":{"type":"string","maxLength":50,"enum":["0","1"],"description":"Ознака друку реєстру (1 — реєстр роздруковано, 0 — реєстр не друкувався)"}}}}}} ``` ## Видалити (розформувати) реєстр відправлень (JSON) > Метод \*\*deleteScanSheet\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для видалення реєстру.\ > \ > \
\ > \Деталі щодо видалення реєстру\\ > \ > Після видалення реєстру з інформаційної системи «Нова пошта» номер реєстру видаляється. Експрес-накладні, що були включені до нього, звільняються, але не видаляються (відбувається розформування реєстру).\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ScanSheet"],"operationId":"deleteScanSheetJson","summary":"Видалити (розформувати) реєстр відправлень (JSON)","description":"Метод **deleteScanSheet** працює в моделі **ScanSheetGeneral** і використовується для видалення реєстру.\n\n
\nДеталі щодо видалення реєстру\n\nПісля видалення реєстру з інформаційної системи «Нова пошта» номер реєстру видаляється. Експрес-накладні, що були включені до нього, звільняються, але не видаляються (відбувається розформування реєстру).\n\n
\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteScanSheetJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteScanSheetJsonResponse"}}}}}}}},"components":{"schemas":{"DeleteScanSheetJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["deleteScanSheet"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteScanSheetMethodProperties"}}},"DeleteScanSheetMethodProperties":{"type":"object","additionalProperties":false,"required":["ScanSheetRefs"],"properties":{"ScanSheetRefs":{"type":"array","description":"Масив ідентифікаторів реєстрів","items":{"type":"string","format":"uuid","maxLength":36}}}},"DeleteScanSheetJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів видалення реєстрів","items":{"$ref":"#/components/schemas/DeleteScanSheetItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"DeleteScanSheetItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) видаленого реєстру"},"Number":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) номеру видаленого реєстру"},"Error":{"type":"string","maxLength":36,"description":"Помилка, через яку реєстр не видаляється"}}}}}} ``` ## Видалити (розформувати) реєстр відправлень (XML) > Метод \*\*deleteScanSheet\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для видалення реєстру.\ > \ > \
\ > \Деталі щодо видалення реєстру\\ > \ > Після видалення реєстру з інформаційної системи «Нова пошта» номер реєстру видаляється. Експрес-накладні, що були включені до нього, звільняються, але не видаляються (відбувається розформування реєстру).\ > \ > \

```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ScanSheet"],"operationId":"deleteScanSheetXml","summary":"Видалити (розформувати) реєстр відправлень (XML)","description":"Метод **deleteScanSheet** працює в моделі **ScanSheetGeneral** і використовується для видалення реєстру.\n\n
\nДеталі щодо видалення реєстру\n\nПісля видалення реєстру з інформаційної системи «Нова пошта» номер реєстру видаляється. Експрес-накладні, що були включені до нього, звільняються, але не видаляються (відбувається розформування реєстру).\n\n
\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteScanSheetXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteScanSheetXmlResponse"}}}}}}}},"components":{"schemas":{"DeleteScanSheetXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["deleteScanSheet"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteScanSheetXmlMethodProperties"}}},"DeleteScanSheetXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/DeleteScanSheetMethodProperties"}],"xml":{"name":"methodProperties"},"properties":{"ScanSheetRefs":{"type":"array","description":"Масив ідентифікаторів реєстрів","xml":{"name":"ScanSheetRefs","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"DeleteScanSheetMethodProperties":{"type":"object","additionalProperties":false,"required":["ScanSheetRefs"],"properties":{"ScanSheetRefs":{"type":"array","description":"Масив ідентифікаторів реєстрів","items":{"type":"string","format":"uuid","maxLength":36}}}},"DeleteScanSheetXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів видалення реєстрів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/DeleteScanSheetXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"DeleteScanSheetXmlItem":{"allOf":[{"$ref":"#/components/schemas/DeleteScanSheetItem"}],"xml":{"name":"item"}},"DeleteScanSheetItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) видаленого реєстру"},"Number":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) номеру видаленого реєстру"},"Error":{"type":"string","maxLength":36,"description":"Помилка, через яку реєстр не видаляється"}}}}}} ``` ## Видалити експрес-накладні з реєстру (JSON) > Метод \*\*removeDocuments\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для видалення експрес-накладних (ЕН) із реєстру в інформаційній системі «Нова пошта».
```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ScanSheet"],"operationId":"removeDocumentsJson","summary":"Видалити експрес-накладні з реєстру (JSON)","description":"Метод **removeDocuments** працює в моделі **ScanSheetGeneral** і використовується для видалення експрес-накладних (ЕН) із реєстру в інформаційній системі «Нова пошта».\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsJsonResponse"}}}}}}}},"components":{"schemas":{"RemoveDocumentsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["removeDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/RemoveDocumentsMethodProperties"}}},"RemoveDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs"],"properties":{"DocumentRefs":{"type":"array","description":"Масив ідентифікаторів документів, які необхідно видалити","items":{"type":"string","format":"uuid","maxLength":36}},"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) реєстру"}}},"RemoveDocumentsJsonResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів видалення документів","items":{"$ref":"#/components/schemas/RemoveDocumentsItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"RemoveDocumentsItem":{"type":"object","additionalProperties":false,"properties":{"DocumentRefs":{"$ref":"#/components/schemas/RemoveDocumentsResultObject"}}},"RemoveDocumentsResultObject":{"type":"object","additionalProperties":false,"description":"Відображає результат операції видалення документів з реєстру в інформаційній системі","properties":{"Errors":{"type":"array","description":"Масив, що містить опис помилок, які виникли під час спроби видалення документів з реєстру","items":{"type":"string"}},"Success":{"type":"array","description":"Масив об'єктів, кожен з яких представляє документ, що був успішно видалений з реєстру","items":{"$ref":"#/components/schemas/RemoveDocumentsSuccessItem"}}}},"RemoveDocumentsSuccessItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Унікальний ідентифікатор (REF) документа, який було видалено"},"Number":{"type":"string","description":"Номер ІД"},"Document":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор реєстру, з якого було видалено документ"}}}}}} ``` ## Видалити експрес-накладні з реєстру (XML) > Метод \*\*removeDocuments\*\* працює в моделі \*\*ScanSheetGeneral\*\* і використовується для видалення експрес-накладних (ЕН) із реєстру в інформаційній системі «Нова пошта».
```json {"openapi":"3.0.3","info":{"title":"API Nova Post — ScanSheet (Registers)","version":"2.0.0"},"tags":[{"name":"ScanSheet","description":"Операції з реєстрами приймання-передачі відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ScanSheet"],"operationId":"removeDocumentsXml","summary":"Видалити експрес-накладні з реєстру (XML)","description":"Метод **removeDocuments** працює в моделі **ScanSheetGeneral** і використовується для видалення експрес-накладних (ЕН) із реєстру в інформаційній системі «Нова пошта».\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsXmlResponse"}}}}}}}},"components":{"schemas":{"RemoveDocumentsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["ScanSheetGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["removeDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/RemoveDocumentsXmlMethodProperties"}}},"RemoveDocumentsXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/RemoveDocumentsMethodProperties"}],"xml":{"name":"methodProperties"},"properties":{"DocumentRefs":{"type":"array","description":"Масив ідентифікаторів документів, які необхідно видалити","xml":{"name":"DocumentRefs","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"RemoveDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs"],"properties":{"DocumentRefs":{"type":"array","description":"Масив ідентифікаторів документів, які необхідно видалити","items":{"type":"string","format":"uuid","maxLength":36}},"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор (REF) реєстру"}}},"RemoveDocumentsXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів видалення документів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/RemoveDocumentsXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"RemoveDocumentsXmlItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"DocumentRefs":{"$ref":"#/components/schemas/RemoveDocumentsXmlResultObject"}}},"RemoveDocumentsXmlResultObject":{"type":"object","additionalProperties":false,"description":"Відображає результат операції видалення документів з реєстру в інформаційній системі","properties":{"Errors":{"type":"array","description":"Масив, що містить опис помилок, які виникли під час спроби видалення документів з реєстру","xml":{"name":"Errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"Success":{"type":"array","description":"Масив об'єктів, кожен з яких представляє документ, що був успішно видалений з реєстру","xml":{"name":"Success","wrapped":true},"items":{"$ref":"#/components/schemas/RemoveDocumentsXmlSuccessItem"}}}},"RemoveDocumentsXmlSuccessItem":{"allOf":[{"$ref":"#/components/schemas/RemoveDocumentsSuccessItem"}],"xml":{"name":"item"}},"RemoveDocumentsSuccessItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","maxLength":36,"description":"Унікальний ідентифікатор (REF) документа, який було видалено"},"Number":{"type":"string","description":"Номер ІД"},"Document":{"type":"string","format":"uuid","maxLength":36,"description":"Ідентифікатор реєстру, з якого було видалено документ"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/reyestri.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.