Реєстри
Робота із реєстрами експрес-накладних
Метод insertDocuments працює в моделі ScanSheetGeneral і застосовується для передачі оформлених відправлень за реєстром. У відповідь на запит формування реєстру повертається номер реєстру та номери відправлень зі статусом «Додано» або «Не додано».
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 275
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ScanSheetGeneral",
"calledMethod": "insertDocuments",
"methodProperties": {
"DocumentRefs": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"
],
"Ref": "00000000-0000-0000-0000-000000000000",
"Date": "01.01.2022"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Description": "№1",
"Ref": "00000000-0000-0000-0000-000000000000",
"Number": "105-00003134",
"Date": "01.01.2022",
"Errors": [],
"Warnings": [],
"Data": null,
"Success": [
{
"Ref": "2f48a93a-14d4-11ee-a60f-48df37b921db",
"Number": "20450733330073"
}
]
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод insertDocuments працює в моделі ScanSheetGeneral і застосовується для передачі оформлених відправлень за реєстром. У відповідь на запит формування реєстру повертається номер реєстру та номери відправлень зі статусом «Додано» або «Не додано».
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 512
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ScanSheetGeneral</modelName>
<calledMethod>insertDocuments</calledMethod>
<methodProperties>
<DocumentRefs>
<item>00000000-0000-0000-0000-000000000000</item>
<item>00000000-0000-0000-0000-000000000000</item>
</DocumentRefs>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Date>01.01.2022</Date>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Description>№1</Description>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Number>105-00003134</Number>
<Date>01.01.2022</Date>
<Errors/>
<Warnings/>
<Data/>
<Success>
<item>
<Ref>2f48a93a-14d4-11ee-a60f-48df37b921db</Ref>
<Number>20450733330073</Number>
</item>
</Success>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getScanSheet працює в моделі ScanSheetGeneral і використовується для отримання інформації за одним вибраним реєстром.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
ScanSheetGeneralPossible values: Назва методу API
getScanSheetPossible values: Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 214
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ScanSheetGeneral",
"calledMethod": "getScanSheet",
"methodProperties": {
"Ref": "00000000-0000-0000-0000-000000000000",
"CounterpartyRef": "00000000-0000-0000-0000-000000000000"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Number": "105-00003134",
"DateTime": "2015-03-20T13:45:19+00:00",
"Count": "2",
"CitySenderRef": "00000000-0000-0000-0000-000000000000",
"CitySender": "Київ",
"SenderAddressRef": "00000000-0000-0000-0000-000000000000",
"SenderAddress": "м. Київ, Відділення №87 (до 30 кг), вул. Княжий Затон, 14б",
"SenderRef": "00000000-0000-0000-0000-000000000000",
"Sender": "CBS-369138"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getScanSheet працює в моделі ScanSheetGeneral і використовується для отримання інформації за одним вибраним реєстром.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 382
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ScanSheetGeneral</modelName>
<calledMethod>getScanSheet</calledMethod>
<methodProperties>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<CounterpartyRef>00000000-0000-0000-0000-000000000000</CounterpartyRef>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Number>105-00003134</Number>
<DateTime>2015-03-20T13:45:19+00:00</DateTime>
<Count>2</Count>
<CitySenderRef>00000000-0000-0000-0000-000000000000</CitySenderRef>
<CitySender>Київ</CitySender>
<SenderAddressRef>00000000-0000-0000-0000-000000000000</SenderAddressRef>
<SenderAddress>м. Київ, Відділення №87 (до 30 кг), вул. Княжий Затон, 14б</SenderAddress>
<SenderRef>00000000-0000-0000-0000-000000000000</SenderRef>
<Sender>CBS-369138</Sender>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод getScanSheetList працює в моделі ScanSheetGeneral і використовується для отримання списку реєстрів.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
ScanSheetGeneralPossible values: Назва методу API
getScanSheetListPossible values: Об'єкт додаткових параметрів запиту (для даного методу порожній)
Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ScanSheetGeneral",
"calledMethod": "getScanSheetList",
"methodProperties": {}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Number": "105-00003134",
"DateTime": "2021-03-20T13:45:19+00:00",
"Printed": "0"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод getScanSheetList працює в моделі ScanSheetGeneral і використовується для отримання списку реєстрів.
API-ключ користувача
Назва моделі API
Назва методу API
Об'єкт додаткових параметрів запиту (для даного методу порожній)
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 248
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ScanSheetGeneral</modelName>
<calledMethod>getScanSheetList</calledMethod>
<methodProperties>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Number>105-00003134</Number>
<DateTime>2021-03-20T13:45:19+00:00</DateTime>
<Printed>0</Printed>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод deleteScanSheet працює в моделі ScanSheetGeneral і використовується для видалення реєстру.
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
ScanSheetGeneralPossible values: Назва методу API
deleteScanSheetPossible values: Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 211
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ScanSheetGeneral",
"calledMethod": "deleteScanSheet",
"methodProperties": {
"ScanSheetRefs": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"
]
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"Ref": "00000000-0000-0000-0000-000000000000",
"Number": "00000000-0000-0000-0000-000000000000",
"Error": "ScanSheet is invalid"
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод deleteScanSheet працює в моделі ScanSheetGeneral і використовується для видалення реєстру.
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 424
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ScanSheetGeneral</modelName>
<calledMethod>deleteScanSheet</calledMethod>
<methodProperties>
<ScanSheetRefs>
<item>00000000-0000-0000-0000-000000000000</item>
<item>00000000-0000-0000-0000-000000000000</item>
</ScanSheetRefs>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
<Number>00000000-0000-0000-0000-000000000000</Number>
<Error>ScanSheet is invalid</Error>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Метод removeDocuments працює в моделі ScanSheetGeneral і використовується для видалення експрес-накладних (ЕН) із реєстру в інформаційній системі «Нова пошта».
API-ключ користувача
[ВАШ КЛЮЧ]Назва моделі API
ScanSheetGeneralPossible values: Назва методу API
removeDocumentsPossible values: Успішна відповідь (JSON)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/json/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/json
Accept: */*
Content-Length: 255
{
"apiKey": "[ВАШ КЛЮЧ]",
"modelName": "ScanSheetGeneral",
"calledMethod": "removeDocuments",
"methodProperties": {
"DocumentRefs": [
"00000000-0000-0000-0000-000000000000",
"00000000-0000-0000-0000-000000000000"
],
"Ref": "00000000-0000-0000-0000-000000000000"
}
}Успішна відповідь (JSON)
{
"success": true,
"data": [
{
"DocumentRefs": {
"Errors": [],
"Success": [
{
"Ref": "b5bfee68-0000-1111-2223-48df37b921da",
"Number": "20450123456789",
"Document": "751299fb-0000-2222-3333-48df37b921da"
}
]
}
}
],
"errors": [],
"warnings": [],
"info": [],
"messageCodes": [],
"errorCodes": [],
"warningCodes": [],
"infoCodes": []
}Метод removeDocuments працює в моделі ScanSheetGeneral і використовується для видалення експрес-накладних (ЕН) із реєстру в інформаційній системі «Нова пошта».
API-ключ користувача
Назва моделі API
Назва методу API
Успішна відповідь (XML)
Прапор успішності виконання запиту
Масив повідомлень про помилки
Масив попереджень
Масив інформаційних повідомлень
Масив кодів інформаційних повідомлень
Масив кодів помилок
Масив кодів попереджень
Масив кодів додаткової інформації
POST /v2.0/xml/ HTTP/1.1
Host: api.novaposhta.ua/
Content-Type: application/xml
Accept: */*
Content-Length: 479
"<?xml version="1.0" encoding="UTF-8"?>
<file>
<apiKey>[ВАШ КЛЮЧ]</apiKey>
<modelName>ScanSheetGeneral</modelName>
<calledMethod>removeDocuments</calledMethod>
<methodProperties>
<DocumentRefs>
<item>00000000-0000-0000-0000-000000000000</item>
<item>00000000-0000-0000-0000-000000000000</item>
</DocumentRefs>
<Ref>00000000-0000-0000-0000-000000000000</Ref>
</methodProperties>
</file>
"Успішна відповідь (XML)
<?xml version="1.0" encoding="UTF-8"?>
<root>
<success>true</success>
<data>
<item>
<DocumentRefs>
<Errors/>
<Success>
<item>
<Ref>b5bfee68-0000-1111-2223-48df37b921da</Ref>
<Number>20450123456789</Number>
<Document>751299fb-0000-2222-3333-48df37b921da</Document>
</item>
</Success>
</DocumentRefs>
</item>
</data>
<errors/>
<warnings/>
<info/>
<messageCodes/>
<errorCodes/>
<warningCodes/>
<infoCodes/>
</root>
Останнє оновлення