> 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/ekspres-nakladna.md).
# Експрес-накладна
:link:[*Початок роботи з API*](https://api-portal.novapost.com/api-docs-ua)
### Створити експрес-накладну
## Створити експрес-накладну (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\
> \
> Зверніть увагу: Якщо вибрано тип доставки \`CargoType\`: \`Documents\`, доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\
> \
> \\
> \Створити ЕН зі зворотною доставкою\
\
> \
> У цьому запиті можна вказати зворотну доставку. Для цього потрібно додати параметр \`BackwardDeliveryData\`. Докладніше ознайомитися з варіантами зворотної доставки можна в розділі «Створити ЕН зі зворотною доставкою».\
> \
> \ \
> \
> \\
> \Створити експрес-накладну з оплатою від третьої особи\
\
> \
> Можна створити експрес-накладну з оплатою від третьої особи. У такому разі потрібно задати відповідні значення в параметрах \`PayerType\` та \`ThirdPerson\`:\
> \
> \`\`\`json\
> {\
> "PayerType": "ThirdPerson",\
> "ThirdPerson": "5953fb16-08d8-11e4-8958-0025909b4e33"\
> }\
> \`\`\`\
> \
> Для платника \`ThirdPerson\` форма оплати може бути лише «Безготівковий розрахунок».\
> \
> \ \
> \
> \\
> \Планова дата відправки\
\
> \
> У параметрі \`DateTime\` можна задати планову дату відправки. Значення \`DateTime\` не може перевищувати поточну дату більше ніж на 3 місяці.\
> \
> \ \
> \
> Накладна, створена в програмному середовищі API, відображається у списку експрес-накладних (ЕН) в особистому кабінеті.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveInternetDocumentJson","summary":"Створити експрес-накладну (JSON)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\n\nЗверніть увагу: Якщо вибрано тип доставки `CargoType`: `Documents`, доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\n\n\nСтворити ЕН зі зворотною доставкою
\n\nУ цьому запиті можна вказати зворотну доставку. Для цього потрібно додати параметр `BackwardDeliveryData`. Докладніше ознайомитися з варіантами зворотної доставки можна в розділі «Створити ЕН зі зворотною доставкою».\n\n \n\n\nСтворити експрес-накладну з оплатою від третьої особи
\n\nМожна створити експрес-накладну з оплатою від третьої особи. У такому разі потрібно задати відповідні значення в параметрах `PayerType` та `ThirdPerson`:\n\n```json\n{\n \"PayerType\": \"ThirdPerson\",\n \"ThirdPerson\": \"5953fb16-08d8-11e4-8958-0025909b4e33\"\n}\n```\n\nДля платника `ThirdPerson` форма оплати може бути лише «Безготівковий розрахунок».\n\n \n\n\nПланова дата відправки
\n\nУ параметрі `DateTime` можна задати планову дату відправки. Значення `DateTime` не може перевищувати поточну дату більше ніж на 3 місяці.\n\n \n\nНакладна, створена в програмному середовищі API, відображається у списку експрес-накладних (ЕН) в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveInternetDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveInternetDocumentResponse"}}}}}}}},"components":{"schemas":{"SaveInternetDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveInternetDocumentMethodProperties"}}},"SaveInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["PayerType","PaymentMethod","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone"],"properties":{"SenderWarehouseIndex":{"type":"string","description":"Цифрова адреса відділення відправника"},"RecipientWarehouseIndex":{"type":"string","description":"Цифрова адреса відділення одержувача"},"PayerType":{"type":"string","enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника.\nДля `ThirdPerson` потрібно передати параметр `ThirdPerson`,\nа `PaymentMethod` може бути лише `NonCash`\n"},"PaymentMethod":{"type":"string","enum":["Cash","NonCash"],"description":"Форма розрахунку"},"DateTime":{"type":"string","description":"Дата відправки у форматі `dd.mm.yyyy`.\nЗначення не може перевищувати поточну дату більше ніж на 3 місяці.\nЯкщо передано більшу дату, система автоматично обмежує її\nдо максимально допустимої та повертає попередження у `warnings`\n"},"CargoType":{"type":"string","description":"Тип вантажу.\nЯкщо `CargoType` = `Documents`, допустимі значення `Weight`:\n`0.1`, `0.5`, `1`\n"},"VolumeGeneral":{"type":"string","description":"Загальний об'єм, м.куб. Мінімальне значення `0.0004`.\nОбов'язково передавати, якщо не використовується параметр `OptionsSeat`\n"},"Weight":{"type":"string","description":"Фактична вага, кг. Мінімальне значення `0.1`.\nДля `CargoType` = `Documents` допустимі значення: `0.1`, `0.5`, `1`.\n"},"ServiceType":{"type":"string","enum":["DoorsDoors","DoorsWarehouse","WarehouseWarehouse","WarehouseDoors"],"description":"Технологія доставки"},"SeatsAmount":{"type":"string","description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","description":"Додатковий опис відправлення"},"Cost":{"type":"string","description":"Оціночна вартість, ціле число.\nЯкщо параметр не передати, API автоматично встановить мінімальну\nоціночну вартість `300.01`\n"},"CitySender":{"type":"string","format":"uuid","description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","format":"uuid","description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","format":"uuid","description":"Ідентифікатор адреси відправника"},"ContactSender":{"type":"string","format":"uuid","description":"Ідентифікатор контактної особи-відправника"},"SendersPhone":{"type":"string","description":"Телефон відправника у форматі `+380660000000`, `380660000000`, `0660000001`"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","format":"uuid","description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","format":"uuid","description":"Ідентифікатор адреси отримувача або ідентифікатор поштомата"},"ContactRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор контактної особи отримувача"},"RecipientsPhone":{"type":"string","description":"Телефон отримувача у форматі `+380660000000`, `380660000000`, `0660000001`"},"ThirdPerson":{"type":"string","format":"uuid","description":"Ідентифікатор третьої особи-платника.\nВикористовується, якщо `PayerType` = `ThirdPerson`\n"},"BackwardDeliveryData":{"type":"array","description":"Дані зворотної доставки.\nДетальний склад елементів залежить від обраного типу зворотної доставки\n","items":{"$ref":"#/components/schemas/BackwardDeliveryDataItem"}}}},"BackwardDeliveryDataItem":{"type":"object","additionalProperties":true,"description":"Об'єкт з параметрами зворотної доставки.\nНабір полів залежить від конкретного сценарію зворотної доставки\n","properties":{"PayerType":{"type":"string","description":"Тип платника зворотної доставки"},"CargoType":{"type":"string","description":"Тип зворотної доставки"},"RedeliveryString":{"type":"string","description":"Додаткове значення для зворотної доставки"}}},"SaveInternetDocumentResponse":{"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/SaveInternetDocumentItem"}},"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"}}}},"SaveInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","description":"Тип експрес-накладної"}}}}}}
````
## Створити експрес-накладну (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\
> \
> Зверніть увагу: Якщо вибрано тип доставки \`CargoType\`: \`Documents\`, доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\
> \
> \\
> \Створити ЕН зі зворотною доставкою\
\
> \
> У цьому запиті можна вказати зворотну доставку. Для цього потрібно додати параметр \`BackwardDeliveryData\`. Докладніше ознайомитися з варіантами зворотної доставки можна в розділі «Створити ЕН зі зворотною доставкою».\
> \
> \ \
> \
> \\
> \Створити експрес-накладну з оплатою від третьої особи\
\
> \
> Можна створити експрес-накладну з оплатою від третьої особи. У такому разі потрібно задати відповідні значення в параметрах \`PayerType\` та \`ThirdPerson\`:\
> \
> \`\`\`xml\
> \ThirdPerson\\
> \5953fb16-08d8-11e4-8958-0025909b4e33\\
> \`\`\`\
> \
> Для платника \`ThirdPerson\` форма оплати може бути лише «Безготівковий розрахунок».\
> \
> \ \
> \
> \\
> \Планова дата відправки\
\
> \
> У параметрі \`DateTime\` можна задати планову дату відправки. Значення \`DateTime\` не може перевищувати поточну дату більше ніж на 3 місяці.\
> \
> \ \
> \
> Накладна, створена в програмному середовищі API, відображається у списку експрес-накладних (ЕН) в особистому кабінеті.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveInternetDocumentXml","summary":"Створити експрес-накладну (XML)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\n\nЗверніть увагу: Якщо вибрано тип доставки `CargoType`: `Documents`, доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\n\n\nСтворити ЕН зі зворотною доставкою
\n\nУ цьому запиті можна вказати зворотну доставку. Для цього потрібно додати параметр `BackwardDeliveryData`. Докладніше ознайомитися з варіантами зворотної доставки можна в розділі «Створити ЕН зі зворотною доставкою».\n\n \n\n\nСтворити експрес-накладну з оплатою від третьої особи
\n\nМожна створити експрес-накладну з оплатою від третьої особи. У такому разі потрібно задати відповідні значення в параметрах `PayerType` та `ThirdPerson`:\n\n```xml\nThirdPerson\n5953fb16-08d8-11e4-8958-0025909b4e33\n```\n\nДля платника `ThirdPerson` форма оплати може бути лише «Безготівковий розрахунок».\n\n \n\n\nПланова дата відправки
\n\nУ параметрі `DateTime` можна задати планову дату відправки. Значення `DateTime` не може перевищувати поточну дату більше ніж на 3 місяці.\n\n \n\nНакладна, створена в програмному середовищі API, відображається у списку експрес-накладних (ЕН) в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveInternetDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveInternetDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"SaveInternetDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveInternetDocumentXmlMethodProperties"}}},"SaveInternetDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveInternetDocumentMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["PayerType","PaymentMethod","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone"],"properties":{"SenderWarehouseIndex":{"type":"string","description":"Цифрова адреса відділення відправника"},"RecipientWarehouseIndex":{"type":"string","description":"Цифрова адреса відділення одержувача"},"PayerType":{"type":"string","enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника.\nДля `ThirdPerson` потрібно передати параметр `ThirdPerson`,\nа `PaymentMethod` може бути лише `NonCash`\n"},"PaymentMethod":{"type":"string","enum":["Cash","NonCash"],"description":"Форма розрахунку"},"DateTime":{"type":"string","description":"Дата відправки у форматі `dd.mm.yyyy`.\nЗначення не може перевищувати поточну дату більше ніж на 3 місяці.\nЯкщо передано більшу дату, система автоматично обмежує її\nдо максимально допустимої та повертає попередження у `warnings`\n"},"CargoType":{"type":"string","description":"Тип вантажу.\nЯкщо `CargoType` = `Documents`, допустимі значення `Weight`:\n`0.1`, `0.5`, `1`\n"},"VolumeGeneral":{"type":"string","description":"Загальний об'єм, м.куб. Мінімальне значення `0.0004`.\nОбов'язково передавати, якщо не використовується параметр `OptionsSeat`\n"},"Weight":{"type":"string","description":"Фактична вага, кг. Мінімальне значення `0.1`.\nДля `CargoType` = `Documents` допустимі значення: `0.1`, `0.5`, `1`.\n"},"ServiceType":{"type":"string","enum":["DoorsDoors","DoorsWarehouse","WarehouseWarehouse","WarehouseDoors"],"description":"Технологія доставки"},"SeatsAmount":{"type":"string","description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","description":"Додатковий опис відправлення"},"Cost":{"type":"string","description":"Оціночна вартість, ціле число.\nЯкщо параметр не передати, API автоматично встановить мінімальну\nоціночну вартість `300.01`\n"},"CitySender":{"type":"string","format":"uuid","description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","format":"uuid","description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","format":"uuid","description":"Ідентифікатор адреси відправника"},"ContactSender":{"type":"string","format":"uuid","description":"Ідентифікатор контактної особи-відправника"},"SendersPhone":{"type":"string","description":"Телефон відправника у форматі `+380660000000`, `380660000000`, `0660000001`"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","format":"uuid","description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","format":"uuid","description":"Ідентифікатор адреси отримувача або ідентифікатор поштомата"},"ContactRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор контактної особи отримувача"},"RecipientsPhone":{"type":"string","description":"Телефон отримувача у форматі `+380660000000`, `380660000000`, `0660000001`"},"ThirdPerson":{"type":"string","format":"uuid","description":"Ідентифікатор третьої особи-платника.\nВикористовується, якщо `PayerType` = `ThirdPerson`\n"},"BackwardDeliveryData":{"type":"array","description":"Дані зворотної доставки.\nДетальний склад елементів залежить від обраного типу зворотної доставки\n","items":{"$ref":"#/components/schemas/BackwardDeliveryDataItem"}}}},"BackwardDeliveryDataItem":{"type":"object","additionalProperties":true,"description":"Об'єкт з параметрами зворотної доставки.\nНабір полів залежить від конкретного сценарію зворотної доставки\n","properties":{"PayerType":{"type":"string","description":"Тип платника зворотної доставки"},"CargoType":{"type":"string","description":"Тип зворотної доставки"},"RedeliveryString":{"type":"string","description":"Додаткове значення для зворотної доставки"}}},"SaveInternetDocumentXmlResponse":{"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/SaveInternetDocumentXmlItem"}},"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"}}}}},"SaveInternetDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveInternetDocumentItem"}],"xml":{"name":"item"}},"SaveInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","description":"Тип експрес-накладної"}}}}}}
````
## Створити експрес-накладну на поштомат (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати експрес-накладну (інтернет-документ).\
> \
> За допомогою методу \*\*save\*\* можна формувати експрес-накладні (ЕН) для відправлень у відділення типу «Поштомат». Для цього обов’язково потрібно вказувати параметри розмірів.\
> \
> \\
> \Обмеження\
\
> \
> \- Інформація цього розділу стосується лише відправлень у поштомат «Нова пошта».\
> \- Відправляти у поштомат можна тільки типи вантажу «Посилка» (\`Parcel\`) та «Документи» (\`Documents\`).\
> \- Максимальне значення оціночної вартості для відправки у поштомат (параметр \`Cost\`) — 29 000 грн.\
> \- Максимально допустимі габарити вантажу: ширина — 40 см, довжина — 60 см, висота — 30 см.\
> \- Максимально допустима вага вантажу — 20 кг.\
> \- Під час створення відправлення можна вказувати лише одне місце на одне відправлення.\
> \ \
> \
> Створена в програмному середовищі API накладна відображається у списку ЕН в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Locker Delivery)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveLockerDocumentJson","summary":"Створити експрес-накладну на поштомат (JSON)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати експрес-накладну (інтернет-документ).\n\nЗа допомогою методу **save** можна формувати експрес-накладні (ЕН) для відправлень у відділення типу «Поштомат». Для цього обов’язково потрібно вказувати параметри розмірів.\n\n\nОбмеження
\n\n- Інформація цього розділу стосується лише відправлень у поштомат «Нова пошта».\n- Відправляти у поштомат можна тільки типи вантажу «Посилка» (`Parcel`) та «Документи» (`Documents`).\n- Максимальне значення оціночної вартості для відправки у поштомат (параметр `Cost`) — 29 000 грн.\n- Максимально допустимі габарити вантажу: ширина — 40 см, довжина — 60 см, висота — 30 см.\n- Максимально допустима вага вантажу — 20 кг.\n- Під час створення відправлення можна вказувати лише одне місце на одне відправлення.\n \n\nСтворена в програмному середовищі API накладна відображається у списку ЕН в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveLockerDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveLockerDocumentResponse"}}}}}}}},"components":{"schemas":{"SaveLockerDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveLockerDocumentMethodProperties"}}},"SaveLockerDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","OptionsSeat"],"properties":{"SenderWarehouseIndex":{"type":"string","maxLength":36,"description":"Цифрова адреса відділення відправника"},"RecipientWarehouseIndex":{"type":"string","maxLength":36,"description":"Цифрова адреса поштомата отримувача"},"PayerType":{"type":"string","enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","enum":["Cash","NonCash"],"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","pattern":"^\\d{2}\\.\\d{2}\\.\\d{4}$","description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","enum":["Parcel","Documents"],"description":"Тип вантажу. Tільки «Посилка» (Parcel) або «Документи» (Documents)"},"Weight":{"type":"string","description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","enum":["DoorsWarehouse","WarehouseWarehouse"],"description":"Технологія доставки (DoorsWarehouse, WarehouseWarehouse)"},"SeatsAmount":{"type":"string","enum":["1"],"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість — 300.00)"},"CitySender":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) контактної особи-відправника. Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"Recipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) отримувача"},"RecipientAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) поштомата"},"ContactRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) контактної особи"},"RecipientsPhone":{"type":"string","description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"OptionsSeat":{"type":"array","minItems":1,"maxItems":1,"description":"Параметр вантажу для кожного місця відправлення","items":{"$ref":"#/components/schemas/OptionSeatItem"}}}},"OptionSeatItem":{"type":"object","additionalProperties":false,"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см"},"weight":{"type":"string","description":"Вага місця в кг"}}},"SaveLockerDocumentResponse":{"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/SaveLockerDocumentItem"}},"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"}}}},"SaveLockerDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","description":"Тип експрес-накладної"}}}}}}
```
## Створити експрес-накладну на поштомат (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати експрес-накладну (інтернет-документ).\
> \
> За допомогою методу \*\*save\*\* можна формувати експрес-накладні (ЕН) для відправлень у відділення типу «Поштомат». Для цього обов’язково потрібно вказувати параметри розмірів.\
> \
> \\
> \Обмеження\
\
> \
> \- Інформація цього розділу стосується лише відправлень у поштомат «Нова пошта».\
> \- Відправляти у поштомат можна тільки типи вантажу «Посилка» (\`Parcel\`) та «Документи» (\`Documents\`).\
> \- Максимальне значення оціночної вартості для відправки у поштомат (параметр \`Cost\`) — 29 000 грн.\
> \- Максимально допустимі габарити вантажу: ширина — 40 см, довжина — 60 см, висота — 30 см.\
> \- Максимально допустима вага вантажу — 20 кг.\
> \- Під час створення відправлення можна вказувати лише одне місце на одне відправлення.\
> \ \
> \
> Створена в програмному середовищі API накладна відображається у списку ЕН в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Locker Delivery)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveLockerDocumentXml","summary":"Створити експрес-накладну на поштомат (XML)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати експрес-накладну (інтернет-документ).\n\nЗа допомогою методу **save** можна формувати експрес-накладні (ЕН) для відправлень у відділення типу «Поштомат». Для цього обов’язково потрібно вказувати параметри розмірів.\n\n\nОбмеження
\n\n- Інформація цього розділу стосується лише відправлень у поштомат «Нова пошта».\n- Відправляти у поштомат можна тільки типи вантажу «Посилка» (`Parcel`) та «Документи» (`Documents`).\n- Максимальне значення оціночної вартості для відправки у поштомат (параметр `Cost`) — 29 000 грн.\n- Максимально допустимі габарити вантажу: ширина — 40 см, довжина — 60 см, висота — 30 см.\n- Максимально допустима вага вантажу — 20 кг.\n- Під час створення відправлення можна вказувати лише одне місце на одне відправлення.\n \n\nСтворена в програмному середовищі API накладна відображається у списку ЕН в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveLockerDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveLockerDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"SaveLockerDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveLockerDocumentXmlMethodProperties"}}},"SaveLockerDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveLockerDocumentMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveLockerDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","OptionsSeat"],"properties":{"SenderWarehouseIndex":{"type":"string","maxLength":36,"description":"Цифрова адреса відділення відправника"},"RecipientWarehouseIndex":{"type":"string","maxLength":36,"description":"Цифрова адреса поштомата отримувача"},"PayerType":{"type":"string","enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","enum":["Cash","NonCash"],"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","pattern":"^\\d{2}\\.\\d{2}\\.\\d{4}$","description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","enum":["Parcel","Documents"],"description":"Тип вантажу. Tільки «Посилка» (Parcel) або «Документи» (Documents)"},"Weight":{"type":"string","description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","enum":["DoorsWarehouse","WarehouseWarehouse"],"description":"Технологія доставки (DoorsWarehouse, WarehouseWarehouse)"},"SeatsAmount":{"type":"string","enum":["1"],"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість — 300.00)"},"CitySender":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) контактної особи-відправника. Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"Recipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) отримувача"},"RecipientAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) поштомата"},"ContactRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) контактної особи"},"RecipientsPhone":{"type":"string","description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"OptionsSeat":{"type":"array","minItems":1,"maxItems":1,"description":"Параметр вантажу для кожного місця відправлення","items":{"$ref":"#/components/schemas/OptionSeatItem"}}}},"OptionSeatItem":{"type":"object","additionalProperties":false,"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см"},"weight":{"type":"string","description":"Вага місця в кг"}}},"SaveLockerDocumentXmlResponse":{"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/SaveLockerDocumentXmlItem"}},"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"}}}}},"SaveLockerDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveLockerDocumentItem"}],"xml":{"name":"item"}},"SaveLockerDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","description":"Тип експрес-накладної"}}}}}}
```
## Створити експрес-накладну з різними типами вантажу (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\
> \
> Є можливість сформувати запити з різними типами вантажів (наприклад, Pallet, TiresWheels, Documents, Parcel тощо).\
> \
> \\
> \Приклад формування запиту з типом вантажу «Шини-диски» ("CargoType"="TiresWheels")\
\
> \
> \`\`\`json\
> "CargoDetails": \[ { "CargoDescription": "20f7b626-9add-11e3-b441-0050568002cf", "Amount": "4" } ]\
> \`\`\`\
> \ \
> \
> \\
> \Приклад формування запиту з типом вантажу «Палети або вантаж» із зазначенням параметрів кожного місця ("CargoType"="Pallet")\
\
> \
> \`\`\`json\
> "OptionsSeat": \[ { "volumetricVolume": "10", "volumetricWidth": "10", "volumetricLength": "10", "volumetricHeight": "10", "weight": "10" }, { "volumetricVolume": "10", "volumetricWidth": "10", "volumetricLength": "10", "volumetricHeight": "10", "weight": "10" } ]\
> \`\`\`\
> \ \
> \
> \\
> \Приклад формування запиту з типом вантажу «Документи» ("CargoType"="Documents")\
\
> \
> Якщо вибрано тип доставки "CargoType": "Documents", доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\
> \ \
> \
> Інтернет-документ, створений у програмному середовищі API, з'являється у списку експрес-накладних (ЕН) в особистому кабінеті. Якщо відкрити документ, відображаються тип послуги, тип вантажу (наприклад, «Документи»), а також його параметри та кількість.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Different Cargo Types)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveCargoDocumentJson","summary":"Створити експрес-накладну з різними типами вантажу (JSON)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\n\nЄ можливість сформувати запити з різними типами вантажів (наприклад, Pallet, TiresWheels, Documents, Parcel тощо).\n\n\nПриклад формування запиту з типом вантажу «Шини-диски» (\"CargoType\"=\"TiresWheels\")
\n\n```json\n\"CargoDetails\": [ { \"CargoDescription\": \"20f7b626-9add-11e3-b441-0050568002cf\", \"Amount\": \"4\" } ]\n```\n \n\n\nПриклад формування запиту з типом вантажу «Палети або вантаж» із зазначенням параметрів кожного місця (\"CargoType\"=\"Pallet\")
\n\n```json\n\"OptionsSeat\": [ { \"volumetricVolume\": \"10\", \"volumetricWidth\": \"10\", \"volumetricLength\": \"10\", \"volumetricHeight\": \"10\", \"weight\": \"10\" }, { \"volumetricVolume\": \"10\", \"volumetricWidth\": \"10\", \"volumetricLength\": \"10\", \"volumetricHeight\": \"10\", \"weight\": \"10\" } ]\n```\n \n\n\nПриклад формування запиту з типом вантажу «Документи» (\"CargoType\"=\"Documents\")
\n\nЯкщо вибрано тип доставки \"CargoType\": \"Documents\", доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\n \n\nІнтернет-документ, створений у програмному середовищі API, з'являється у списку експрес-накладних (ЕН) в особистому кабінеті. Якщо відкрити документ, відображаються тип послуги, тип вантажу (наприклад, «Документи»), а також його параметри та кількість.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCargoDocumentRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCargoDocumentResponse"}}}}}}}},"components":{"schemas":{"SaveCargoDocumentRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveCargoDocumentMethodProperties"}}},"SaveCargoDocumentMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","OptionsSeat"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу (наприклад, Cargo, Documents, Pallet, TiresWheels)"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (для Documents: 0,1, 0,5 або 1)."},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення"},"Description":{"type":"string","maxLength":36,"description":"Додатковий опис відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-відправника"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"OptionsSeat":{"type":"array","description":"Параметри вантажу для кожного місця","xml":{"name":"OptionsSeat","wrapped":true},"items":{"$ref":"#/components/schemas/OptionSeatItem"}},"CargoDetails":{"type":"array","description":"Деталізація вантажу (TiresWheels)","xml":{"name":"CargoDetails","wrapped":true},"items":{"$ref":"#/components/schemas/CargoDetailItem"}}}},"OptionSeatItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см"},"weight":{"type":"string","description":"Вага місця в кг"}}},"CargoDetailItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"CargoDescription":{"type":"string"},"Amount":{"type":"string"}}},"SaveCargoDocumentResponse":{"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/SaveCargoDocumentItem"}},"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"}}},"info":{"type":"array","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SaveCargoDocumentItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string"},"CostOnSite":{"type":"string"},"EstimatedDeliveryDate":{"type":"string"},"IntDocNumber":{"type":"string"},"TypeDocument":{"type":"string"}}}}}}
````
## Створити експрес-накладну з різними типами вантажу (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\
> \
> Є можливість сформувати запити з різними типами вантажів (наприклад, Pallet, TiresWheels, Documents, Parcel тощо).\
> \
> \\
> \Приклад формування запиту з типом вантажу «Шини-диски» ("CargoType"="TiresWheels")\
\
> \
> \`\`\`xml\
> \\- \20f7b626-9add-11e3-b441-0050568002cf\\4\\
\\
> \`\`\`\
> \ \
> \
> \\
> \Приклад формування запиту з типом вантажу «Палети або вантаж» із зазначенням параметрів кожного місця ("CargoType"="Pallet")\
\
> \
> \`\`\`xml\
> \\- \10\\10\\10\\10\\10\\
\- \10\\10\\10\\10\\10\\
\\
> \`\`\`\
> \ \
> \
> \\
> \Приклад формування запиту з типом вантажу «Документи» ("CargoType"="Documents")\
\
> \
> Якщо вибрано тип доставки "CargoType": "Documents", доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\
> \ \
> \
> Інтернет-документ, створений у програмному середовищі API, з'являється у списку експрес-накладних (ЕН) в особистому кабінеті. Якщо відкрити документ, відображаються тип послуги, тип вантажу (наприклад, «Документи»), а також його параметри та кількість.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Different Cargo Types)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveCargoDocumentXml","summary":"Створити експрес-накладну з різними типами вантажу (XML)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\n\nЄ можливість сформувати запити з різними типами вантажів (наприклад, Pallet, TiresWheels, Documents, Parcel тощо).\n\n\nПриклад формування запиту з типом вантажу «Шини-диски» (\"CargoType\"=\"TiresWheels\")
\n\n```xml\n- 20f7b626-9add-11e3-b441-0050568002cf4
\n```\n \n\n\nПриклад формування запиту з типом вантажу «Палети або вантаж» із зазначенням параметрів кожного місця (\"CargoType\"=\"Pallet\")
\n\n```xml\n- 1010101010
- 1010101010
\n```\n \n\n\nПриклад формування запиту з типом вантажу «Документи» (\"CargoType\"=\"Documents\")
\n\nЯкщо вибрано тип доставки \"CargoType\": \"Documents\", доступні такі параметри ваги: 0,1, 0,5 або 1. У всіх інших випадках повернеться помилка.\n \n\nІнтернет-документ, створений у програмному середовищі API, з'являється у списку експрес-накладних (ЕН) в особистому кабінеті. Якщо відкрити документ, відображаються тип послуги, тип вантажу (наприклад, «Документи»), а також його параметри та кількість.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveCargoDocumentRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveCargoDocumentResponse"}}}}}}}},"components":{"schemas":{"SaveCargoDocumentRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveCargoDocumentMethodProperties"}}},"SaveCargoDocumentMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","OptionsSeat"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу (наприклад, Cargo, Documents, Pallet, TiresWheels)"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (для Documents: 0,1, 0,5 або 1)."},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення"},"Description":{"type":"string","maxLength":36,"description":"Додатковий опис відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-відправника"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"OptionsSeat":{"type":"array","description":"Параметри вантажу для кожного місця","xml":{"name":"OptionsSeat","wrapped":true},"items":{"$ref":"#/components/schemas/OptionSeatItem"}},"CargoDetails":{"type":"array","description":"Деталізація вантажу (TiresWheels)","xml":{"name":"CargoDetails","wrapped":true},"items":{"$ref":"#/components/schemas/CargoDetailItem"}}}},"OptionSeatItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см"},"weight":{"type":"string","description":"Вага місця в кг"}}},"CargoDetailItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"CargoDescription":{"type":"string"},"Amount":{"type":"string"}}},"SaveCargoDocumentResponse":{"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/SaveCargoDocumentItem"}},"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"}}},"info":{"type":"array","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"SaveCargoDocumentItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string"},"CostOnSite":{"type":"string"},"EstimatedDeliveryDate":{"type":"string"},"IntDocNumber":{"type":"string"},"TypeDocument":{"type":"string"}}}}}}
````
## Створити експрес-накладну з додатковими послугами (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\
> \
> Є можливість створювати запити з додатковими послугами.\
> \
> \\
> \Формування запиту на створення експрес-накладної (ЕН) із послугою «Суботня доставка»\
\
> \
> \`\`\`json\
> "SaturdayDelivery": "1" // 1 — так, послуга «Cуботня доставка» надається, 0 — ні, послуга не надається\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Контроль оплати»\
\
> \
> \`\`\`json\
> "AfterpaymentOnGoodsCost": "1005"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Локал Експрес»\
\
> \
> Доступні часові інтервали: 2, 3, 4. Якщо це значення порожнє, API проставить позначку "Протягом дня" (див. пункт «Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»). Послуга доступна лише в межах одного міста.\
> \
> \`\`\`json\
> "LocalExpress": "1",\
> "TimeInterval": "CityDeliveryTimeInterval2"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Дата доставки»\*\
\
> \
> \*Послуга надається тільки в разі доставки до адреси.\
> \
> \`\`\`json\
> "PreferredDeliveryDate": "07.03.2021"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»\*\
\
> \
> \*Послуга надається тільки в разі доставки до адреси. Послуга «Доставка в часові інтервали» можлива лише за умови замовлення послуги «Бажана дата доставки». Як завантажити список видів часових інтервалів, можна побачити у «Види часових інтервалів».\
> \
> \`\`\`json\
> "PreferredDeliveryDate": "25.03.2021",\
> "TimeInterval": "CityDeliveryTimeInterval1/2/3/4"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН за допомогою послуги «Вказати номери паковання»\
\
> \
> \`\`\`json\
> "PackingNumber": "4545" // де 4545 — номер паковання\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Вказати внутрішній номер замовлення клієнта»\
\
> \
> \`\`\`json\
> "InfoRegClientBarcodes": "121212" // де 121212 — внутрішній номер клієнта\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із описом «Супровідні документи»\
\
> \
> \`\`\`json\
> "AccompanyingDocuments": "Договір"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із описом «Додаткова інформація про відправлення»\
\
> \
> \`\`\`json\
> "AdditionalInformation": "Смартфон"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «До дверей»\
\
> \
> \`\`\`json\
> "NumberOfFloorsLifting": "3" // де 3 — номер поверху\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Від дверей»\
\
> \
> Параметр «Ліфт» (\`Elevator\`) можна ігнорувати.\
> \
> \`\`\`json\
> "NumberOfFloorsDescent": "3" // де 3 — номер поверху\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із додатковою послугою «Доставка особисто в руки»\
\
> \
> У значенні \`DeliveryByHandRecipients\` зазначається перелік осіб, яким можна віддати відправлення. Під час замовлення послуги можна завантажувати до 15 осіб включно. Перша особа завжди — одержувач (підтягується з «Дані одержувача»), решта 14 — довільні особи.\
> \
> \`\`\`json\
> "DeliveryByHand": "1", // 1 — так, послуга надається, 0 — ні, послуга не надається\
> "DeliveryByHandRecipients": \[ "Могилевська Юлія Костянтинівна", "Колесник Костянтин Олександрович" ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Контроль поштучної передачі» (експедирування)\
\
> \
> \`\`\`json\
> "ForwardingCount": "126" // де 126 — кількість штук\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Red Box»\
\
> \
> \`\`\`json\
> "RedBoxBarcode": "0105QD26L" // код враховує лише верхній регістр\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із пакуванням\
\
> \
> Доступно у разі доставки до відділення. Вибрати тип паковання необхідно за допомогою методу \`getPackListSpecial\`:\
> \`\`\`json\
> {\
> "modelName": "Common",\
> "calledMethod": "getPackListSpecial",\
> "methodProperties": {\
> "Length": 100, // довжина відправлення, мм\
> "Width": 500, // ширина відправлення, мм\
> "Height": 50, // висота відправлення, мм\
> "PackForSale": "1"\
> }\
> }\
> \`\`\`\
> Ідентифікатор паковання, що повертається у відповіді, необхідно передавати у параметрі \`packRef\` масиву \`OptionsSeat\`.\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Ручне оброблення»\
\
> \
> Послуга доступна до замовлення у разі створення документа з характеристиками: довжина відправлення (або одного місця) — від 1 до 120 см, ширина та висота — до 70 см та вагою (фактичною або об'ємною) відправлення (або одного місця) — від 0,1 до 30 кг. Оформлення відправлень з категорією «Ручне оброблення» дозволено лише з/на вантажні відділення, пункти прийому-видачі та адресу. Замовлення послуги можливе лише з передачею габаритів місць з використанням параметра \`specialCargo\`:\
> \
> \`\`\`json\
> "specialCargo": "1", // 1 — так, послугу замовлено, 0 — ні, послугу не замовлено\
> "OptionsSeat": \[\
> {\
> "weight": 5, // вага місця, кг\
> "volumetricHeight": 50, // висота місця, см\
> "volumetricWidth": 10, // ширина місця, см\
> "volumetricLength": 10, // довжина місця, см\
> "cost": "1", // оціночна вартість місця, грн\
> "description": "1",\
> "specialCargo": "1"\
> }\
> ]\
> \`\`\`\
> \ \
> \
> Після створення інтернет-документа у програмному середовищі АРІ, ЕН з'явиться в переліку ЕН у бізнес-кабінеті. Якщо відкрити документ, можна побачити послугу та вибране пакування.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Additional Services)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveAdditionalServicesDocumentJson","summary":"Створити експрес-накладну з додатковими послугами (JSON)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\n\nЄ можливість створювати запити з додатковими послугами.\n\n\nФормування запиту на створення експрес-накладної (ЕН) із послугою «Суботня доставка»
\n\n```json\n\"SaturdayDelivery\": \"1\" // 1 — так, послуга «Cуботня доставка» надається, 0 — ні, послуга не надається\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Контроль оплати»
\n\n```json\n\"AfterpaymentOnGoodsCost\": \"1005\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Локал Експрес»
\n\nДоступні часові інтервали: 2, 3, 4. Якщо це значення порожнє, API проставить позначку \"Протягом дня\" (див. пункт «Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»). Послуга доступна лише в межах одного міста.\n\n```json\n\"LocalExpress\": \"1\",\n\"TimeInterval\": \"CityDeliveryTimeInterval2\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Дата доставки»*
\n\n*Послуга надається тільки в разі доставки до адреси.\n\n```json\n\"PreferredDeliveryDate\": \"07.03.2021\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Доставка в часові інтервали»*
\n\n*Послуга надається тільки в разі доставки до адреси. Послуга «Доставка в часові інтервали» можлива лише за умови замовлення послуги «Бажана дата доставки». Як завантажити список видів часових інтервалів, можна побачити у «Види часових інтервалів».\n\n```json\n\"PreferredDeliveryDate\": \"25.03.2021\",\n\"TimeInterval\": \"CityDeliveryTimeInterval1/2/3/4\"\n```\n \n\n\nФормування запиту на створення ЕН за допомогою послуги «Вказати номери паковання»
\n\n```json\n\"PackingNumber\": \"4545\" // де 4545 — номер паковання\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Вказати внутрішній номер замовлення клієнта»
\n\n```json\n\"InfoRegClientBarcodes\": \"121212\" // де 121212 — внутрішній номер клієнта\n```\n \n\n\nФормування запиту на створення ЕН із описом «Супровідні документи»
\n\n```json\n\"AccompanyingDocuments\": \"Договір\"\n```\n \n\n\nФормування запиту на створення ЕН із описом «Додаткова інформація про відправлення»
\n\n```json\n\"AdditionalInformation\": \"Смартфон\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «До дверей»
\n\n```json\n\"NumberOfFloorsLifting\": \"3\" // де 3 — номер поверху\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Від дверей»
\n\nПараметр «Ліфт» (`Elevator`) можна ігнорувати.\n\n```json\n\"NumberOfFloorsDescent\": \"3\" // де 3 — номер поверху\n```\n \n\n\nФормування запиту на створення ЕН із додатковою послугою «Доставка особисто в руки»
\n\nУ значенні `DeliveryByHandRecipients` зазначається перелік осіб, яким можна віддати відправлення. Під час замовлення послуги можна завантажувати до 15 осіб включно. Перша особа завжди — одержувач (підтягується з «Дані одержувача»), решта 14 — довільні особи.\n\n```json\n\"DeliveryByHand\": \"1\", // 1 — так, послуга надається, 0 — ні, послуга не надається\n\"DeliveryByHandRecipients\": [ \"Могилевська Юлія Костянтинівна\", \"Колесник Костянтин Олександрович\" ]\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Контроль поштучної передачі» (експедирування)
\n\n```json\n\"ForwardingCount\": \"126\" // де 126 — кількість штук\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Red Box»
\n\n```json\n\"RedBoxBarcode\": \"0105QD26L\" // код враховує лише верхній регістр\n```\n \n\n\nФормування запиту на створення ЕН із пакуванням
\n\nДоступно у разі доставки до відділення. Вибрати тип паковання необхідно за допомогою методу `getPackListSpecial`:\n```json\n{\n \"modelName\": \"Common\",\n \"calledMethod\": \"getPackListSpecial\",\n \"methodProperties\": {\n \"Length\": 100, // довжина відправлення, мм\n \"Width\": 500, // ширина відправлення, мм\n \"Height\": 50, // висота відправлення, мм\n \"PackForSale\": \"1\"\n }\n}\n```\nІдентифікатор паковання, що повертається у відповіді, необхідно передавати у параметрі `packRef` масиву `OptionsSeat`.\n \n\n\nФормування запиту на створення ЕН із послугою «Ручне оброблення»
\n\nПослуга доступна до замовлення у разі створення документа з характеристиками: довжина відправлення (або одного місця) — від 1 до 120 см, ширина та висота — до 70 см та вагою (фактичною або об'ємною) відправлення (або одного місця) — від 0,1 до 30 кг. Оформлення відправлень з категорією «Ручне оброблення» дозволено лише з/на вантажні відділення, пункти прийому-видачі та адресу. Замовлення послуги можливе лише з передачею габаритів місць з використанням параметра `specialCargo`:\n\n```json\n\"specialCargo\": \"1\", // 1 — так, послугу замовлено, 0 — ні, послугу не замовлено\n\"OptionsSeat\": [\n {\n \"weight\": 5, // вага місця, кг\n \"volumetricHeight\": 50, // висота місця, см\n \"volumetricWidth\": 10, // ширина місця, см\n \"volumetricLength\": 10, // довжина місця, см\n \"cost\": \"1\", // оціночна вартість місця, грн\n \"description\": \"1\",\n \"specialCargo\": \"1\"\n }\n]\n```\n \n\nПісля створення інтернет-документа у програмному середовищі АРІ, ЕН з'явиться в переліку ЕН у бізнес-кабінеті. Якщо відкрити документ, можна побачити послугу та вибране пакування.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveAdditionalServicesRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveAdditionalServicesResponse"}}}}}}}},"components":{"schemas":{"SaveAdditionalServicesRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveAdditionalServicesMethodProperties"}}},"SaveAdditionalServicesMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","OptionsSeat"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004)"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-відправника"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача/Ідентифікатор поштомата"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"RedBoxBarcode":{"type":"string","maxLength":36,"description":"Номер штрихкоду RedBox"},"OptionsSeat":{"type":"array","title":"Параметри місця відправлення (`OptionSeat`)","description":"Параметр вантажу для кожного місця відправлення","xml":{"name":"OptionsSeat","wrapped":true},"items":{"$ref":"#/components/schemas/AdditionalOptionSeatItem"}}}},"AdditionalOptionSeatItem":{"type":"object","title":"Параметри місця відправлення","description":"Об'єкт з деталізацією габаритів та характеристик окремого місця","additionalProperties":false,"xml":{"name":"item"},"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight","packRef"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см"},"weight":{"type":"string","description":"Вага місця в кг"},"packRef":{"type":"string","description":"Ідентифікатор паковання"}}},"SaveAdditionalServicesResponse":{"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/SaveAdditionalServicesItem"}},"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"}}}}},"SaveAdditionalServicesItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","description":"Ідентифікатор створеної експрес-накладної"},"CostOnSite":{"type":"string","description":"Розрахована вартість доставки (грн)"},"EstimatedDeliveryDate":{"type":"string","description":"Орієнтована дата доставки відправлення у форматі дд.мм.рррр"},"IntDocNumber":{"type":"string","description":"Номер створеної експрес-накладної (14 цифр)"},"TypeDocument":{"type":"string","description":"Тип створеного документа"}}}}}}
````
## Створити експрес-накладну з додатковими послугами (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\
> \
> Є можливість створювати запити з додатковими послугами.\
> \
> \\
> \Формування запиту на створення експрес-накладної (ЕН) із послугою «Суботня доставка»\
\
> \
> \`\`\`json\
> "SaturdayDelivery": "1" // 1 — так, послуга «Cуботня доставка» надається, 0 — ні, послуга не надається\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Контроль оплати»\
\
> \
> \`\`\`json\
> "AfterpaymentOnGoodsCost": "1005"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Локал Експрес»\
\
> \
> Доступні часові інтервали: 2, 3, 4. Якщо це значення порожнє, API проставить позначку "Протягом дня" (див. пункт «Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»). Послуга доступна лише в межах одного міста.\
> \
> \`\`\`json\
> "LocalExpress": "1",\
> "TimeInterval": "CityDeliveryTimeInterval2"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Дата доставки»\*\
\
> \
> \*Послуга надається тільки в разі доставки до адреси.\
> \
> \`\`\`json\
> "PreferredDeliveryDate": "07.03.2021"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»\*\
\
> \
> \*Послуга надається тільки в разі доставки до адреси. Послуга «Доставка в часові інтервали» можлива лише за умови замовлення послуги «Бажана дата доставки». Як завантажити список видів часових інтервалів, можна побачити у «Види часових інтервалів».\
> \
> \`\`\`json\
> "PreferredDeliveryDate": "25.03.2021",\
> "TimeInterval": "CityDeliveryTimeInterval1/2/3/4"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН за допомогою послуги «Вказати номери паковання»\
\
> \
> \`\`\`json\
> "PackingNumber": "4545" // де 4545 — номер паковання\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Вказати внутрішній номер замовлення клієнта»\
\
> \
> \`\`\`json\
> "InfoRegClientBarcodes": "121212" // де 121212 — внутрішній номер клієнта\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із описом «Супровідні документи»\
\
> \
> \`\`\`json\
> "AccompanyingDocuments": "Договір"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із описом «Додаткова інформація про відправлення»\
\
> \
> \`\`\`json\
> "AdditionalInformation": "Смартфон"\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «До дверей»\
\
> \
> \`\`\`json\
> "NumberOfFloorsLifting": "3" // де 3 — номер поверху\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Від дверей»\
\
> \
> Параметр «Ліфт» (\`Elevator\`) можна ігнорувати.\
> \
> \`\`\`json\
> "NumberOfFloorsDescent": "3" // де 3 — номер поверху\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із додатковою послугою «Доставка особисто в руки»\
\
> \
> У значенні \`DeliveryByHandRecipients\` зазначається перелік осіб, яким можна віддати відправлення. Під час замовлення послуги можна завантажувати до 15 осіб включно. Перша особа завжди — одержувач (підтягується з «Дані одержувача»), решта 14 — довільні особи.\
> \
> \`\`\`json\
> "DeliveryByHand": "1", // 1 — так, послуга надається, 0 — ні, послуга не надається\
> "DeliveryByHandRecipients": \[ "Могилевська Юлія Костянтинівна", "Колесник Костянтин Олександрович" ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Контроль поштучної передачі» (експедирування)\
\
> \
> \`\`\`json\
> "ForwardingCount": "126" // де 126 — кількість штук\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Red Box»\
\
> \
> \`\`\`json\
> "RedBoxBarcode": "0105QD26L" // код враховує лише верхній регістр\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із пакуванням\
\
> \
> Доступно у разі доставки до відділення. Вибрати тип паковання необхідно за допомогою методу \`getPackListSpecial\`:\
> \`\`\`json\
> {\
> "modelName": "Common",\
> "calledMethod": "getPackListSpecial",\
> "methodProperties": {\
> "Length": 100, // довжина відправлення, мм\
> "Width": 500, // ширина відправлення, мм\
> "Height": 50, // висота відправлення, мм\
> "PackForSale": "1"\
> }\
> }\
> \`\`\`\
> Ідентифікатор паковання, що повертається у відповіді, необхідно передавати у параметрі \`packRef\` масиву \`OptionsSeat\`.\
> \ \
> \
> \\
> \Формування запиту на створення ЕН із послугою «Ручне оброблення»\
\
> \
> Послуга доступна до замовлення у разі створення документа з характеристиками: довжина відправлення (або одного місця) — від 1 до 120 см, ширина та висота — до 70 см та вагою (фактичною або об'ємною) відправлення (або одного місця) — від 0,1 до 30 кг. Оформлення відправлень з категорією «Ручне оброблення» дозволено лише з/на вантажні відділення, пункти прийому-видачі та адресу. Замовлення послуги можливе лише з передачею габаритів місць з використанням параметра \`specialCargo\`:\
> \
> \`\`\`json\
> "specialCargo": "1", // 1 — так, послугу замовлено, 0 — ні, послугу не замовлено\
> "OptionsSeat": \[\
> {\
> "weight": 5, // вага місця, кг\
> "volumetricHeight": 50, // висота місця, см\
> "volumetricWidth": 10, // ширина місця, см\
> "volumetricLength": 10, // довжина місця, см\
> "cost": "1", // оціночна вартість місця, грн\
> "description": "1",\
> "specialCargo": "1"\
> }\
> ]\
> \`\`\`\
> \ \
> \
> Після створення інтернет-документа у програмному середовищі АРІ, ЕН з'явиться в переліку ЕН у бізнес-кабінеті. Якщо відкрити документ, можна побачити послугу та вибране пакування.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Additional Services)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveAdditionalServicesDocumentXml","summary":"Створити експрес-накладну з додатковими послугами (XML)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ).\n\nЄ можливість створювати запити з додатковими послугами.\n\n\nФормування запиту на створення експрес-накладної (ЕН) із послугою «Суботня доставка»
\n\n```json\n\"SaturdayDelivery\": \"1\" // 1 — так, послуга «Cуботня доставка» надається, 0 — ні, послуга не надається\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Контроль оплати»
\n\n```json\n\"AfterpaymentOnGoodsCost\": \"1005\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Локал Експрес»
\n\nДоступні часові інтервали: 2, 3, 4. Якщо це значення порожнє, API проставить позначку \"Протягом дня\" (див. пункт «Формування запиту на створення ЕН із послугою «Доставка в часові інтервали»). Послуга доступна лише в межах одного міста.\n\n```json\n\"LocalExpress\": \"1\",\n\"TimeInterval\": \"CityDeliveryTimeInterval2\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Дата доставки»*
\n\n*Послуга надається тільки в разі доставки до адреси.\n\n```json\n\"PreferredDeliveryDate\": \"07.03.2021\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Доставка в часові інтервали»*
\n\n*Послуга надається тільки в разі доставки до адреси. Послуга «Доставка в часові інтервали» можлива лише за умови замовлення послуги «Бажана дата доставки». Як завантажити список видів часових інтервалів, можна побачити у «Види часових інтервалів».\n\n```json\n\"PreferredDeliveryDate\": \"25.03.2021\",\n\"TimeInterval\": \"CityDeliveryTimeInterval1/2/3/4\"\n```\n \n\n\nФормування запиту на створення ЕН за допомогою послуги «Вказати номери паковання»
\n\n```json\n\"PackingNumber\": \"4545\" // де 4545 — номер паковання\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Вказати внутрішній номер замовлення клієнта»
\n\n```json\n\"InfoRegClientBarcodes\": \"121212\" // де 121212 — внутрішній номер клієнта\n```\n \n\n\nФормування запиту на створення ЕН із описом «Супровідні документи»
\n\n```json\n\"AccompanyingDocuments\": \"Договір\"\n```\n \n\n\nФормування запиту на створення ЕН із описом «Додаткова інформація про відправлення»
\n\n```json\n\"AdditionalInformation\": \"Смартфон\"\n```\n \n\n\nФормування запиту на створення ЕН із послугою «До дверей»
\n\n```json\n\"NumberOfFloorsLifting\": \"3\" // де 3 — номер поверху\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Від дверей»
\n\nПараметр «Ліфт» (`Elevator`) можна ігнорувати.\n\n```json\n\"NumberOfFloorsDescent\": \"3\" // де 3 — номер поверху\n```\n \n\n\nФормування запиту на створення ЕН із додатковою послугою «Доставка особисто в руки»
\n\nУ значенні `DeliveryByHandRecipients` зазначається перелік осіб, яким можна віддати відправлення. Під час замовлення послуги можна завантажувати до 15 осіб включно. Перша особа завжди — одержувач (підтягується з «Дані одержувача»), решта 14 — довільні особи.\n\n```json\n\"DeliveryByHand\": \"1\", // 1 — так, послуга надається, 0 — ні, послуга не надається\n\"DeliveryByHandRecipients\": [ \"Могилевська Юлія Костянтинівна\", \"Колесник Костянтин Олександрович\" ]\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Контроль поштучної передачі» (експедирування)
\n\n```json\n\"ForwardingCount\": \"126\" // де 126 — кількість штук\n```\n \n\n\nФормування запиту на створення ЕН із послугою «Red Box»
\n\n```json\n\"RedBoxBarcode\": \"0105QD26L\" // код враховує лише верхній регістр\n```\n \n\n\nФормування запиту на створення ЕН із пакуванням
\n\nДоступно у разі доставки до відділення. Вибрати тип паковання необхідно за допомогою методу `getPackListSpecial`:\n```json\n{\n \"modelName\": \"Common\",\n \"calledMethod\": \"getPackListSpecial\",\n \"methodProperties\": {\n \"Length\": 100, // довжина відправлення, мм\n \"Width\": 500, // ширина відправлення, мм\n \"Height\": 50, // висота відправлення, мм\n \"PackForSale\": \"1\"\n }\n}\n```\nІдентифікатор паковання, що повертається у відповіді, необхідно передавати у параметрі `packRef` масиву `OptionsSeat`.\n \n\n\nФормування запиту на створення ЕН із послугою «Ручне оброблення»
\n\nПослуга доступна до замовлення у разі створення документа з характеристиками: довжина відправлення (або одного місця) — від 1 до 120 см, ширина та висота — до 70 см та вагою (фактичною або об'ємною) відправлення (або одного місця) — від 0,1 до 30 кг. Оформлення відправлень з категорією «Ручне оброблення» дозволено лише з/на вантажні відділення, пункти прийому-видачі та адресу. Замовлення послуги можливе лише з передачею габаритів місць з використанням параметра `specialCargo`:\n\n```json\n\"specialCargo\": \"1\", // 1 — так, послугу замовлено, 0 — ні, послугу не замовлено\n\"OptionsSeat\": [\n {\n \"weight\": 5, // вага місця, кг\n \"volumetricHeight\": 50, // висота місця, см\n \"volumetricWidth\": 10, // ширина місця, см\n \"volumetricLength\": 10, // довжина місця, см\n \"cost\": \"1\", // оціночна вартість місця, грн\n \"description\": \"1\",\n \"specialCargo\": \"1\"\n }\n]\n```\n \n\nПісля створення інтернет-документа у програмному середовищі АРІ, ЕН з'явиться в переліку ЕН у бізнес-кабінеті. Якщо відкрити документ, можна побачити послугу та вибране пакування.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveAdditionalServicesRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveAdditionalServicesResponse"}}}}}}}},"components":{"schemas":{"SaveAdditionalServicesRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveAdditionalServicesMethodProperties"}}},"SaveAdditionalServicesMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","OptionsSeat"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004)"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-відправника"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача/Ідентифікатор поштомата"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"RedBoxBarcode":{"type":"string","maxLength":36,"description":"Номер штрихкоду RedBox"},"OptionsSeat":{"type":"array","title":"Параметри місця відправлення (`OptionSeat`)","description":"Параметр вантажу для кожного місця відправлення","xml":{"name":"OptionsSeat","wrapped":true},"items":{"$ref":"#/components/schemas/AdditionalOptionSeatItem"}}}},"AdditionalOptionSeatItem":{"type":"object","title":"Параметри місця відправлення","description":"Об'єкт з деталізацією габаритів та характеристик окремого місця","additionalProperties":false,"xml":{"name":"item"},"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight","packRef"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см"},"weight":{"type":"string","description":"Вага місця в кг"},"packRef":{"type":"string","description":"Ідентифікатор паковання"}}},"SaveAdditionalServicesResponse":{"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/SaveAdditionalServicesItem"}},"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"}}}}},"SaveAdditionalServicesItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","description":"Ідентифікатор створеної експрес-накладної"},"CostOnSite":{"type":"string","description":"Розрахована вартість доставки (грн)"},"EstimatedDeliveryDate":{"type":"string","description":"Орієнтована дата доставки відправлення у форматі дд.мм.рррр"},"IntDocNumber":{"type":"string","description":"Номер створеної експрес-накладної (14 цифр)"},"TypeDocument":{"type":"string","description":"Тип створеного документа"}}}}}}
````
## Створити експрес-накладну до відділення (рядком) (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocumentGeneral\*\* (або \*\*InternetDocument\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до відділення.\
> \
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Delivery to Warehouse by String)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveWarehouseByStringDocumentJson","summary":"Створити експрес-накладну до відділення (рядком) (JSON)","description":"Метод **save** працює в моделі **InternetDocumentGeneral** (або **InternetDocument**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до відділення.\n\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveWarehouseByStringRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveWarehouseByStringResponse"}}}}}}}},"components":{"schemas":{"SaveWarehouseByStringRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveWarehouseByStringMethodProperties"}}},"SaveWarehouseByStringMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","RecipientsPhone","NewAddress","RecipientCityName","RecipientArea","RecipientAreaRegions","RecipientAddressName","RecipientName","RecipientType","SettlementType","EDRPOU"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004), обов'язково зазначати, якщо не передається параметр OptionsSeat"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість — 300.00)"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи-відправника. Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"NewAddress":{"type":"string","maxLength":36,"description":"Використання нового адресного довідника (1 — так, 0 — ні)"},"RecipientCityName":{"type":"string","maxLength":36,"description":"Назва міста отримувача (ЗАЗНАЧАЄТЬСЯ ТЕКСТОМ)"},"RecipientArea":{"type":"string","maxLength":36,"description":"Назва області (ЗАЗНАЧАЄТЬСЯ ТЕКСТОМ)"},"RecipientAreaRegions":{"type":"string","maxLength":36,"description":"Назва району (ЗАЗНАЧАЄТЬСЯ ТЕКСТОМ)"},"RecipientAddressName":{"type":"string","maxLength":36,"description":"Номер відділення"},"RecipientHouse":{"type":"string","maxLength":36,"description":"У разі відправлення на відділення це поле не заповнювати"},"RecipientFlat":{"type":"string","maxLength":36,"description":"У разі відправлення на відділення це поле не заповнювати"},"RecipientName":{"type":"string","maxLength":36,"description":"ПІБ отримувача (для приватної особи); назва організації отримувача (для організації)"},"RecipientType":{"type":"string","maxLength":36,"description":"Тип отримувача (Organization/PrivatePerson)"},"SettlementType":{"type":"string","maxLength":36,"description":"Тип населеного пункту: значення параметру SettlementTypeDescription з методу getSettlements або значення SettlementTypeCode запиту на онлайн-пошук населених пунктів searchSettlements"},"OwnershipForm":{"type":"string","maxLength":36,"description":"Ідентифікатор форми власності"},"RecipientContactName":{"type":"string","maxLength":36,"description":"ПІБ отримувача"},"EDRPOU":{"type":"string","maxLength":36,"description":"ЄДРПОУ"}}},"SaveWarehouseByStringResponse":{"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/SaveWarehouseByStringItem"}},"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"}}}}},"SaveWarehouseByStringItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","description":"Ідентифікатор (REF) експрес-накладної"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","description":"Тип експрес-накладної"}}}}}}
```
## Створити експрес-накладну до відділення (рядком) (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocumentGeneral\*\* (або \*\*InternetDocument\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до відділення.\
> \
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Delivery to Warehouse by String)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveWarehouseByStringDocumentXml","summary":"Створити експрес-накладну до відділення (рядком) (XML)","description":"Метод **save** працює в моделі **InternetDocumentGeneral** (або **InternetDocument**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до відділення.\n\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveWarehouseByStringRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveWarehouseByStringResponse"}}}}}}}},"components":{"schemas":{"SaveWarehouseByStringRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveWarehouseByStringMethodProperties"}}},"SaveWarehouseByStringMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","RecipientsPhone","NewAddress","RecipientCityName","RecipientArea","RecipientAreaRegions","RecipientAddressName","RecipientName","RecipientType","SettlementType","EDRPOU"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004), обов'язково зазначати, якщо не передається параметр OptionsSeat"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість — 300.00)"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи-відправника. Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"NewAddress":{"type":"string","maxLength":36,"description":"Використання нового адресного довідника (1 — так, 0 — ні)"},"RecipientCityName":{"type":"string","maxLength":36,"description":"Назва міста отримувача (ЗАЗНАЧАЄТЬСЯ ТЕКСТОМ)"},"RecipientArea":{"type":"string","maxLength":36,"description":"Назва області (ЗАЗНАЧАЄТЬСЯ ТЕКСТОМ)"},"RecipientAreaRegions":{"type":"string","maxLength":36,"description":"Назва району (ЗАЗНАЧАЄТЬСЯ ТЕКСТОМ)"},"RecipientAddressName":{"type":"string","maxLength":36,"description":"Номер відділення"},"RecipientHouse":{"type":"string","maxLength":36,"description":"У разі відправлення на відділення це поле не заповнювати"},"RecipientFlat":{"type":"string","maxLength":36,"description":"У разі відправлення на відділення це поле не заповнювати"},"RecipientName":{"type":"string","maxLength":36,"description":"ПІБ отримувача (для приватної особи); назва організації отримувача (для організації)"},"RecipientType":{"type":"string","maxLength":36,"description":"Тип отримувача (Organization/PrivatePerson)"},"SettlementType":{"type":"string","maxLength":36,"description":"Тип населеного пункту: значення параметру SettlementTypeDescription з методу getSettlements або значення SettlementTypeCode запиту на онлайн-пошук населених пунктів searchSettlements"},"OwnershipForm":{"type":"string","maxLength":36,"description":"Ідентифікатор форми власності"},"RecipientContactName":{"type":"string","maxLength":36,"description":"ПІБ отримувача"},"EDRPOU":{"type":"string","maxLength":36,"description":"ЄДРПОУ"}}},"SaveWarehouseByStringResponse":{"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/SaveWarehouseByStringItem"}},"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"}}}}},"SaveWarehouseByStringItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","description":"Ідентифікатор (REF) експрес-накладної"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","description":"Тип експрес-накладної"}}}}}}
```
## Створити експрес-накладну до адреси (рядком) (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocumentGeneral\*\* (або \*\*InternetDocument\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до АДРЕСИ.\
> \
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку ЕН в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Delivery to Address by String)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveAddressByStringDocumentJson","summary":"Створити експрес-накладну до адреси (рядком) (JSON)","description":"Метод **save** працює в моделі **InternetDocumentGeneral** (або **InternetDocument**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до АДРЕСИ.\n\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку ЕН в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveAddressByStringRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveAddressByStringResponse"}}}}}}}},"components":{"schemas":{"SaveAddressByStringRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveAddressByStringMethodProperties"}}},"SaveAddressByStringMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["RecipientAddressNote","PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","RecipientsPhone","NewAddress","RecipientCityName","RecipientArea","RecipientAreaRegions","RecipientAddressName","RecipientHouse","RecipientFlat","RecipientName","RecipientType","SettlementType","EDRPOU"],"properties":{"RecipientAddressNote":{"type":"string","maxLength":50,"description":"Коментар до адреси"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004). Обов'язково зазначати, якщо не передається параметр OptionsSeat"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, в кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":50,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість 300.00)"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи відправника. Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"NewAddress":{"type":"string","maxLength":36,"description":"Використання нового адресного довідника (1 — так, 0 — ні)"},"RecipientCityName":{"type":"string","maxLength":36,"description":"Назва міста отримувача (зазначається текстом)"},"RecipientArea":{"type":"string","maxLength":36,"description":"Назва області (зазначається текстом)"},"RecipientAreaRegions":{"type":"string","maxLength":36,"description":"Назва району (зазначається текстом)"},"RecipientAddressName":{"type":"string","maxLength":36,"description":"Назва вулиці (зазначається текстом)"},"RecipientHouse":{"type":"string","maxLength":36,"description":"Номер будинку"},"RecipientFlat":{"type":"string","maxLength":36,"description":"Номер квартири"},"RecipientName":{"type":"string","maxLength":36,"description":"ПІБ отримувача — для приватної особи; Назва організації отримувача — для організації"},"RecipientType":{"type":"string","maxLength":36,"description":"Тип отримувача (Organization/PrivatePerson)"},"SettlementType":{"type":"string","maxLength":36,"description":"Тип населеного пункту (значення SettlementTypeDescription з методу getSettlements або значення SettlementTypeCode з відповіді методу searchSettlements)"},"OwnershipForm":{"type":"string","maxLength":36,"description":"Ідентифікатор форми власності"},"RecipientContactName":{"type":"string","maxLength":36,"description":"ПІБ отримувача"},"EDRPOU":{"type":"string","maxLength":36,"description":"ЄДРПОУ"}}},"SaveAddressByStringResponse":{"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/SaveAddressByStringItem"}},"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"}}}}},"SaveAddressByStringItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","maxLength":36,"description":"Тип експрес-накладної"}}}}}}
```
## Створити експрес-накладну до адреси (рядком) (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocumentGeneral\*\* (або \*\*InternetDocument\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до АДРЕСИ.\
> \
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку ЕН в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Delivery to Address by String)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveAddressByStringDocumentXml","summary":"Створити експрес-накладну до адреси (рядком) (XML)","description":"Метод **save** працює в моделі **InternetDocumentGeneral** (або **InternetDocument**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) до АДРЕСИ.\n\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку ЕН в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveAddressByStringRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveAddressByStringResponse"}}}}}}}},"components":{"schemas":{"SaveAddressByStringRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveAddressByStringMethodProperties"}}},"SaveAddressByStringMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["RecipientAddressNote","PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","RecipientsPhone","NewAddress","RecipientCityName","RecipientArea","RecipientAreaRegions","RecipientAddressName","RecipientHouse","RecipientFlat","RecipientName","RecipientType","SettlementType","EDRPOU"],"properties":{"RecipientAddressNote":{"type":"string","maxLength":50,"description":"Коментар до адреси"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004). Обов'язково зазначати, якщо не передається параметр OptionsSeat"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, в кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":50,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість 300.00)"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи відправника. Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"NewAddress":{"type":"string","maxLength":36,"description":"Використання нового адресного довідника (1 — так, 0 — ні)"},"RecipientCityName":{"type":"string","maxLength":36,"description":"Назва міста отримувача (зазначається текстом)"},"RecipientArea":{"type":"string","maxLength":36,"description":"Назва області (зазначається текстом)"},"RecipientAreaRegions":{"type":"string","maxLength":36,"description":"Назва району (зазначається текстом)"},"RecipientAddressName":{"type":"string","maxLength":36,"description":"Назва вулиці (зазначається текстом)"},"RecipientHouse":{"type":"string","maxLength":36,"description":"Номер будинку"},"RecipientFlat":{"type":"string","maxLength":36,"description":"Номер квартири"},"RecipientName":{"type":"string","maxLength":36,"description":"ПІБ отримувача — для приватної особи; Назва організації отримувача — для організації"},"RecipientType":{"type":"string","maxLength":36,"description":"Тип отримувача (Organization/PrivatePerson)"},"SettlementType":{"type":"string","maxLength":36,"description":"Тип населеного пункту (значення SettlementTypeDescription з методу getSettlements або значення SettlementTypeCode з відповіді методу searchSettlements)"},"OwnershipForm":{"type":"string","maxLength":36,"description":"Ідентифікатор форми власності"},"RecipientContactName":{"type":"string","maxLength":36,"description":"ПІБ отримувача"},"EDRPOU":{"type":"string","maxLength":36,"description":"ЄДРПОУ"}}},"SaveAddressByStringResponse":{"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/SaveAddressByStringItem"}},"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"}}}}},"SaveAddressByStringItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","maxLength":36,"description":"Тип експрес-накладної"}}}}}}
```
## Створити експрес-накладну зі зворотною доставкою (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) із замовленням послуги «Зворотна доставка».\
> \
> Увага! Допустимі значення платника: «Відправник» або «Одержувач».\
> \
> Можливо сформувати запит із додатковими послугами.\
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка документів із різними підтипами»\
\
> \
> Щоб замовити послугу «Зворотна доставка документів із різними підтипами», у параметрі \`UserActions\` необхідно передавати значення \`UserCallSender\` («Перетелефонувати відправнику»). Це потрібно для того, щоб у разі відсутності в одержувача повного пакета документів або неправильно оформлених документів оператор міг зателефонувати відправнику та уточнити подальші дії.\
> \
> Можливі підтипи документів:\
> \- \`Attorney\` — довіреність із підписом та печаткою (доступно лише разом), значення \`true\` або \`false\`\
> \- \`IsTakeAttorney\` — забір довіреності, значення \`1\` — так, \`0\` — ні\
> \- \`WaybillNewPostWithStamp\`; \`WaybillNewPostWithoutStamp\` — експрес-накладна (ЕН) ТОВ «Нова пошта» з підписом та печаткою, значення \`true\` або \`false\`\
> \- \`WaybillNewPostWithStamp\` — ЕН ТОВ «Нова пошта» з печаткою, значення \`true\` або \`false\`\
> \- \`WaybillNewPostWithoutStamp\` — ЕН ТОВ «Нова пошта» з підписом, значення \`true\` або \`false\`\
> \- \`WaybillStateNumber1WithStamp\`; \`WaybillStateNumber1WithoutStamp\` — ТТН державного зразка (№1) з підписом та печаткою, значення \`true\` або \`false\`\
> \- \`WaybillStateNumber1WithStamp\` — ТТН державного зразка (№1) з печаткою, значення \`true\` або \`false\`\
> \- \`WaybillStateNumber1WithoutStamp\` — ТТН державного зразка (№1) з підписом, значення \`true\` або \`false\`\
> \- \`CostWaybillWithStamp\`; \`CostWaybillWithoutStamp\` — видаткова накладна з підписом та печаткою, значення \`true\` або \`false\`\
> \- \`CostWaybillWithStamp\` — видаткова накладна з печаткою, значення \`true\` або \`false\`\
> \- \`CostWaybillWithoutStamp\` — видаткова накладна з підписом, значення \`true\` або \`false\`\
> \- \`InternationalWaybill\` — міжнародна накладна з підписом, значення \`true\` або \`false\`\
> \- \`OrderFrom\` — бланк замовлення з підписом, значення \`true\` або \`false\`\
> \- \`AktPPVWithStamp\`, \`AktPPVWithoutStamp\` — акт прийому-передачі з підписом та печаткою, значення \`true\` або \`false\`\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender",\
> "CargoType": "Documents",\
> "Services": {\
> "Attorney": true,\
> "WaybillNewPostWithStamp": true,\
> "UserActions": "UserCallSender"\
> }\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка грошей»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender або Recipient",\
> "CargoType": "Money",\
> "RedeliveryString": "4552"\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Контроль підпису документів»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender",\
> "CargoType": "SignedDocuments",\
> "RedeliveryString": " "\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка піддонів»\
\
> \
> Увага! Послуга «Зворотна доставка піддонів» тимчасово відключена.\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка двох видів»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender",\
> "CargoType": "Money",\
> "RedeliveryString": "4552"\
> },\
> {\
> "PayerType": "Sender",\
> "CargoType": "Trays",\
> "RedeliveryString": "Піддоні( тара)",\
> "Trays": \[\
> {\
> "CargoDescription": "d5c36c5c-a29d-11de-a2ca-000c294065a1",\
> "Amount": "5"\
> },\
> {\
> "CargoDescription": "d5c36c5d-a29d-11de-a2ca-000c294065a1",\
> "Amount": "3"\
> }\
> ]\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка документів»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender або Recipient",\
> "CargoType": "Documents",\
> "RedeliveryString": ""\
> }\
> ]\
> \`\`\`\
> \ \
> \
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Redelivery)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveRedeliveryDocumentJson","summary":"Створити експрес-накладну зі зворотною доставкою (JSON)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) із замовленням послуги «Зворотна доставка».\n\nУвага! Допустимі значення платника: «Відправник» або «Одержувач».\n\nМожливо сформувати запит із додатковими послугами.\n\n\nФормування запиту із замовленням послуги «Зворотна доставка документів із різними підтипами»
\n\nЩоб замовити послугу «Зворотна доставка документів із різними підтипами», у параметрі `UserActions` необхідно передавати значення `UserCallSender` («Перетелефонувати відправнику»). Це потрібно для того, щоб у разі відсутності в одержувача повного пакета документів або неправильно оформлених документів оператор міг зателефонувати відправнику та уточнити подальші дії.\n\nМожливі підтипи документів:\n- `Attorney` — довіреність із підписом та печаткою (доступно лише разом), значення `true` або `false`\n- `IsTakeAttorney` — забір довіреності, значення `1` — так, `0` — ні\n- `WaybillNewPostWithStamp`; `WaybillNewPostWithoutStamp` — експрес-накладна (ЕН) ТОВ «Нова пошта» з підписом та печаткою, значення `true` або `false`\n- `WaybillNewPostWithStamp` — ЕН ТОВ «Нова пошта» з печаткою, значення `true` або `false`\n- `WaybillNewPostWithoutStamp` — ЕН ТОВ «Нова пошта» з підписом, значення `true` або `false`\n- `WaybillStateNumber1WithStamp`; `WaybillStateNumber1WithoutStamp` — ТТН державного зразка (№1) з підписом та печаткою, значення `true` або `false`\n- `WaybillStateNumber1WithStamp` — ТТН державного зразка (№1) з печаткою, значення `true` або `false`\n- `WaybillStateNumber1WithoutStamp` — ТТН державного зразка (№1) з підписом, значення `true` або `false`\n- `CostWaybillWithStamp`; `CostWaybillWithoutStamp` — видаткова накладна з підписом та печаткою, значення `true` або `false`\n- `CostWaybillWithStamp` — видаткова накладна з печаткою, значення `true` або `false`\n- `CostWaybillWithoutStamp` — видаткова накладна з підписом, значення `true` або `false`\n- `InternationalWaybill` — міжнародна накладна з підписом, значення `true` або `false`\n- `OrderFrom` — бланк замовлення з підписом, значення `true` або `false`\n- `AktPPVWithStamp`, `AktPPVWithoutStamp` — акт прийому-передачі з підписом та печаткою, значення `true` або `false`\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"Documents\",\n \"Services\": {\n \"Attorney\": true,\n \"WaybillNewPostWithStamp\": true,\n \"UserActions\": \"UserCallSender\"\n }\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка грошей»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender або Recipient\",\n \"CargoType\": \"Money\",\n \"RedeliveryString\": \"4552\"\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Контроль підпису документів»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"SignedDocuments\",\n \"RedeliveryString\": \" \"\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка піддонів»
\n\nУвага! Послуга «Зворотна доставка піддонів» тимчасово відключена.\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка двох видів»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"Money\",\n \"RedeliveryString\": \"4552\"\n },\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"Trays\",\n \"RedeliveryString\": \"Піддоні( тара)\",\n \"Trays\": [\n {\n \"CargoDescription\": \"d5c36c5c-a29d-11de-a2ca-000c294065a1\",\n \"Amount\": \"5\"\n },\n {\n \"CargoDescription\": \"d5c36c5d-a29d-11de-a2ca-000c294065a1\",\n \"Amount\": \"3\"\n }\n ]\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка документів»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender або Recipient\",\n \"CargoType\": \"Documents\",\n \"RedeliveryString\": \"\"\n }\n]\n```\n \n\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveRedeliveryRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveRedeliveryResponse"}}}}}}}},"components":{"schemas":{"SaveRedeliveryRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveRedeliveryMethodProperties"}}},"SaveRedeliveryMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","NewAddress","OptionsSeat"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість 300.01)"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника (REF). Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи відправника (REF). Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"NewAddress":{"type":"string","maxLength":36,"description":"Використання нового адресного довідника (1 — так, 0 — ні)"},"OptionsSeat":{"type":"array","description":"Параметр вантажу для кожного місця відправлення","xml":{"name":"OptionsSeat","wrapped":true},"items":{"$ref":"#/components/schemas/RedeliveryOptionSeatItem"}},"BackwardDeliveryData":{"type":"array","description":"Зворотна доставка підтипів документів","xml":{"name":"BackwardDeliveryData","wrapped":true},"items":{"type":"object","xml":{"name":"item"}}}}},"RedeliveryOptionSeatItem":{"type":"object","title":"Параметри місця відправлення","additionalProperties":false,"xml":{"name":"item"},"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string"},"volumetricWidth":{"type":"string"},"volumetricLength":{"type":"string"},"volumetricHeight":{"type":"string"},"weight":{"type":"string"}}},"SaveRedeliveryResponse":{"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/SaveRedeliveryItem"}},"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"}}}}},"SaveRedeliveryItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","maxLength":36,"description":"Тип експрес-накладної"}}}}}}
````
## Створити експрес-накладну зі зворотною доставкою (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) із замовленням послуги «Зворотна доставка».\
> \
> Увага! Допустимі значення платника: «Відправник» або «Одержувач».\
> \
> Можливо сформувати запит із додатковими послугами.\
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка документів із різними підтипами»\
\
> \
> Щоб замовити послугу «Зворотна доставка документів із різними підтипами», у параметрі \`UserActions\` необхідно передавати значення \`UserCallSender\` («Перетелефонувати відправнику»). Це потрібно для того, щоб у разі відсутності в одержувача повного пакета документів або неправильно оформлених документів оператор міг зателефонувати відправнику та уточнити подальші дії.\
> \
> Можливі підтипи документів:\
> \- \`Attorney\` — довіреність із підписом та печаткою (доступно лише разом), значення \`true\` або \`false\`\
> \- \`IsTakeAttorney\` — забір довіреності, значення \`1\` — так, \`0\` — ні\
> \- \`WaybillNewPostWithStamp\`; \`WaybillNewPostWithoutStamp\` — експрес-накладна (ЕН) ТОВ «Нова пошта» з підписом та печаткою, значення \`true\` або \`false\`\
> \- \`WaybillNewPostWithStamp\` — ЕН ТОВ «Нова пошта» з печаткою, значення \`true\` або \`false\`\
> \- \`WaybillNewPostWithoutStamp\` — ЕН ТОВ «Нова пошта» з підписом, значення \`true\` або \`false\`\
> \- \`WaybillStateNumber1WithStamp\`; \`WaybillStateNumber1WithoutStamp\` — ТТН державного зразка (№1) з підписом та печаткою, значення \`true\` або \`false\`\
> \- \`WaybillStateNumber1WithStamp\` — ТТН державного зразка (№1) з печаткою, значення \`true\` або \`false\`\
> \- \`WaybillStateNumber1WithoutStamp\` — ТТН державного зразка (№1) з підписом, значення \`true\` або \`false\`\
> \- \`CostWaybillWithStamp\`; \`CostWaybillWithoutStamp\` — видаткова накладна з підписом та печаткою, значення \`true\` або \`false\`\
> \- \`CostWaybillWithStamp\` — видаткова накладна з печаткою, значення \`true\` або \`false\`\
> \- \`CostWaybillWithoutStamp\` — видаткова накладна з підписом, значення \`true\` або \`false\`\
> \- \`InternationalWaybill\` — міжнародна накладна з підписом, значення \`true\` або \`false\`\
> \- \`OrderFrom\` — бланк замовлення з підписом, значення \`true\` або \`false\`\
> \- \`AktPPVWithStamp\`, \`AktPPVWithoutStamp\` — акт прийому-передачі з підписом та печаткою, значення \`true\` або \`false\`\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender",\
> "CargoType": "Documents",\
> "Services": {\
> "Attorney": true,\
> "WaybillNewPostWithStamp": true,\
> "UserActions": "UserCallSender"\
> }\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка грошей»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender або Recipient",\
> "CargoType": "Money",\
> "RedeliveryString": "4552"\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Контроль підпису документів»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender",\
> "CargoType": "SignedDocuments",\
> "RedeliveryString": " "\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка піддонів»\
\
> \
> Увага! Послуга «Зворотна доставка піддонів» тимчасово відключена.\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка двох видів»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender",\
> "CargoType": "Money",\
> "RedeliveryString": "4552"\
> },\
> {\
> "PayerType": "Sender",\
> "CargoType": "Trays",\
> "RedeliveryString": "Піддоні( тара)",\
> "Trays": \[\
> {\
> "CargoDescription": "d5c36c5c-a29d-11de-a2ca-000c294065a1",\
> "Amount": "5"\
> },\
> {\
> "CargoDescription": "d5c36c5d-a29d-11de-a2ca-000c294065a1",\
> "Amount": "3"\
> }\
> ]\
> }\
> ]\
> \`\`\`\
> \ \
> \
> \\
> \Формування запиту із замовленням послуги «Зворотна доставка документів»\
\
> \
> Приклад:\
> \`\`\`json\
> "BackwardDeliveryData": \[\
> {\
> "PayerType": "Sender або Recipient",\
> "CargoType": "Documents",\
> "RedeliveryString": ""\
> }\
> ]\
> \`\`\`\
> \ \
> \
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Redelivery)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveRedeliveryDocumentXml","summary":"Створити експрес-накладну зі зворотною доставкою (XML)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати/формувати експрес-накладну (інтернет-документ) із замовленням послуги «Зворотна доставка».\n\nУвага! Допустимі значення платника: «Відправник» або «Одержувач».\n\nМожливо сформувати запит із додатковими послугами.\n\n\nФормування запиту із замовленням послуги «Зворотна доставка документів із різними підтипами»
\n\nЩоб замовити послугу «Зворотна доставка документів із різними підтипами», у параметрі `UserActions` необхідно передавати значення `UserCallSender` («Перетелефонувати відправнику»). Це потрібно для того, щоб у разі відсутності в одержувача повного пакета документів або неправильно оформлених документів оператор міг зателефонувати відправнику та уточнити подальші дії.\n\nМожливі підтипи документів:\n- `Attorney` — довіреність із підписом та печаткою (доступно лише разом), значення `true` або `false`\n- `IsTakeAttorney` — забір довіреності, значення `1` — так, `0` — ні\n- `WaybillNewPostWithStamp`; `WaybillNewPostWithoutStamp` — експрес-накладна (ЕН) ТОВ «Нова пошта» з підписом та печаткою, значення `true` або `false`\n- `WaybillNewPostWithStamp` — ЕН ТОВ «Нова пошта» з печаткою, значення `true` або `false`\n- `WaybillNewPostWithoutStamp` — ЕН ТОВ «Нова пошта» з підписом, значення `true` або `false`\n- `WaybillStateNumber1WithStamp`; `WaybillStateNumber1WithoutStamp` — ТТН державного зразка (№1) з підписом та печаткою, значення `true` або `false`\n- `WaybillStateNumber1WithStamp` — ТТН державного зразка (№1) з печаткою, значення `true` або `false`\n- `WaybillStateNumber1WithoutStamp` — ТТН державного зразка (№1) з підписом, значення `true` або `false`\n- `CostWaybillWithStamp`; `CostWaybillWithoutStamp` — видаткова накладна з підписом та печаткою, значення `true` або `false`\n- `CostWaybillWithStamp` — видаткова накладна з печаткою, значення `true` або `false`\n- `CostWaybillWithoutStamp` — видаткова накладна з підписом, значення `true` або `false`\n- `InternationalWaybill` — міжнародна накладна з підписом, значення `true` або `false`\n- `OrderFrom` — бланк замовлення з підписом, значення `true` або `false`\n- `AktPPVWithStamp`, `AktPPVWithoutStamp` — акт прийому-передачі з підписом та печаткою, значення `true` або `false`\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"Documents\",\n \"Services\": {\n \"Attorney\": true,\n \"WaybillNewPostWithStamp\": true,\n \"UserActions\": \"UserCallSender\"\n }\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка грошей»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender або Recipient\",\n \"CargoType\": \"Money\",\n \"RedeliveryString\": \"4552\"\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Контроль підпису документів»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"SignedDocuments\",\n \"RedeliveryString\": \" \"\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка піддонів»
\n\nУвага! Послуга «Зворотна доставка піддонів» тимчасово відключена.\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка двох видів»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"Money\",\n \"RedeliveryString\": \"4552\"\n },\n {\n \"PayerType\": \"Sender\",\n \"CargoType\": \"Trays\",\n \"RedeliveryString\": \"Піддоні( тара)\",\n \"Trays\": [\n {\n \"CargoDescription\": \"d5c36c5c-a29d-11de-a2ca-000c294065a1\",\n \"Amount\": \"5\"\n },\n {\n \"CargoDescription\": \"d5c36c5d-a29d-11de-a2ca-000c294065a1\",\n \"Amount\": \"3\"\n }\n ]\n }\n]\n```\n \n\n\nФормування запиту із замовленням послуги «Зворотна доставка документів»
\n\nПриклад:\n```json\n\"BackwardDeliveryData\": [\n {\n \"PayerType\": \"Sender або Recipient\",\n \"CargoType\": \"Documents\",\n \"RedeliveryString\": \"\"\n }\n]\n```\n \n\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveRedeliveryRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveRedeliveryResponse"}}}}}}}},"components":{"schemas":{"SaveRedeliveryRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveRedeliveryMethodProperties"}}},"SaveRedeliveryMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["PayerType","PaymentMethod","DateTime","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone","NewAddress","OptionsSeat"],"properties":{"PayerType":{"type":"string","maxLength":36,"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість 300.01)"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника (REF). Дані з відповіді методу «Список адрес контрагента»"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи відправника (REF). Дані з відповіді методу «Список контактних осіб контрагента»"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"},"NewAddress":{"type":"string","maxLength":36,"description":"Використання нового адресного довідника (1 — так, 0 — ні)"},"OptionsSeat":{"type":"array","description":"Параметр вантажу для кожного місця відправлення","xml":{"name":"OptionsSeat","wrapped":true},"items":{"$ref":"#/components/schemas/RedeliveryOptionSeatItem"}},"BackwardDeliveryData":{"type":"array","description":"Зворотна доставка підтипів документів","xml":{"name":"BackwardDeliveryData","wrapped":true},"items":{"type":"object","xml":{"name":"item"}}}}},"RedeliveryOptionSeatItem":{"type":"object","title":"Параметри місця відправлення","additionalProperties":false,"xml":{"name":"item"},"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string"},"volumetricWidth":{"type":"string"},"volumetricLength":{"type":"string"},"volumetricHeight":{"type":"string"},"weight":{"type":"string"}}},"SaveRedeliveryResponse":{"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/SaveRedeliveryItem"}},"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"}}}}},"SaveRedeliveryItem":{"type":"object","title":"Дані створеної експрес-накладної","description":"Об'єкт, що містить основну інформацію про згенеровану ЕН","additionalProperties":false,"xml":{"name":"item"},"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор експрес-накладної"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","maxLength":36,"description":"Тип експрес-накладної"}}}}}}
````
## Створити експрес-накладну з поштомата (JSON)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати експрес-накладну (інтернет-документ). \
> За допомогою методу можна створювати експрес-накладні (ЕН) для відправлень із поштоматів. Для цього обов'язково вказують параметри розмірів.\
> \
> \\
> \Обмеження\
\
> \
> \- Відправляти з поштомата можна тільки типи вантажу «Посилка» (\`Parcel\`) та «Документи» (\`Documents\`).\
> \- Максимальне значення оціночної вартості для відправки з поштомата (параметр \`Cost\`) — 10000 грн.\
> \- Максимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см.\
> \- Максимально допустима вага вантажу — 20 кг.\
> \- У разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення.\
> \
> \ \
> \
> \\
> \Пакування в поштоматі\
\
> \
> Окремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу \*\*getPackListSpecial\*\*. Отриманий ідентифікатор потрібно передати у параметрі \`Ref\` масиву \`OptionSeat\` під час створення ЕН.\
> \
> \ \
> \
> Вартість пакування додається до вартості послуги доставки.\
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Locker Internet Document","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"saveLockerInternetDocumentJson","summary":"Створити експрес-накладну з поштомата (JSON)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати експрес-накладну (інтернет-документ). \nЗа допомогою методу можна створювати експрес-накладні (ЕН) для відправлень із поштоматів. Для цього обов'язково вказують параметри розмірів.\n\n\nОбмеження
\n\n- Відправляти з поштомата можна тільки типи вантажу «Посилка» (`Parcel`) та «Документи» (`Documents`).\n- Максимальне значення оціночної вартості для відправки з поштомата (параметр `Cost`) — 10000 грн.\n- Максимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см.\n- Максимально допустима вага вантажу — 20 кг.\n- У разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення.\n\n \n\n\nПакування в поштоматі
\n\nОкремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу **getPackListSpecial**. Отриманий ідентифікатор потрібно передати у параметрі `Ref` масиву `OptionSeat` під час створення ЕН.\n\n \n\nВартість пакування додається до вартості послуги доставки.\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveLockerInternetDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveInternetDocumentResponse"}}}}}}}},"components":{"schemas":{"SaveLockerInternetDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveLockerInternetDocumentMethodProperties"}}},"SaveLockerInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["ContactRecipient","ContactSender","ServiceType","PayerType","Weight","SenderAddress","Sender","CargoType","RecipientAddress","CitySender","Recipient","Cost","OptionSeat","CityRecipient","Description","DateTime","RecipientsPhone","SeatsAmount","SendersPhone","PaymentMethod"],"properties":{"ContactRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) контактної особи отримувача"},"ContactSender":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) контактної особи-відправника.\nДані з відповіді методу «Список контактних осіб контрагента»\n"},"ServiceType":{"type":"string","enum":["WarehouseDoors","WarehouseWarehouse"],"description":"Технологія доставки (`WarehouseDoors`, `WarehouseWarehouse`)"},"PayerType":{"type":"string","enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника (`Sender`, `Recipient`, `ThirdPerson`)"},"Weight":{"type":"string","description":"Фактична вага, кг.\nМінімальне значення `0.1`. Максимально допустима вага — 20 кг\n"},"SenderAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) адреси відправника.\nДані з відповіді методу «Список адрес контрагента»\n"},"RecipientWarehouseIndex":{"type":"string","description":"Цифрова адреса відділення отримувача"},"Sender":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) відправника"},"CargoType":{"type":"string","enum":["Parcel","Documents"],"description":"Тип вантажу.\nВідправляти з поштомата можна тільки типи вантажу «Посилка» (`Parcel`) та «Документи» (`Documents`)\n"},"SenderWarehouseIndex":{"type":"string","description":"Цифрова адреса поштомата відправника"},"RecipientAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) адреси отримувача"},"CitySender":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) міста відправника"},"Recipient":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) отримувача"},"Cost":{"type":"string","description":"Оціночна вартість, ціле число.\nМаксимальне значення оціночної вартості для відправки з поштомата (параметр `Cost`) — 10000 грн\n"},"OptionSeat":{"type":"array","description":"Параметр вантажу для кожного місця відправлення.\nДля цього обов'язково вказують параметри розмірів.\nУ разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення\n","items":{"$ref":"#/components/schemas/OptionSeatItem"}},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) міста отримувача"},"Description":{"type":"string","description":"Текстове поле, вводиться для додаткового опису відправлення"},"DateTime":{"type":"string","description":"Дата відправки у форматі `дд.мм.рррр`"},"RecipientsPhone":{"type":"string","description":"Телефон отримувача у форматі `+380660000000`, `380660000000`, `0660000001`"},"SeatsAmount":{"type":"string","enum":["1"],"description":"Кількість місць відправлення, ціле число.\nУ разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення\n"},"SendersPhone":{"type":"string","description":"Телефон відправника у форматі `+380660000000`, `380660000000`, `0660000001`"},"PaymentMethod":{"type":"string","enum":["Cash","NonCash"],"description":"Форма розрахунку (`Cash` / `NonCash`)"}}},"OptionSeatItem":{"type":"object","additionalProperties":false,"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см.\nМаксимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см\n"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см.\nМаксимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см\n"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см.\nМаксимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см\n"},"weight":{"type":"string","description":"Вага місця в кг.\nМаксимально допустима вага вантажу — 20 кг\n"},"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор паковання.\nОкремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу `getPackListSpecial`. Отриманий ідентифікатор потрібно передати у параметрі `Ref` масиву `OptionSeat` під час створення ЕН.\n"}}},"SaveInternetDocumentResponse":{"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/SaveInternetDocumentItem"}},"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"}}}},"SaveInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"TypeDocument":{"type":"string","description":"Тип експрес-накладної"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор експрес-накладної"}}}}}}
```
## Створити експрес-накладну з поштомата (XML)
> Метод \*\*save\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє створювати експрес-накладну (інтернет-документ). \
> За допомогою методу можна створювати експрес-накладні (ЕН) для відправлень із поштоматів. Для цього обов'язково вказують параметри розмірів.\
> \
> \\
> \Обмеження\
\
> \
> \- Відправляти з поштомата можна тільки типи вантажу «Посилка» (\`Parcel\`) та «Документи» (\`Documents\`).\
> \- Максимальне значення оціночної вартості для відправки з поштомата (параметр \`Cost\`) — 10000 грн.\
> \- Максимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см.\
> \- Максимально допустима вага вантажу — 20 кг.\
> \- У разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення.\
> \
> \ \
> \
> \\
> \Пакування в поштоматі\
\
> \
> Окремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу \*\*getPackListSpecial\*\*. Отриманий ідентифікатор потрібно передати у параметрі \`Ref\` масиву \`OptionSeat\` під час створення ЕН.\
> \
> \ \
> \
> Вартість пакування додається до вартості послуги доставки.\
> Після створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Locker Internet Document","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані зі створенням експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"saveLockerInternetDocumentXml","summary":"Створити експрес-накладну з поштомата (XML)","description":"Метод **save** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє створювати експрес-накладну (інтернет-документ). \nЗа допомогою методу можна створювати експрес-накладні (ЕН) для відправлень із поштоматів. Для цього обов'язково вказують параметри розмірів.\n\n\nОбмеження
\n\n- Відправляти з поштомата можна тільки типи вантажу «Посилка» (`Parcel`) та «Документи» (`Documents`).\n- Максимальне значення оціночної вартості для відправки з поштомата (параметр `Cost`) — 10000 грн.\n- Максимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см.\n- Максимально допустима вага вантажу — 20 кг.\n- У разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення.\n\n \n\n\nПакування в поштоматі
\n\nОкремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу **getPackListSpecial**. Отриманий ідентифікатор потрібно передати у параметрі `Ref` масиву `OptionSeat` під час створення ЕН.\n\n \n\nВартість пакування додається до вартості послуги доставки.\nПісля створення інтернет-документа в програмному середовищі API, ЕН з'являється у відповідному списку в особистому кабінеті.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveLockerInternetDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveInternetDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"SaveLockerInternetDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveLockerInternetDocumentXmlMethodProperties"}}},"SaveLockerInternetDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveLockerInternetDocumentMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveLockerInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["ContactRecipient","ContactSender","ServiceType","PayerType","Weight","SenderAddress","Sender","CargoType","RecipientAddress","CitySender","Recipient","Cost","OptionSeat","CityRecipient","Description","DateTime","RecipientsPhone","SeatsAmount","SendersPhone","PaymentMethod"],"properties":{"ContactRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) контактної особи отримувача"},"ContactSender":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) контактної особи-відправника.\nДані з відповіді методу «Список контактних осіб контрагента»\n"},"ServiceType":{"type":"string","enum":["WarehouseDoors","WarehouseWarehouse"],"description":"Технологія доставки (`WarehouseDoors`, `WarehouseWarehouse`)"},"PayerType":{"type":"string","enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника (`Sender`, `Recipient`, `ThirdPerson`)"},"Weight":{"type":"string","description":"Фактична вага, кг.\nМінімальне значення `0.1`. Максимально допустима вага — 20 кг\n"},"SenderAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) адреси відправника.\nДані з відповіді методу «Список адрес контрагента»\n"},"RecipientWarehouseIndex":{"type":"string","description":"Цифрова адреса відділення отримувача"},"Sender":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) відправника"},"CargoType":{"type":"string","enum":["Parcel","Documents"],"description":"Тип вантажу.\nВідправляти з поштомата можна тільки типи вантажу «Посилка» (`Parcel`) та «Документи» (`Documents`)\n"},"SenderWarehouseIndex":{"type":"string","description":"Цифрова адреса поштомата відправника"},"RecipientAddress":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) адреси отримувача"},"CitySender":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) міста відправника"},"Recipient":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) отримувача"},"Cost":{"type":"string","description":"Оціночна вартість, ціле число.\nМаксимальне значення оціночної вартості для відправки з поштомата (параметр `Cost`) — 10000 грн\n"},"OptionSeat":{"type":"array","description":"Параметр вантажу для кожного місця відправлення.\nДля цього обов'язково вказують параметри розмірів.\nУ разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення\n","items":{"$ref":"#/components/schemas/OptionSeatItem"}},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (`Ref`) міста отримувача"},"Description":{"type":"string","description":"Текстове поле, вводиться для додаткового опису відправлення"},"DateTime":{"type":"string","description":"Дата відправки у форматі `дд.мм.рррр`"},"RecipientsPhone":{"type":"string","description":"Телефон отримувача у форматі `+380660000000`, `380660000000`, `0660000001`"},"SeatsAmount":{"type":"string","enum":["1"],"description":"Кількість місць відправлення, ціле число.\nУ разі створення відправлення з поштомата можна вказувати лише одне місце на одне відправлення\n"},"SendersPhone":{"type":"string","description":"Телефон відправника у форматі `+380660000000`, `380660000000`, `0660000001`"},"PaymentMethod":{"type":"string","enum":["Cash","NonCash"],"description":"Форма розрахунку (`Cash` / `NonCash`)"}}},"OptionSeatItem":{"type":"object","additionalProperties":false,"required":["volumetricVolume","volumetricWidth","volumetricLength","volumetricHeight","weight"],"properties":{"volumetricVolume":{"type":"string","description":"Об'єм одного місця в кубічних метрах"},"volumetricWidth":{"type":"string","description":"Ширина одного місця в см.\nМаксимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см\n"},"volumetricLength":{"type":"string","description":"Довжина одного місця в см.\nМаксимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см\n"},"volumetricHeight":{"type":"string","description":"Висота одного місця в см.\nМаксимально допустимі габарити вантажу: ширина — 40 см; довжина — 60 см; висота — 30 см\n"},"weight":{"type":"string","description":"Вага місця в кг.\nМаксимально допустима вага вантажу — 20 кг\n"},"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор паковання.\nОкремо (лише для відправлень із поштомата) можна замовити послугу «Пакування в поштоматі». Для цього слід отримати ідентифікатор паковання за допомогою методу `getPackListSpecial`. Отриманий ідентифікатор потрібно передати у параметрі `Ref` масиву `OptionSeat` під час створення ЕН.\n"}}},"SaveInternetDocumentXmlResponse":{"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/SaveInternetDocumentItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string"}}}},"SaveInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"TypeDocument":{"type":"string","description":"Тип експрес-накладної"},"IntDocNumber":{"type":"string","description":"Номер експрес-накладної"},"EstimatedDeliveryDate":{"type":"string","description":"Прогнозована дата доставки"},"CostOnSite":{"type":"string","description":"Вартість доставки"},"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор експрес-накладної"}}}}}}
```
### Отримати дані чи видалити експрес-накладну
## Розрахувати вартість послуг (JSON)
> Метод \*\*getDocumentPrice\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод розраховує вартість доставки вантажу.\
> Метод дозволяє прораховувати не тільки відправлення вантажів, але і шин та дисків, палет, а також документів.\
> \
> \\
> \Приклад прорахунку вартості шин та дисків\
\
> \
> \`\`\`json\
> "CargoType": "TiresWheels", // Тип відправлення «Шини та Диски»\
> "CargoDetails": \[{// Масив із даними\
> "CargoDescription":"d7c456cf-aa8b-11e3-9fa0-0050568002cf", // Ідентифікатор типу відправлення (Шина R-13), із довідника «Види шин та дисків»\
> "Amount": "2" //Кількість шин }]\
> \`\`\`\
> \ \
> \
> \\
> \Приклад розрахунку вартості вантажів із передачею параметрів\
\
> \
> \`\`\`json\
> "OptionsSeat": \[{// Масив із даними\
> "weight": 5, // Вага відправлення, кг\
> "volumetricWidth": 80, // Ширина відправлення, см\
> "volumetricLength": 25, // Довжина відправлення, см\
> "volumetricHeight": 25, // Висота відправлення, см }]\
> \`\`\`\
> \ \
> \
> \\
> \Приклад розрахунку вартості з пакуванням\
\
> \
> Також доступний прорахунок вартості з урахуванням паковання із відповідного довідника «Види паковання». Ідентифікатор паковання необхідно передавати в масиві \`OptionsSeat\`.\
> \
> \`\`\`json\
> "OptionsSeat": \[{// Масив із даними\
> "weight": 5, // Вага відправлення, кг\
> "volumetricWidth": 80, // Ширина відправлення, см\
> "volumetricLength": 25, // Довжина відправлення, см\
> "volumetricHeight": 25, // Висота відправлення, см\
> "packRef": "1499fa4a-d26e-11e1-95e4-0026b97ed48a" }]\
> \`\`\`\
> \
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Get Document Price)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з розрахунком вартості послуг"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"getDocumentPriceJson","summary":"Розрахувати вартість послуг (JSON)","description":"Метод **getDocumentPrice** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод розраховує вартість доставки вантажу.\nМетод дозволяє прораховувати не тільки відправлення вантажів, але і шин та дисків, палет, а також документів.\n\n\nПриклад прорахунку вартості шин та дисків
\n\n```json\n\"CargoType\": \"TiresWheels\", // Тип відправлення «Шини та Диски»\n\"CargoDetails\": [{// Масив із даними\n\"CargoDescription\":\"d7c456cf-aa8b-11e3-9fa0-0050568002cf\", // Ідентифікатор типу відправлення (Шина R-13), із довідника «Види шин та дисків»\n\"Amount\": \"2\" //Кількість шин }]\n```\n \n\n\nПриклад розрахунку вартості вантажів із передачею параметрів
\n\n```json\n\"OptionsSeat\": [{// Масив із даними\n\"weight\": 5, // Вага відправлення, кг\n\"volumetricWidth\": 80, // Ширина відправлення, см\n\"volumetricLength\": 25, // Довжина відправлення, см\n\"volumetricHeight\": 25, // Висота відправлення, см }]\n```\n \n\n\nПриклад розрахунку вартості з пакуванням
\n\nТакож доступний прорахунок вартості з урахуванням паковання із відповідного довідника «Види паковання». Ідентифікатор паковання необхідно передавати в масиві `OptionsSeat`.\n\n```json\n\"OptionsSeat\": [{// Масив із даними\n\"weight\": 5, // Вага відправлення, кг\n\"volumetricWidth\": 80, // Ширина відправлення, см\n\"volumetricLength\": 25, // Довжина відправлення, см\n\"volumetricHeight\": 25, // Висота відправлення, см\n\"packRef\": \"1499fa4a-d26e-11e1-95e4-0026b97ed48a\" }]\n```\n \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentPriceRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentPriceResponse"}}}}}}}},"components":{"schemas":{"GetDocumentPriceRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getDocumentPrice"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetDocumentPriceMethodProperties"}}},"GetDocumentPriceMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["CitySender","CityRecipient","Weight","ServiceType","Cost","CargoType","SeatsAmount"],"properties":{"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, min. 0,1"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість — 300.00)"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу: Cargo, Documents, TiresWheels, Pallet"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"RedeliveryCalculate":{"type":"object","description":"Зворотна доставка","properties":{"CargoType":{"type":"string"},"Amount":{"type":"string"}}},"PackCount":{"type":"string","maxLength":36,"description":"Кількість паковання"},"PackRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) паковання"},"Amount":{"type":"string","maxLength":36,"description":"Ціле число (сума зворотної доставки/кількість одиниць)"},"CargoDetails":{"type":"array","description":"Масив із даними про деталі вантажу","xml":{"name":"CargoDetails","wrapped":true},"items":{"type":"object","xml":{"name":"item"},"properties":{"CargoDescription":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу відправлення"},"Amount":{"type":"string"}}}},"CargoDescription":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу відправлення"}}},"GetDocumentPriceResponse":{"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/GetDocumentPriceItem"}},"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"}}}}},"GetDocumentPriceItem":{"type":"object","title":"Результати розрахунку вартості","description":"Об'єкт з інформацією про вартість послуг","additionalProperties":false,"xml":{"name":"item"},"properties":{"AssessedCost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"Cost":{"type":"string","maxLength":36,"description":"Вартість"},"CostRedelivery":{"type":"string","maxLength":36,"description":"Вартість зворотної доставки"},"TZoneInfo":{"type":"object","description":"Інформація про тарифну зону доставки","properties":{"TzoneName":{"type":"string"},"TzoneID":{"type":"string"}}},"CostPack":{"type":"string","maxLength":36,"description":"Вартість пакування"}}}}}}
````
## Розрахувати вартість послуг (XML)
> Метод \*\*getDocumentPrice\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод розраховує вартість доставки вантажу.\
> Метод дозволяє прораховувати не тільки відправлення вантажів, але і шин та дисків, палет, а також документів.\
> \
> \\
> \Приклад прорахунку вартості шин та дисків\
\
> \
> \`\`\`json\
> "CargoType": "TiresWheels", // Тип відправлення «Шини та Диски»\
> "CargoDetails": \[{// Масив із даними\
> "CargoDescription":"d7c456cf-aa8b-11e3-9fa0-0050568002cf", // Ідентифікатор типу відправлення (Шина R-13), із довідника «Види шин та дисків»\
> "Amount": "2" //Кількість шин }]\
> \`\`\`\
> \ \
> \
> \\
> \Приклад розрахунку вартості вантажів із передачею параметрів\
\
> \
> \`\`\`json\
> "OptionsSeat": \[{// Масив із даними\
> "weight": 5, // Вага відправлення, кг\
> "volumetricWidth": 80, // Ширина відправлення, см\
> "volumetricLength": 25, // Довжина відправлення, см\
> "volumetricHeight": 25, // Висота відправлення, см }]\
> \`\`\`\
> \ \
> \
> \\
> \Приклад розрахунку вартості з пакуванням\
\
> \
> Також доступний прорахунок вартості з урахуванням паковання із відповідного довідника «Види паковання». Ідентифікатор паковання необхідно передавати в масиві \`OptionsSeat\`.\
> \
> \`\`\`json\
> "OptionsSeat": \[{// Масив із даними\
> "weight": 5, // Вага відправлення, кг\
> "volumetricWidth": 80, // Ширина відправлення, см\
> "volumetricLength": 25, // Довжина відправлення, см\
> "volumetricHeight": 25, // Висота відправлення, см\
> "packRef": "1499fa4a-d26e-11e1-95e4-0026b97ed48a" }]\
> \`\`\`\
> \
````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Get Document Price)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з розрахунком вартості послуг"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"getDocumentPriceXml","summary":"Розрахувати вартість послуг (XML)","description":"Метод **getDocumentPrice** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод розраховує вартість доставки вантажу.\nМетод дозволяє прораховувати не тільки відправлення вантажів, але і шин та дисків, палет, а також документів.\n\n\nПриклад прорахунку вартості шин та дисків
\n\n```json\n\"CargoType\": \"TiresWheels\", // Тип відправлення «Шини та Диски»\n\"CargoDetails\": [{// Масив із даними\n\"CargoDescription\":\"d7c456cf-aa8b-11e3-9fa0-0050568002cf\", // Ідентифікатор типу відправлення (Шина R-13), із довідника «Види шин та дисків»\n\"Amount\": \"2\" //Кількість шин }]\n```\n \n\n\nПриклад розрахунку вартості вантажів із передачею параметрів
\n\n```json\n\"OptionsSeat\": [{// Масив із даними\n\"weight\": 5, // Вага відправлення, кг\n\"volumetricWidth\": 80, // Ширина відправлення, см\n\"volumetricLength\": 25, // Довжина відправлення, см\n\"volumetricHeight\": 25, // Висота відправлення, см }]\n```\n \n\n\nПриклад розрахунку вартості з пакуванням
\n\nТакож доступний прорахунок вартості з урахуванням паковання із відповідного довідника «Види паковання». Ідентифікатор паковання необхідно передавати в масиві `OptionsSeat`.\n\n```json\n\"OptionsSeat\": [{// Масив із даними\n\"weight\": 5, // Вага відправлення, кг\n\"volumetricWidth\": 80, // Ширина відправлення, см\n\"volumetricLength\": 25, // Довжина відправлення, см\n\"volumetricHeight\": 25, // Висота відправлення, см\n\"packRef\": \"1499fa4a-d26e-11e1-95e4-0026b97ed48a\" }]\n```\n \n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetDocumentPriceRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetDocumentPriceResponse"}}}}}}}},"components":{"schemas":{"GetDocumentPriceRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getDocumentPrice"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetDocumentPriceMethodProperties"}}},"GetDocumentPriceMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["CitySender","CityRecipient","Weight","ServiceType","Cost","CargoType","SeatsAmount"],"properties":{"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, min. 0,1"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість — 300.00)"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу: Cargo, Documents, TiresWheels, Pallet"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"RedeliveryCalculate":{"type":"object","description":"Зворотна доставка","properties":{"CargoType":{"type":"string"},"Amount":{"type":"string"}}},"PackCount":{"type":"string","maxLength":36,"description":"Кількість паковання"},"PackRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) паковання"},"Amount":{"type":"string","maxLength":36,"description":"Ціле число (сума зворотної доставки/кількість одиниць)"},"CargoDetails":{"type":"array","description":"Масив із даними про деталі вантажу","xml":{"name":"CargoDetails","wrapped":true},"items":{"type":"object","xml":{"name":"item"},"properties":{"CargoDescription":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу відправлення"},"Amount":{"type":"string"}}}},"CargoDescription":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) типу відправлення"}}},"GetDocumentPriceResponse":{"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/GetDocumentPriceItem"}},"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"}}}}},"GetDocumentPriceItem":{"type":"object","title":"Результати розрахунку вартості","description":"Об'єкт з інформацією про вартість послуг","additionalProperties":false,"xml":{"name":"item"},"properties":{"AssessedCost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"Cost":{"type":"string","maxLength":36,"description":"Вартість"},"CostRedelivery":{"type":"string","maxLength":36,"description":"Вартість зворотної доставки"},"TZoneInfo":{"type":"object","description":"Інформація про тарифну зону доставки","properties":{"TzoneName":{"type":"string"},"TzoneID":{"type":"string"}}},"CostPack":{"type":"string","maxLength":36,"description":"Вартість пакування"}}}}}}
````
## Прогноз дати доставки вантажу (JSON)
> Метод \*\*getDocumentDeliveryDate\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Метод повертає орієнтовну дату доставки у відповіді.\
> \
> Послуги в експрес-накладній (ЕН), такі як зворотна доставка, щоденна доставка та інші, вказуються у запиті як обов’язкові елементи для розрахунку орієнтовної дати доставки.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Document Delivery Date)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з розрахунком дати доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"getDocumentDeliveryDateJson","summary":"Прогноз дати доставки вантажу (JSON)","description":"Метод **getDocumentDeliveryDate** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Метод повертає орієнтовну дату доставки у відповіді.\n\nПослуги в експрес-накладній (ЕН), такі як зворотна доставка, щоденна доставка та інші, вказуються у запиті як обов’язкові елементи для розрахунку орієнтовної дати доставки.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentDeliveryDateRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentDeliveryDateResponse"}}}}}}}},"components":{"schemas":{"GetDocumentDeliveryDateRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getDocumentDeliveryDate"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetDocumentDeliveryDateMethodProperties"}}},"GetDocumentDeliveryDateMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["ServiceType","CitySender","CityRecipient"],"properties":{"DateTime":{"type":"string","maxLength":36,"description":"Дата створення ЕН"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"}}},"GetDocumentDeliveryDateResponse":{"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/GetDocumentDeliveryDateItem"}},"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"}}}}},"GetDocumentDeliveryDateItem":{"type":"object","title":"Результат розрахунку дати доставки","description":"Об'єкт, що містить орієнтовну дату доставки","additionalProperties":false,"xml":{"name":"item"},"properties":{"DeliveryDate":{"type":"object","description":"Орієнтовна дата доставки","properties":{"date":{"type":"string"},"timezone_type":{"type":"integer"},"timezone":{"type":"string"}}}}}}}}
```
## Прогноз дати доставки вантажу (XML)
> Метод \*\*getDocumentDeliveryDate\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Метод повертає орієнтовну дату доставки у відповіді.\
> \
> Послуги в експрес-накладній (ЕН), такі як зворотна доставка, щоденна доставка та інші, вказуються у запиті як обов’язкові елементи для розрахунку орієнтовної дати доставки.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Document Delivery Date)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з розрахунком дати доставки"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"getDocumentDeliveryDateXml","summary":"Прогноз дати доставки вантажу (XML)","description":"Метод **getDocumentDeliveryDate** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Метод повертає орієнтовну дату доставки у відповіді.\n\nПослуги в експрес-накладній (ЕН), такі як зворотна доставка, щоденна доставка та інші, вказуються у запиті як обов’язкові елементи для розрахунку орієнтовної дати доставки.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetDocumentDeliveryDateRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetDocumentDeliveryDateResponse"}}}}}}}},"components":{"schemas":{"GetDocumentDeliveryDateRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getDocumentDeliveryDate"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetDocumentDeliveryDateMethodProperties"}}},"GetDocumentDeliveryDateMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["ServiceType","CitySender","CityRecipient"],"properties":{"DateTime":{"type":"string","maxLength":36,"description":"Дата створення ЕН"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"}}},"GetDocumentDeliveryDateResponse":{"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/GetDocumentDeliveryDateItem"}},"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"}}}}},"GetDocumentDeliveryDateItem":{"type":"object","title":"Результат розрахунку дати доставки","description":"Об'єкт, що містить орієнтовну дату доставки","additionalProperties":false,"xml":{"name":"item"},"properties":{"DeliveryDate":{"type":"object","description":"Орієнтовна дата доставки","properties":{"date":{"type":"string"},"timezone_type":{"type":"integer"},"timezone":{"type":"string"}}}}}}}}
```
## Редагувати експрес-накладну (JSON)
> Метод \*\*update\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє редагувати експрес-накладну (інтернет-документ).\
> \
> Обов'язково заповнювати всі параметри, але після оновлення замінюються лише ті, що були модифіковані.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Update)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"updateInternetDocumentJson","summary":"Редагувати експрес-накладну (JSON)","description":"Метод **update** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє редагувати експрес-накладну (інтернет-документ).\n\nОбов'язково заповнювати всі параметри, але після оновлення замінюються лише ті, що були модифіковані.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInternetDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInternetDocumentResponse"}}}}}}}},"components":{"schemas":{"UpdateInternetDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateInternetDocumentMethodProperties"}}},"UpdateInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","PayerType","PaymentMethod","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone"],"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) експрес-накладної"},"PayerType":{"type":"string","maxLength":36,"enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"enum":["Cash","NonCash"],"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр. Значення параметра не може перевищувати поточну дату більше ніж на 3 місяці. \nЯкщо в запиті передано більше значення, система автоматично обмежує його до максимально допустимого (дата створення + 3 місяці), виконує запит успішно та повертає у відповіді попередження про коригування (warnings)\n"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004). Обов'язково зазначати, якщо не передається параметр OptionsSeat"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"enum":["DoorsDoors","DoorsWarehouse","WarehouseWarehouse","WarehouseDoors"],"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість 300.00)"},"CitySender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси відправника"},"ContactSender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) контактної особи відправника"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"Recipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси отримувача / Ідентифікатор поштомата"},"ContactRecipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"}}},"UpdateInternetDocumentResponse":{"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/UpdateInternetDocumentItem"}},"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"}}}},"UpdateInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) експрес-накладної"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","maxLength":36,"description":"Тип експрес-накладної"}}}}}}
```
## Редагувати експрес-накладну (XML)
> Метод \*\*update\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє редагувати експрес-накладну (інтернет-документ).\
> \
> Обов'язково заповнювати всі параметри, але після оновлення замінюються лише ті, що були модифіковані.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Update)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"updateInternetDocumentXml","summary":"Редагувати експрес-накладну (XML)","description":"Метод **update** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє редагувати експрес-накладну (інтернет-документ).\n\nОбов'язково заповнювати всі параметри, але після оновлення замінюються лише ті, що були модифіковані.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateInternetDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateInternetDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"UpdateInternetDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateInternetDocumentXmlMethodProperties"}}},"UpdateInternetDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/UpdateInternetDocumentMethodProperties"}],"xml":{"name":"methodProperties"}},"UpdateInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","PayerType","PaymentMethod","CargoType","Weight","ServiceType","SeatsAmount","Description","Cost","CitySender","Sender","SenderAddress","ContactSender","SendersPhone","CityRecipient","Recipient","RecipientAddress","ContactRecipient","RecipientsPhone"],"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) експрес-накладної"},"PayerType":{"type":"string","maxLength":36,"enum":["Sender","Recipient","ThirdPerson"],"description":"Тип платника (Sender, Recipient, ThirdPerson)"},"PaymentMethod":{"type":"string","maxLength":36,"enum":["Cash","NonCash"],"description":"Форма розрахунку (Cash/NonCash)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата відправки у форматі дд.мм.рррр. Значення параметра не може перевищувати поточну дату більше ніж на 3 місяці. \nЯкщо в запиті передано більше значення, система автоматично обмежує його до максимально допустимого (дата створення + 3 місяці), виконує запит успішно та повертає у відповіді попередження про коригування (warnings)\n"},"CargoType":{"type":"string","maxLength":36,"description":"Тип вантажу"},"VolumeGeneral":{"type":"string","maxLength":36,"description":"Загальний об'єм, м.куб (min. 0.0004). Обов'язково зазначати, якщо не передається параметр OptionsSeat"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага, кг (min. 0,1)"},"ServiceType":{"type":"string","maxLength":36,"enum":["DoorsDoors","DoorsWarehouse","WarehouseWarehouse","WarehouseDoors"],"description":"Технологія доставки (DoorsDoors, DoorsWarehouse, WarehouseWarehouse, WarehouseDoors)"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"Description":{"type":"string","maxLength":36,"description":"Текстове поле, вводиться для додаткового опису відправлення"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість, ціле число (якщо не зазначити вартість, то АРІ автоматично проставить мінімальну оціночну вартість 300.00)"},"CitySender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста відправника"},"Sender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) відправника"},"SenderAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси відправника"},"ContactSender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) контактної особи відправника"},"SendersPhone":{"type":"string","maxLength":36,"description":"Телефон відправника у форматі: +380660000000, 380660000000, 0660000001"},"CityRecipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"Recipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси отримувача / Ідентифікатор поштомата"},"ContactRecipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) контактної особи"},"RecipientsPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача у форматі: +380660000000, 380660000000, 0660000001"}}},"UpdateInternetDocumentXmlResponse":{"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/UpdateInternetDocumentXmlItem"}},"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"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string"}}}},"UpdateInternetDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/UpdateInternetDocumentItem"}],"xml":{"name":"item"}},"UpdateInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) експрес-накладної"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Прогнозована дата доставки"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної"},"TypeDocument":{"type":"string","maxLength":36,"description":"Тип експрес-накладної"}}}}}}
```
## Отримати список експрес-накладних (JSON)
> Метод \*\*getDocumentList\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*) і повертає список усіх експрес-накладних (ЕН), доступних в особистому кабінеті, разом із їхніми ідентифікаторами (\`Ref\`) в API.\
> \
> \\
> \Опис параметрів пошуку та завантаження\
\
> \
> У параметрі \`DateTime\` можна зазначити дату, за яку потрібно отримати інформацію. Пошук здійснюється за датою створення інтернет-документа (ІД). Також доступне отримання даних за період — для цього використовуються параметри \`DateTimeFrom\` і \`DateTimeTo\`. Крім того, передбачено пошук за конкретним номером ЕН: у параметрі \`IntDocNumber\` необхідно вказати відповідний номер.\
> \
> Якщо не зазначити дату або номер ЕН, система автоматично поверне інформацію за всіма ЕН поточного дня.\
> \
> Також реалізовано можливість завантаження посторінкового списку або всього переліку накладних. Це налаштовується параметром \`GetFullList\`: значення «0» вмикає посторінкове завантаження, а значення «1» повертає повний список.\
> \ \
> \
> \\
> \Відображення ЕН зі зворотною доставкою\
\
> \
> Додатково впроваджено відображення всіх ЕН зі зворотною доставкою («Грошовий переказ» або «Каса форпост»). Для цього слід установити значення «1» для параметра \`RedeliveryMoney\`.\
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Get Document List)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"getDocumentListJson","summary":"Отримати список експрес-накладних (JSON)","description":"Метод **getDocumentList** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**) і повертає список усіх експрес-накладних (ЕН), доступних в особистому кабінеті, разом із їхніми ідентифікаторами (`Ref`) в API.\n\n\nОпис параметрів пошуку та завантаження
\n\nУ параметрі `DateTime` можна зазначити дату, за яку потрібно отримати інформацію. Пошук здійснюється за датою створення інтернет-документа (ІД). Також доступне отримання даних за період — для цього використовуються параметри `DateTimeFrom` і `DateTimeTo`. Крім того, передбачено пошук за конкретним номером ЕН: у параметрі `IntDocNumber` необхідно вказати відповідний номер.\n\nЯкщо не зазначити дату або номер ЕН, система автоматично поверне інформацію за всіма ЕН поточного дня.\n\nТакож реалізовано можливість завантаження посторінкового списку або всього переліку накладних. Це налаштовується параметром `GetFullList`: значення «0» вмикає посторінкове завантаження, а значення «1» повертає повний список.\n \n\n\nВідображення ЕН зі зворотною доставкою
\n\nДодатково впроваджено відображення всіх ЕН зі зворотною доставкою («Грошовий переказ» або «Каса форпост»). Для цього слід установити значення «1» для параметра `RedeliveryMoney`.\n \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDocumentListResponse"}}}}}}}},"components":{"schemas":{"GetDocumentListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getDocumentList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetDocumentListMethodProperties"}}},"GetDocumentListMethodProperties":{"type":"object","additionalProperties":false,"required":["DateTimeFrom","DateTimeTo","GetFullList"],"properties":{"DateTimeFrom":{"type":"string","maxLength":36,"description":"Дата від"},"DateTimeTo":{"type":"string","maxLength":36,"description":"Дата до"},"Page":{"type":"string","maxLength":36,"description":"Посторінкове відображення, до 100 записів на одній сторінці"},"GetFullList":{"type":"string","maxLength":36,"description":"Увімкнення/вимкнення посторінкового завантаження (0 — працює посторінкове завантаження, 1 — повний список)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення інтернет-документа (ІД)"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа (ІД)"}}},"GetDocumentListResponse":{"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/GetDocumentListItem"}},"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"}}}},"GetDocumentListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) ЕН"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення інтернет-документа (ІД)"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"RecipientDateTime":{"type":"string","maxLength":36,"description":"Дата отримання"},"EWDateCreated":{"type":"string","maxLength":36,"description":"Дата створення експрес-накладної (ЕН)"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа (ІД)"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"CitySender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"SenderAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси відправника"},"RecipientAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси отримувача"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"AfterpaymentOnGoodsCost":{"type":"string","maxLength":36,"description":"Зворотна доставка"},"PackingNumber":{"type":"string","maxLength":36,"description":"Номер пакування"},"RejectionReason":{"type":"string","maxLength":36,"description":"Опис причини нерозвозу"},"StateId":{"type":"string","maxLength":36,"description":"Код статусу ЕН (дорівнює статусу трекінга)"},"StateName":{"type":"string","maxLength":50,"description":"Опис статусу ЕН"},"ScanSheetNumber":{"type":"string","maxLength":36,"description":"Унікальний номер реєстру, до якого додано цю експрес-накладну (ЕН). Ідентифікує реєстр, що об’єднує кілька відправлень під одним номером"}}}}}}
```
## Отримати список експрес-накладних (XML)
> Метод \*\*getDocumentList\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*) і повертає список усіх експрес-накладних (ЕН), доступних в особистому кабінеті, разом із їхніми ідентифікаторами (\`Ref\`) в API.\
> \
> \\
> \Опис параметрів пошуку та завантаження\
\
> \
> У параметрі \`DateTime\` можна зазначити дату, за яку потрібно отримати інформацію. Пошук здійснюється за датою створення інтернет-документа (ІД). Також доступне отримання даних за період — для цього використовуються параметри \`DateTimeFrom\` і \`DateTimeTo\`. Крім того, передбачено пошук за конкретним номером ЕН: у параметрі \`IntDocNumber\` необхідно вказати відповідний номер.\
> \
> Якщо не зазначити дату або номер ЕН, система автоматично поверне інформацію за всіма ЕН поточного дня.\
> \
> Також реалізовано можливість завантаження посторінкового списку або всього переліку накладних. Це налаштовується параметром \`GetFullList\`: значення «0» вмикає посторінкове завантаження, а значення «1» повертає повний список.\
> \ \
> \
> \\
> \Відображення ЕН зі зворотною доставкою\
\
> \
> Додатково впроваджено відображення всіх ЕН зі зворотною доставкою («Грошовий переказ» або «Каса форпост»). Для цього слід установити значення «1» для параметра \`RedeliveryMoney\`.\
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Get Document List)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"getDocumentListXml","summary":"Отримати список експрес-накладних (XML)","description":"Метод **getDocumentList** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**) і повертає список усіх експрес-накладних (ЕН), доступних в особистому кабінеті, разом із їхніми ідентифікаторами (`Ref`) в API.\n\n\nОпис параметрів пошуку та завантаження
\n\nУ параметрі `DateTime` можна зазначити дату, за яку потрібно отримати інформацію. Пошук здійснюється за датою створення інтернет-документа (ІД). Також доступне отримання даних за період — для цього використовуються параметри `DateTimeFrom` і `DateTimeTo`. Крім того, передбачено пошук за конкретним номером ЕН: у параметрі `IntDocNumber` необхідно вказати відповідний номер.\n\nЯкщо не зазначити дату або номер ЕН, система автоматично поверне інформацію за всіма ЕН поточного дня.\n\nТакож реалізовано можливість завантаження посторінкового списку або всього переліку накладних. Це налаштовується параметром `GetFullList`: значення «0» вмикає посторінкове завантаження, а значення «1» повертає повний список.\n \n\n\nВідображення ЕН зі зворотною доставкою
\n\nДодатково впроваджено відображення всіх ЕН зі зворотною доставкою («Грошовий переказ» або «Каса форпост»). Для цього слід установити значення «1» для параметра `RedeliveryMoney`.\n \n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetDocumentListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetDocumentListXmlResponse"}}}}}}}},"components":{"schemas":{"GetDocumentListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getDocumentList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetDocumentListXmlMethodProperties"}}},"GetDocumentListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetDocumentListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetDocumentListMethodProperties":{"type":"object","additionalProperties":false,"required":["DateTimeFrom","DateTimeTo","GetFullList"],"properties":{"DateTimeFrom":{"type":"string","maxLength":36,"description":"Дата від"},"DateTimeTo":{"type":"string","maxLength":36,"description":"Дата до"},"Page":{"type":"string","maxLength":36,"description":"Посторінкове відображення, до 100 записів на одній сторінці"},"GetFullList":{"type":"string","maxLength":36,"description":"Увімкнення/вимкнення посторінкового завантаження (0 — працює посторінкове завантаження, 1 — повний список)"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення інтернет-документа (ІД)"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа (ІД)"}}},"GetDocumentListXmlResponse":{"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/GetDocumentListXmlItem"}},"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"}}}}},"GetDocumentListXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetDocumentListItem"}],"xml":{"name":"item"}},"GetDocumentListItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) ЕН"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення інтернет-документа (ІД)"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"RecipientDateTime":{"type":"string","maxLength":36,"description":"Дата отримання"},"EWDateCreated":{"type":"string","maxLength":36,"description":"Дата створення експрес-накладної (ЕН)"},"Weight":{"type":"string","maxLength":36,"description":"Фактична вага"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа (ІД)"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"CitySender":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"SenderAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси відправника"},"RecipientAddress":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (REF) адреси отримувача"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"AfterpaymentOnGoodsCost":{"type":"string","maxLength":36,"description":"Зворотна доставка"},"PackingNumber":{"type":"string","maxLength":36,"description":"Номер пакування"},"RejectionReason":{"type":"string","maxLength":36,"description":"Опис причини нерозвозу"},"StateId":{"type":"string","maxLength":36,"description":"Код статусу ЕН (дорівнює статусу трекінга)"},"StateName":{"type":"string","maxLength":50,"description":"Опис статусу ЕН"},"ScanSheetNumber":{"type":"string","maxLength":36,"description":"Унікальний номер реєстру, до якого додано цю експрес-накладну (ЕН). Ідентифікує реєстр, що об’єднує кілька відправлень під одним номером"}}}}}}
```
## Видалити експрес-накладну (JSON)
> Метод \*\*delete\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод використовується для видалення експрес-накладної (інтернет-документа).
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Delete)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"deleteInternetDocumentJson","summary":"Видалити експрес-накладну (JSON)","description":"Метод **delete** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод використовується для видалення експрес-накладної (інтернет-документа).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInternetDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInternetDocumentResponse"}}}}}}}},"components":{"schemas":{"DeleteInternetDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["delete"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteInternetDocumentMethodProperties"}}},"DeleteInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs"],"properties":{"DocumentRefs":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) документа"}}},"DeleteInternetDocumentResponse":{"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/DeleteInternetDocumentItem"}},"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"}}}},"DeleteInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (`REF`) видаленого документа"}}}}}}
```
## Видалити експрес-накладну (XML)
> Метод \*\*delete\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод використовується для видалення експрес-накладної (інтернет-документа).
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Delete)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"deleteInternetDocumentXml","summary":"Видалити експрес-накладну (XML)","description":"Метод **delete** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод використовується для видалення експрес-накладної (інтернет-документа).\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteInternetDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteInternetDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"DeleteInternetDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["delete"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteInternetDocumentXmlMethodProperties"}}},"DeleteInternetDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/DeleteInternetDocumentMethodProperties"}],"xml":{"name":"methodProperties"}},"DeleteInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs"],"properties":{"DocumentRefs":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) документа"}}},"DeleteInternetDocumentXmlResponse":{"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/DeleteInternetDocumentXmlItem"}},"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"}}}}},"DeleteInternetDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/DeleteInternetDocumentItem"}],"xml":{"name":"item"}},"DeleteInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"format":"uuid","description":"Ідентифікатор (`REF`) видаленого документа"}}}}}}
```
## Сформувати запит для отримання повного звіту за накладними (JSON)
> Метод \*\*generateReport\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод формує запит для отримання повного звіту за накладними.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Generate Report)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"generateReportInternetDocumentJson","summary":"Сформувати запит для отримання повного звіту за накладними (JSON)","description":"Метод **generateReport** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод формує запит для отримання повного звіту за накладними.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportInternetDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateReportInternetDocumentResponse"}}}}}}}},"components":{"schemas":{"GenerateReportInternetDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["generateReport"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GenerateReportInternetDocumentMethodProperties"}}},"GenerateReportInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs","Type","DateTime"],"properties":{"DocumentRefs":{"type":"array","description":"Список документів","items":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) документа"}},"Type":{"type":"string","maxLength":36,"enum":["xls","csv"],"description":"Форма документа для друку: xls або csv"},"DateTime":{"type":"string","maxLength":36,"description":"Дата доставки"}}},"GenerateReportInternetDocumentResponse":{"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/GenerateReportInternetDocumentItem"}},"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"}}}},"GenerateReportInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи"},"DateTime":{"type":"string","maxLength":36,"description":"Дата доставки"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"Weight":{"type":"string","maxLength":36,"description":"Вага"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"State":{"type":"string","maxLength":36,"description":"Штат"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси отримувача"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"PaymentMethod":{"type":"string","maxLength":36,"enum":["Cash","NonCash"],"description":"Форма розрахунку (Cash/NonCash)"},"AfterpaymentOnGoodsCost":{"type":"string","maxLength":36,"description":"Вартість зворотної доставки"},"PackingNumber":{"type":"string","maxLength":36,"description":"Номер паковання"}}}}}}
```
## Сформувати запит для отримання повного звіту за накладними (XML)
> Метод \*\*generateReport\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод формує запит для отримання повного звіту за накладними.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Generate Report)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"generateReportInternetDocumentXml","summary":"Сформувати запит для отримання повного звіту за накладними (XML)","description":"Метод **generateReport** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод формує запит для отримання повного звіту за накладними.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GenerateReportInternetDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GenerateReportInternetDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"GenerateReportInternetDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["generateReport"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GenerateReportInternetDocumentXmlMethodProperties"}}},"GenerateReportInternetDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GenerateReportInternetDocumentMethodProperties"}],"properties":{"DocumentRefs":{"type":"array","description":"Список документів","xml":{"wrapped":true},"items":{"type":"string","maxLength":36,"xml":{"name":"item"},"description":"Ідентифікатор (`REF`) документа"}}},"xml":{"name":"methodProperties"}},"GenerateReportInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["DocumentRefs","Type","DateTime"],"properties":{"DocumentRefs":{"type":"array","description":"Список документів","items":{"type":"string","maxLength":36,"description":"Ідентифікатор (`REF`) документа"}},"Type":{"type":"string","maxLength":36,"enum":["xls","csv"],"description":"Форма документа для друку: xls або csv"},"DateTime":{"type":"string","maxLength":36,"description":"Дата доставки"}}},"GenerateReportInternetDocumentXmlResponse":{"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/GenerateReportInternetDocumentXmlItem"}},"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"}}}}},"GenerateReportInternetDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/GenerateReportInternetDocumentItem"}],"xml":{"name":"item"}},"GenerateReportInternetDocumentItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи"},"DateTime":{"type":"string","maxLength":36,"description":"Дата доставки"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"Weight":{"type":"string","maxLength":36,"description":"Вага"},"SeatsAmount":{"type":"string","maxLength":36,"description":"Кількість місць відправлення, ціле число"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста відправника"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"State":{"type":"string","maxLength":36,"description":"Штат"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси отримувача"},"CostOnSite":{"type":"string","maxLength":36,"description":"Вартість доставки"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"PaymentMethod":{"type":"string","maxLength":36,"enum":["Cash","NonCash"],"description":"Форма розрахунку (Cash/NonCash)"},"AfterpaymentOnGoodsCost":{"type":"string","maxLength":36,"description":"Вартість зворотної доставки"},"PackingNumber":{"type":"string","maxLength":36,"description":"Номер паковання"}}}}}}
```
## Отримати список документів у заявці на виклик кур’єра (JSON)
> Метод \*\*getEWTemplateList\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє за номером заявки на виклик кур’єра отримати список інтернет-документів, які додано до цієї заявки.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Get EW Template List)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["InternetDocument"],"operationId":"getEWTemplateListInternetDocumentJson","summary":"Отримати список документів у заявці на виклик кур’єра (JSON)","description":"Метод **getEWTemplateList** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє за номером заявки на виклик кур’єра отримати список інтернет-документів, які додано до цієї заявки.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentResponse"}}}}}}}},"components":{"schemas":{"GetEWTemplateListInternetDocumentJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getEWTemplateList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentMethodProperties"}}},"GetEWTemplateListInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["Page","Limit","PickupNumber","State","IsPickupTable"],"properties":{"Page":{"type":"string","maxLength":36,"description":"Сторінка, працює разом з параметром Limit"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"},"PickupNumber":{"type":"string","maxLength":12,"description":"Номер заявки на виклик кур’єра"},"State":{"type":"string","maxLength":36,"description":"Ідентифікатор стану документа"},"IsPickupTable":{"type":"string","maxLength":36,"description":"Ознака, що відповідь міститиме список викликів кур'єра у вигляді табличних даних"}}},"GetEWTemplateListInternetDocumentResponse":{"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/GetEWTemplateListInternetDocumentItem"}},"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"}}}},"GetEWTemplateListInternetDocumentItem":{"type":"object","properties":{"PayerType":{"type":"string","maxLength":36,"description":"Вид платника"},"ScanSheetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор відомості сканування"},"BackwardDeliveryCargoType":{"type":"string","maxLength":36,"description":"Вид зворотної доставки"},"EWNumber":{"type":"string","maxLength":18,"nullable":true,"description":"Номер експрес-накладної"},"Number":{"type":"number","description":"Номер експрес-накладної"},"RecipientCityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"OriginalGeoData":{"type":"array","description":"Дані геопозначки отримувача","items":{"$ref":"#/components/schemas/OriginalGeoDataItem"}},"RecipientContactPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"ElevatorRecipient":{"type":"string","maxLength":36,"description":"Наявність ліфта в отримувача"},"StateId":{"type":"string","maxLength":36,"description":"Ідентифікатор стану інтернет-документа"},"DeliveryPharma":{"type":"string","maxLength":36,"description":"Ознака доставки фармацевтичних товарів"},"TimeIntervalString":{"type":"string","maxLength":36,"description":"Строкове значення часового інтервалу"},"Note":{"type":"string","maxLength":100,"nullable":true,"description":"Примітка"},"RecipientDateTime":{"type":"string","maxLength":36,"nullable":true,"description":"Дата отримання"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма оплати"},"RecipientPost":{"type":"string","maxLength":36,"nullable":true,"description":"Відділення отримувача"},"ChangedDataEW":{"type":"string","maxLength":36,"description":"Ознака зміни даних в експрес-накладній (ЕН)"},"ScanSheetNumber":{"type":"string","maxLength":36,"description":"Номер відомості сканування"},"IntDocNumber":{"type":"string","maxLength":20,"description":"Номер інтернет-документа"},"SaturdayDelivery":{"type":"string","maxLength":36,"nullable":true,"description":"Ознака суботньої доставки"},"BackwardDeliverySum":{"type":"number","description":"Сума зворотної доставки"},"RecipientStreetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор вулиці отримувача"},"SecurePayment":{"type":"string","maxLength":36,"description":"Ознака «Безпечний платіж»"},"ThirdPerson":{"type":"string","maxLength":36,"nullable":true,"description":"Третя особа"},"EWDateCreated":{"type":"string","maxLength":36,"description":"Дата та час створення експрес-накладної (ЕН)"},"CitySenderDescription":{"type":"string","maxLength":36,"description":"Місто відправника"},"bCardPaymentPayed":{"type":"string","maxLength":36,"description":"Використана бонусна картка в оплаті"},"SenderDescription":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"ScanSheetPrinted":{"type":"string","maxLength":36,"description":"Ознака друку відомості сканування"},"RecipientContactPerson":{"type":"string","maxLength":36,"description":"Контактна особа отримувача"},"RecipientWarehouseRef":{"type":"string","maxLength":36,"description":"Ідентифікатор будинку отримувача"},"ExpressWaybill":{"type":"string","maxLength":36,"nullable":true,"description":"Експрес-накладна"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"ScheduledDeliveryDate":{"type":"string","maxLength":36,"nullable":true,"description":"Запланована дата та час доставки"},"RedBoxBarcode":{"type":"string","maxLength":9,"description":"Штрих-код RedBox"},"Forwarding":{"type":"string","maxLength":3,"nullable":true,"description":"Експедирування"},"RecipientsPhone":{"type":"string","maxLength":40,"description":"Контактний номер телефону отримувача"},"AfterpaymentOnGoodsCost":{"type":"number","description":"Сума післяплати за товар"},"RecipientDescription":{"type":"string","maxLength":36,"description":"Тип контактної особи-отримувача"},"Cost":{"type":"number","description":"Вартість вантажу"},"CityRecipientDescription":{"type":"string","maxLength":36,"description":"Місто отримувача"},"StateName":{"type":"string","maxLength":100,"description":"Опис статусу інтернет-документа"},"bCardPaymentCancelled":{"type":"string","maxLength":36,"description":"Скакасовано використання бонусної картки в оплаті"},"CarCall":{"type":"string","maxLength":36,"nullable":true,"description":"Виклик машини"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача"},"DeliveryFrom":{"type":"string","maxLength":36,"description":"Тип місця відправки (Branch, DeliveryService, DropOff, Postomat)"},"InfoRegClientBarcodes":{"type":"string","maxLength":36,"description":"Перелік клієнтських штрих-кодів"},"WarehouseIllusha":{"type":"string","maxLength":36,"description":"Склад активний"},"AgeIdentification":{"type":"string","maxLength":36,"description":"Ідентифікація віку — перевірка віку одержувача під час отримання замовлення, якщо товар має вікові обмеження (алкоголь, тютюн, ліки). Виконується через документи (паспорт, ID-картку) або кур'єра, який перевіряє вік під час видачі"},"IsTakeAttorney":{"type":"string","maxLength":36,"description":"Наявність довіреності"},"Promocode":{"type":"string","maxLength":11,"description":"Промокод на знижку"},"CargoType":{"type":"string","maxLength":36,"description":"Вид вантажу"},"LoyaltyCard":{"type":"string","maxLength":36,"description":"Ідентифікатор картки лояльності"},"MarketplacePartnerDescription":{"type":"string","maxLength":36,"description":"Місце створення накладної"},"NumberOfFloorsLifting":{"type":"number","description":"Кількість поверхів підйому"},"DeliveryDateFrom":{"type":"string","maxLength":36,"nullable":true,"description":"Дата та час розвезення"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Очікувана дата та час доставки"},"ServiceType":{"type":"string","maxLength":36,"description":"Вид послуги"},"DeliveryByHand":{"type":"string","maxLength":36,"description":"Ознака доставки в руки"},"DeliveryTo":{"type":"string","maxLength":36,"description":"Тип місця доставки (Branch, DeliveryService, DropOff, Postomat)"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"StatePayId":{"type":"string","maxLength":36,"description":"Ідентифікатор статусу оплати"},"PackingNumber":{"type":"string","maxLength":20,"description":"Номер паковання"},"RecipientAddressDescription":{"type":"string","maxLength":36,"description":"Назва відділення отримувача"},"DateTime":{"type":"string","maxLength":36,"description":"Дата"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"RegionCode":{"type":"string","maxLength":36,"description":"Код регіону"},"SettlementSender":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту відправника"},"ForwardingCount":{"type":"string","maxLength":36,"description":"Кількість перенаправлень"},"BackwardDeliveryMoney":{"type":"number","description":"Сума зворотної доставки в грошах"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-відправника"},"Vip":{"type":"string","maxLength":36,"nullable":true,"description":"Ознака VIP"},"LightReturn":{"type":"string","maxLength":36,"description":"Ознака наявності легкого повернення"},"Description":{"type":"string","maxLength":125,"description":"Опис"},"MarketplacePartnerToken":{"type":"string","maxLength":36,"description":"Ідентифікатор місця створення"},"SameDayDelivery":{"type":"string","maxLength":36,"description":"Ознака доставки замовлення в межах одного дня"},"StatePayName":{"type":"string","maxLength":36,"description":"Опис платника"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"ExpressPallet":{"type":"string","maxLength":36,"description":"Наявність палетизування"},"CardPaymentRef":{"type":"string","maxLength":36,"nullable":true,"description":"Ідентифікатор картки платника"},"StatementOfAcceptanceTransferCargoID":{"type":"string","maxLength":36,"nullable":true,"description":"Ідентифікатор відомості прийому-передачі вантажу за інтернет-документом"},"CargoReturnRefusal":{"type":"string","maxLength":36,"description":"Тип повернення вантажу"},"RecipientCounterpartyType":{"type":"string","maxLength":36,"description":"Тип отримувача (PrivatePerson, Organization)"},"SenderContactPerson":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"RejectionReason":{"type":"string","maxLength":36,"nullable":true,"description":"Причина перевідкриття"},"DateLastUpdatedStatus":{"type":"string","maxLength":36,"description":"Дата та час останньої зміни даних"},"OwnershipForm":{"type":"string","maxLength":36,"description":"Форма власності"},"LastModificationDate":{"type":"string","maxLength":36,"nullable":true,"description":"Остання дата та час модифікації"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"BackwardDeliveryData":{"type":"array","description":"Опис параметрів зворотної доставки","items":{"$ref":"#/components/schemas/BackwardDeliveryDataItem"}},"SettlementRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту отримувача"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"TimeInterval":{"type":"string","maxLength":36,"description":"Значення часового інтервалу"},"MoneyTransferPayerType":{"type":"string","maxLength":36,"description":"Тип платника зворотної доставки"},"WarehouseSender":{"type":"string","maxLength":36,"nullable":true,"description":"Склад відправника"},"Weight":{"type":"number","description":"Вага"},"AviaDelivery":{"type":"string","maxLength":36,"description":"Ознака авіадоставки"},"DateLastPrint":{"type":"string","maxLength":36,"nullable":true,"description":"Остання дата та час друку"},"ReceiptDate":{"type":"string","maxLength":36,"nullable":true,"description":"Дата та час отримання"},"OnlineCreditStatus":{"type":"string","maxLength":36,"nullable":true,"description":"Статус онлайн-кредиту"},"DeletionMark":{"type":"string","maxLength":36,"description":"Ознака статусу «Видалено»"},"SettlmentAddressData":{"type":"array","description":"Дані місця доставки","items":{"$ref":"#/components/schemas/SettlmentAddressDataItem"}},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"TimeIntervalRef":{"type":"string","maxLength":36,"description":"Ідентифікатор часового інтервалу"},"WarehouseRecipient":{"type":"string","maxLength":36,"nullable":true,"description":"Склад отримувача"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-отримувача"},"AdditionalInformation":{"type":"string","maxLength":100,"description":"Додаткова інформація"},"EDRPOU":{"type":"string","maxLength":10,"description":"Код ЄДРПОУ"},"FillingWarranty":{"type":"string","maxLength":36,"description":"Гарантія, що товар або паковання заповнені відповідно до вимог"},"AfterpaymentSum":{"type":"number","description":"Сума післяплати"},"Posted":{"type":"string","maxLength":36,"nullable":true,"description":"Ознака проводки документа"},"SenderAddressDescription":{"type":"string","maxLength":36,"description":"Відділення відправника"},"Redelivery":{"type":"string","maxLength":36,"nullable":true,"description":"Зворотна доставка"},"SeatsAmount":{"type":"number","description":"Кількість місць"},"CreateTime":{"type":"string","maxLength":36,"description":"Дата та час створення"},"CostOnSite":{"type":"number","description":"Сума на сайті"},"LightReturnNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної послуги легкого повернення"},"Printed":{"type":"string","maxLength":36,"description":"Ознака «Надруковано»"},"Route":{"type":"string","maxLength":36,"nullable":true,"description":"Маршрут"},"CardMaskedNumber":{"type":"string","maxLength":36,"description":"Замаскований номер картки"},"System":{"type":"string","maxLength":36,"description":"Система створення накладної"},"SendersPhone":{"type":"string","maxLength":40,"description":"Контактний номер телефону відправника"},"RecipientFullName":{"type":"string","maxLength":80,"nullable":true,"description":"Контактна особа отримувача"},"SaturdayDeliveryString":{"type":"string","maxLength":20,"nullable":true,"description":"Суботня доставка (опис)"}}},"OriginalGeoDataItem":{"type":"object","properties":{"RecipientAddressName":{"type":"string","nullable":true},"RecipientArea":{"type":"string","nullable":true},"RecipientAreaRegions":{"type":"string","nullable":true},"RecipientCityName":{"type":"string","nullable":true},"RecipientFlat":{"type":"string","nullable":true},"RecipientHouse":{"type":"string","nullable":true}}},"BackwardDeliveryDataItem":{"type":"object","properties":{"CargoType":{"type":"string"},"CargoTypeRef":{"type":"string"},"RedeliveryString":{"type":"string"},"Type":{"type":"string"},"TypeRef":{"type":"string"},"PayerType":{"type":"string"},"PayerTypeRef":{"type":"string"},"CustomBackwardDeliveryParameter":{"type":"string"},"CustomBackwardDeliveryParameterRef":{"type":"string"}}},"SettlmentAddressDataItem":{"type":"object","properties":{"SenderWarehouseRef":{"type":"string"},"RecipientWarehouseRef":{"type":"string"},"SenderWarehouseNumber":{"type":"string"},"SenderWarehouseIndex":{"type":"string"},"SenderAddressRef":{"type":"string"},"RecipientWarehouseNumber":{"type":"string"},"RecipientWarehouseIndex":{"type":"string"},"RecipientAddressRef":{"type":"string"},"SenderSettlementRef":{"type":"string"},"RecipientSettlementRef":{"type":"string"},"SenderSettlementDescription":{"type":"string"},"RecipientSettlementDescription":{"type":"string"},"SenderSettlementStreetDescription":{"type":"string"},"RecipientSettlementStreetDescription":{"type":"string"},"SenderSettlementStreetRef":{"type":"string"},"RecipientSettlementStreetRef":{"type":"string"},"SenderHouseNumber":{"type":"string"},"RecipientHouseNumber":{"type":"string"},"SenderFlatNumber":{"type":"string"},"RecipientFlatNumber":{"type":"string"},"SenderAddressNote":{"type":"string"},"RecipientAddressNote":{"type":"string"}}}}}}
```
## Отримати список документів у заявці на виклик кур’єра (XML)
> Метод \*\*getEWTemplateList\*\* працює в моделі \*\*InternetDocument\*\* (або \*\*InternetDocumentGeneral\*\*). Цей метод дозволяє за номером заявки на виклик кур’єра отримати список інтернет-документів, які додано до цієї заявки.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Internet Document (Get EW Template List)","version":"2.0.0"},"tags":[{"name":"InternetDocument","description":"Операції, пов'язані з експрес-накладними"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["InternetDocument"],"operationId":"getEWTemplateListInternetDocumentXml","summary":"Отримати список документів у заявці на виклик кур’єра (XML)","description":"Метод **getEWTemplateList** працює в моделі **InternetDocument** (або **InternetDocumentGeneral**). Цей метод дозволяє за номером заявки на виклик кур’єра отримати список інтернет-документів, які додано до цієї заявки.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentXmlResponse"}}}}}}}},"components":{"schemas":{"GetEWTemplateListInternetDocumentXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["InternetDocument","InternetDocumentGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getEWTemplateList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentXmlMethodProperties"}}},"GetEWTemplateListInternetDocumentXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentMethodProperties"}],"xml":{"name":"methodProperties"}},"GetEWTemplateListInternetDocumentMethodProperties":{"type":"object","additionalProperties":false,"required":["Page","Limit","PickupNumber","State","IsPickupTable"],"properties":{"Page":{"type":"string","maxLength":36,"description":"Сторінка, працює разом з параметром Limit"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці. Працює разом із параметром Page"},"PickupNumber":{"type":"string","maxLength":12,"description":"Номер заявки на виклик кур’єра"},"State":{"type":"string","maxLength":36,"description":"Ідентифікатор стану документа"},"IsPickupTable":{"type":"string","maxLength":36,"description":"Ознака, що відповідь міститиме список викликів кур'єра у вигляді табличних даних"}}},"GetEWTemplateListInternetDocumentXmlResponse":{"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/GetEWTemplateListInternetDocumentXmlItem"}},"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"}}}}},"GetEWTemplateListInternetDocumentXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetEWTemplateListInternetDocumentItem"}],"xml":{"name":"item"}},"GetEWTemplateListInternetDocumentItem":{"type":"object","properties":{"PayerType":{"type":"string","maxLength":36,"description":"Вид платника"},"ScanSheetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор відомості сканування"},"BackwardDeliveryCargoType":{"type":"string","maxLength":36,"description":"Вид зворотної доставки"},"EWNumber":{"type":"string","maxLength":18,"nullable":true,"description":"Номер експрес-накладної"},"Number":{"type":"number","description":"Номер експрес-накладної"},"RecipientCityRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"OriginalGeoData":{"type":"array","description":"Дані геопозначки отримувача","items":{"$ref":"#/components/schemas/OriginalGeoDataItem"}},"RecipientContactPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"ElevatorRecipient":{"type":"string","maxLength":36,"description":"Наявність ліфта в отримувача"},"StateId":{"type":"string","maxLength":36,"description":"Ідентифікатор стану інтернет-документа"},"DeliveryPharma":{"type":"string","maxLength":36,"description":"Ознака доставки фармацевтичних товарів"},"TimeIntervalString":{"type":"string","maxLength":36,"description":"Строкове значення часового інтервалу"},"Note":{"type":"string","maxLength":100,"nullable":true,"description":"Примітка"},"RecipientDateTime":{"type":"string","maxLength":36,"nullable":true,"description":"Дата отримання"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма оплати"},"RecipientPost":{"type":"string","maxLength":36,"nullable":true,"description":"Відділення отримувача"},"ChangedDataEW":{"type":"string","maxLength":36,"description":"Ознака зміни даних в експрес-накладній (ЕН)"},"ScanSheetNumber":{"type":"string","maxLength":36,"description":"Номер відомості сканування"},"IntDocNumber":{"type":"string","maxLength":20,"description":"Номер інтернет-документа"},"SaturdayDelivery":{"type":"string","maxLength":36,"nullable":true,"description":"Ознака суботньої доставки"},"BackwardDeliverySum":{"type":"number","description":"Сума зворотної доставки"},"RecipientStreetRef":{"type":"string","maxLength":36,"description":"Ідентифікатор вулиці отримувача"},"SecurePayment":{"type":"string","maxLength":36,"description":"Ознака «Безпечний платіж»"},"ThirdPerson":{"type":"string","maxLength":36,"nullable":true,"description":"Третя особа"},"EWDateCreated":{"type":"string","maxLength":36,"description":"Дата та час створення експрес-накладної (ЕН)"},"CitySenderDescription":{"type":"string","maxLength":36,"description":"Місто відправника"},"bCardPaymentPayed":{"type":"string","maxLength":36,"description":"Використана бонусна картка в оплаті"},"SenderDescription":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"ScanSheetPrinted":{"type":"string","maxLength":36,"description":"Ознака друку відомості сканування"},"RecipientContactPerson":{"type":"string","maxLength":36,"description":"Контактна особа отримувача"},"RecipientWarehouseRef":{"type":"string","maxLength":36,"description":"Ідентифікатор будинку отримувача"},"ExpressWaybill":{"type":"string","maxLength":36,"nullable":true,"description":"Експрес-накладна"},"SenderAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси відправника"},"ScheduledDeliveryDate":{"type":"string","maxLength":36,"nullable":true,"description":"Запланована дата та час доставки"},"RedBoxBarcode":{"type":"string","maxLength":9,"description":"Штрих-код RedBox"},"Forwarding":{"type":"string","maxLength":3,"nullable":true,"description":"Експедирування"},"RecipientsPhone":{"type":"string","maxLength":40,"description":"Контактний номер телефону отримувача"},"AfterpaymentOnGoodsCost":{"type":"number","description":"Сума післяплати за товар"},"RecipientDescription":{"type":"string","maxLength":36,"description":"Тип контактної особи-отримувача"},"Cost":{"type":"number","description":"Вартість вантажу"},"CityRecipientDescription":{"type":"string","maxLength":36,"description":"Місто отримувача"},"StateName":{"type":"string","maxLength":100,"description":"Опис статусу інтернет-документа"},"bCardPaymentCancelled":{"type":"string","maxLength":36,"description":"Скакасовано використання бонусної картки в оплаті"},"CarCall":{"type":"string","maxLength":36,"nullable":true,"description":"Виклик машини"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Ідентифікатор адреси отримувача"},"DeliveryFrom":{"type":"string","maxLength":36,"description":"Тип місця відправки (Branch, DeliveryService, DropOff, Postomat)"},"InfoRegClientBarcodes":{"type":"string","maxLength":36,"description":"Перелік клієнтських штрих-кодів"},"WarehouseIllusha":{"type":"string","maxLength":36,"description":"Склад активний"},"AgeIdentification":{"type":"string","maxLength":36,"description":"Ідентифікація віку — перевірка віку одержувача під час отримання замовлення, якщо товар має вікові обмеження (алкоголь, тютюн, ліки). Виконується через документи (паспорт, ID-картку) або кур'єра, який перевіряє вік під час видачі"},"IsTakeAttorney":{"type":"string","maxLength":36,"description":"Наявність довіреності"},"Promocode":{"type":"string","maxLength":11,"description":"Промокод на знижку"},"CargoType":{"type":"string","maxLength":36,"description":"Вид вантажу"},"LoyaltyCard":{"type":"string","maxLength":36,"description":"Ідентифікатор картки лояльності"},"MarketplacePartnerDescription":{"type":"string","maxLength":36,"description":"Місце створення накладної"},"NumberOfFloorsLifting":{"type":"number","description":"Кількість поверхів підйому"},"DeliveryDateFrom":{"type":"string","maxLength":36,"nullable":true,"description":"Дата та час розвезення"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Очікувана дата та час доставки"},"ServiceType":{"type":"string","maxLength":36,"description":"Вид послуги"},"DeliveryByHand":{"type":"string","maxLength":36,"description":"Ознака доставки в руки"},"DeliveryTo":{"type":"string","maxLength":36,"description":"Тип місця доставки (Branch, DeliveryService, DropOff, Postomat)"},"Sender":{"type":"string","maxLength":36,"description":"Ідентифікатор відправника"},"StatePayId":{"type":"string","maxLength":36,"description":"Ідентифікатор статусу оплати"},"PackingNumber":{"type":"string","maxLength":20,"description":"Номер паковання"},"RecipientAddressDescription":{"type":"string","maxLength":36,"description":"Назва відділення отримувача"},"DateTime":{"type":"string","maxLength":36,"description":"Дата"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"RegionCode":{"type":"string","maxLength":36,"description":"Код регіону"},"SettlementSender":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту відправника"},"ForwardingCount":{"type":"string","maxLength":36,"description":"Кількість перенаправлень"},"BackwardDeliveryMoney":{"type":"number","description":"Сума зворотної доставки в грошах"},"ContactSender":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-відправника"},"Vip":{"type":"string","maxLength":36,"nullable":true,"description":"Ознака VIP"},"LightReturn":{"type":"string","maxLength":36,"description":"Ознака наявності легкого повернення"},"Description":{"type":"string","maxLength":125,"description":"Опис"},"MarketplacePartnerToken":{"type":"string","maxLength":36,"description":"Ідентифікатор місця створення"},"SameDayDelivery":{"type":"string","maxLength":36,"description":"Ознака доставки замовлення в межах одного дня"},"StatePayName":{"type":"string","maxLength":36,"description":"Опис платника"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"ExpressPallet":{"type":"string","maxLength":36,"description":"Наявність палетизування"},"CardPaymentRef":{"type":"string","maxLength":36,"nullable":true,"description":"Ідентифікатор картки платника"},"StatementOfAcceptanceTransferCargoID":{"type":"string","maxLength":36,"nullable":true,"description":"Ідентифікатор відомості прийому-передачі вантажу за інтернет-документом"},"CargoReturnRefusal":{"type":"string","maxLength":36,"description":"Тип повернення вантажу"},"RecipientCounterpartyType":{"type":"string","maxLength":36,"description":"Тип отримувача (PrivatePerson, Organization)"},"SenderContactPerson":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"RejectionReason":{"type":"string","maxLength":36,"nullable":true,"description":"Причина перевідкриття"},"DateLastUpdatedStatus":{"type":"string","maxLength":36,"description":"Дата та час останньої зміни даних"},"OwnershipForm":{"type":"string","maxLength":36,"description":"Форма власності"},"LastModificationDate":{"type":"string","maxLength":36,"nullable":true,"description":"Остання дата та час модифікації"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор отримувача"},"BackwardDeliveryData":{"type":"array","description":"Опис параметрів зворотної доставки","items":{"$ref":"#/components/schemas/BackwardDeliveryDataItem"}},"SettlementRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту отримувача"},"CitySender":{"type":"string","maxLength":36,"description":"Ідентифікатор міста відправника"},"TimeInterval":{"type":"string","maxLength":36,"description":"Значення часового інтервалу"},"MoneyTransferPayerType":{"type":"string","maxLength":36,"description":"Тип платника зворотної доставки"},"WarehouseSender":{"type":"string","maxLength":36,"nullable":true,"description":"Склад відправника"},"Weight":{"type":"number","description":"Вага"},"AviaDelivery":{"type":"string","maxLength":36,"description":"Ознака авіадоставки"},"DateLastPrint":{"type":"string","maxLength":36,"nullable":true,"description":"Остання дата та час друку"},"ReceiptDate":{"type":"string","maxLength":36,"nullable":true,"description":"Дата та час отримання"},"OnlineCreditStatus":{"type":"string","maxLength":36,"nullable":true,"description":"Статус онлайн-кредиту"},"DeletionMark":{"type":"string","maxLength":36,"description":"Ознака статусу «Видалено»"},"SettlmentAddressData":{"type":"array","description":"Дані місця доставки","items":{"$ref":"#/components/schemas/SettlmentAddressDataItem"}},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор міста отримувача"},"TimeIntervalRef":{"type":"string","maxLength":36,"description":"Ідентифікатор часового інтервалу"},"WarehouseRecipient":{"type":"string","maxLength":36,"nullable":true,"description":"Склад отримувача"},"ContactRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор контактної особи-отримувача"},"AdditionalInformation":{"type":"string","maxLength":100,"description":"Додаткова інформація"},"EDRPOU":{"type":"string","maxLength":10,"description":"Код ЄДРПОУ"},"FillingWarranty":{"type":"string","maxLength":36,"description":"Гарантія, що товар або паковання заповнені відповідно до вимог"},"AfterpaymentSum":{"type":"number","description":"Сума післяплати"},"Posted":{"type":"string","maxLength":36,"nullable":true,"description":"Ознака проводки документа"},"SenderAddressDescription":{"type":"string","maxLength":36,"description":"Відділення відправника"},"Redelivery":{"type":"string","maxLength":36,"nullable":true,"description":"Зворотна доставка"},"SeatsAmount":{"type":"number","description":"Кількість місць"},"CreateTime":{"type":"string","maxLength":36,"description":"Дата та час створення"},"CostOnSite":{"type":"number","description":"Сума на сайті"},"LightReturnNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної послуги легкого повернення"},"Printed":{"type":"string","maxLength":36,"description":"Ознака «Надруковано»"},"Route":{"type":"string","maxLength":36,"nullable":true,"description":"Маршрут"},"CardMaskedNumber":{"type":"string","maxLength":36,"description":"Замаскований номер картки"},"System":{"type":"string","maxLength":36,"description":"Система створення накладної"},"SendersPhone":{"type":"string","maxLength":40,"description":"Контактний номер телефону відправника"},"RecipientFullName":{"type":"string","maxLength":80,"nullable":true,"description":"Контактна особа отримувача"},"SaturdayDeliveryString":{"type":"string","maxLength":20,"nullable":true,"description":"Суботня доставка (опис)"}}},"OriginalGeoDataItem":{"type":"object","properties":{"RecipientAddressName":{"type":"string","nullable":true},"RecipientArea":{"type":"string","nullable":true},"RecipientAreaRegions":{"type":"string","nullable":true},"RecipientCityName":{"type":"string","nullable":true},"RecipientFlat":{"type":"string","nullable":true},"RecipientHouse":{"type":"string","nullable":true}}},"BackwardDeliveryDataItem":{"type":"object","properties":{"CargoType":{"type":"string"},"CargoTypeRef":{"type":"string"},"RedeliveryString":{"type":"string"},"Type":{"type":"string"},"TypeRef":{"type":"string"},"PayerType":{"type":"string"},"PayerTypeRef":{"type":"string"},"CustomBackwardDeliveryParameter":{"type":"string"},"CustomBackwardDeliveryParameterRef":{"type":"string"}}},"SettlmentAddressDataItem":{"type":"object","properties":{"SenderWarehouseRef":{"type":"string"},"RecipientWarehouseRef":{"type":"string"},"SenderWarehouseNumber":{"type":"string"},"SenderWarehouseIndex":{"type":"string"},"SenderAddressRef":{"type":"string"},"RecipientWarehouseNumber":{"type":"string"},"RecipientWarehouseIndex":{"type":"string"},"RecipientAddressRef":{"type":"string"},"SenderSettlementRef":{"type":"string"},"RecipientSettlementRef":{"type":"string"},"SenderSettlementDescription":{"type":"string"},"RecipientSettlementDescription":{"type":"string"},"SenderSettlementStreetDescription":{"type":"string"},"RecipientSettlementStreetDescription":{"type":"string"},"SenderSettlementStreetRef":{"type":"string"},"RecipientSettlementStreetRef":{"type":"string"},"SenderHouseNumber":{"type":"string"},"RecipientHouseNumber":{"type":"string"},"SenderFlatNumber":{"type":"string"},"RecipientFlatNumber":{"type":"string"},"SenderAddressNote":{"type":"string"},"RecipientAddressNote":{"type":"string"}}}}}}
```
---
# 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/ekspres-nakladna.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.