> 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/dodatkovi-poslugi.md).

# Додаткові послуги

:link:[*Початок роботи з API*](https://api-portal.novapost.com/api-docs-ua)

### Створити переадресацію

## Перевірити можливість створення переадресації (JSON)

> Метод \*\*checkPossibilityForRedirecting\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> Дозволяє перевірити можливість створення заявки на переадресацію відправлення.\
> Метод доступний лише клієнтам-відправникам.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Redirecting","description":"Операції, пов'язані з переадресацією відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Redirecting"],"operationId":"checkPossibilityForRedirectingJson","summary":"Перевірити можливість створення переадресації (JSON)","description":"Метод **checkPossibilityForRedirecting** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\nДозволяє перевірити можливість створення заявки на переадресацію відправлення.\nМетод доступний лише клієнтам-відправникам.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForRedirectingJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForRedirectingResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityForRedirectingJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["checkPossibilityForRedirecting"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityForRedirectingMethodProperties"}}},"CheckPossibilityForRedirectingMethodProperties":{"type":"object","additionalProperties":false,"required":["Number"],"properties":{"Number":{"type":"string","description":"Номер документа / експрес-накладної"}}},"CheckPossibilityForRedirectingResponse":{"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/CheckRedirectingPossibilityItem"}},"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"}}}},"CheckRedirectingPossibilityItem":{"type":"object","properties":{"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) документа"},"Number":{"type":"string","description":"Номер документа"},"PayerType":{"type":"string","description":"Тип платника"},"PaymentMethod":{"type":"string","description":"Форма розрахунку"},"WarehouseRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відділення"},"WarehouseDescription":{"type":"string","description":"Опис відділення"},"AddressDescription":{"type":"string","description":"Текстовий опис адреси, якщо переадресування виконується на адресу"},"StreetDescription":{"type":"string","description":"Текстовий опис вулиці, якщо переадресування виконується на адресу"},"BuildingNumber":{"type":"string","description":"Номер будинку для переадресування на адресу"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"CityRecipientDescription":{"type":"string","description":"Назва міста отримувача"},"SettlementRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) населеного пункту отримувача"},"SettlementRecipientDescription":{"type":"string","description":"Назва населеного пункту отримувача"},"SettlementType":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) типу населеного пункту отримувача"},"CounterpartyRecipientRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) контрагента отримувача"},"CounterpartyRecipientDescription":{"type":"string","description":"Назва інтернет-контрагента отримувача"},"RecipientName":{"type":"string","description":"ПІБ контактної особи отримувача"},"PhoneSender":{"type":"string","description":"Телефон відправника"},"PhoneRecipient":{"type":"string","description":"Телефон отримувача"},"DocumentWeight":{"type":"string","description":"Загальна вага документа. API повертає значення як рядок."}}}}}}
```

## Перевірити можливість створення переадресації (XML)

> Метод \*\*checkPossibilityForRedirecting\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> Дозволяє перевірити можливість створення заявки на переадресацію відправлення.\
> Метод доступний лише клієнтам-відправникам.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Redirecting","description":"Операції, пов'язані з переадресацією відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Redirecting"],"operationId":"checkPossibilityForRedirectingXml","summary":"Перевірити можливість створення переадресації (XML)","description":"Метод **checkPossibilityForRedirecting** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\nДозволяє перевірити можливість створення заявки на переадресацію відправлення.\nМетод доступний лише клієнтам-відправникам.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForRedirectingXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForRedirectingXmlResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityForRedirectingXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["checkPossibilityForRedirecting"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityForRedirectingXmlMethodProperties"}}},"CheckPossibilityForRedirectingXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["Number"],"properties":{"Number":{"type":"string","description":"Номер документа / експрес-накладної"}}},"CheckPossibilityForRedirectingXmlResponse":{"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/CheckRedirectingPossibilityXmlItem"}},"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"}}}}},"CheckRedirectingPossibilityXmlItem":{"allOf":[{"$ref":"#/components/schemas/CheckRedirectingPossibilityItem"}],"xml":{"name":"item"}},"CheckRedirectingPossibilityItem":{"type":"object","properties":{"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) документа"},"Number":{"type":"string","description":"Номер документа"},"PayerType":{"type":"string","description":"Тип платника"},"PaymentMethod":{"type":"string","description":"Форма розрахунку"},"WarehouseRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відділення"},"WarehouseDescription":{"type":"string","description":"Опис відділення"},"AddressDescription":{"type":"string","description":"Текстовий опис адреси, якщо переадресування виконується на адресу"},"StreetDescription":{"type":"string","description":"Текстовий опис вулиці, якщо переадресування виконується на адресу"},"BuildingNumber":{"type":"string","description":"Номер будинку для переадресування на адресу"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"CityRecipientDescription":{"type":"string","description":"Назва міста отримувача"},"SettlementRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) населеного пункту отримувача"},"SettlementRecipientDescription":{"type":"string","description":"Назва населеного пункту отримувача"},"SettlementType":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) типу населеного пункту отримувача"},"CounterpartyRecipientRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) контрагента отримувача"},"CounterpartyRecipientDescription":{"type":"string","description":"Назва інтернет-контрагента отримувача"},"RecipientName":{"type":"string","description":"ПІБ контактної особи отримувача"},"PhoneSender":{"type":"string","description":"Телефон відправника"},"PhoneRecipient":{"type":"string","description":"Телефон отримувача"},"DocumentWeight":{"type":"string","description":"Загальна вага документа. API повертає значення як рядок."}}}}}}
```

## Створити переадресацію відправлення (JSON)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> \
> Цей метод дозволяє створити заявку на переадресування відправлення на відділення або на адресу. Метод доступний тільки для клієнтів відправників.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Service","version":"2.0.0"},"tags":[{"name":"AdditionalService","description":"Операції з додатковими послугами (включно з переадресацією)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["AdditionalService"],"operationId":"saveRedirectingOrderJson","summary":"Створити переадресацію відправлення (JSON)","description":"Метод **save** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\n\nЦей метод дозволяє створити заявку на переадресування відправлення на відділення або на адресу. Метод доступний тільки для клієнтів відправників.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveRedirectingOrderJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveRedirectingOrderResponse"}}}}}}}},"components":{"schemas":{"SaveRedirectingOrderJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral","AdditionalService"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveRedirectingOrderMethodProperties"}}},"SaveRedirectingOrderMethodProperties":{"type":"object","additionalProperties":false,"required":["IntDocNumber","PaymentMethod","OrderType","Customer","ServiceType","RecipientSettlement","RecipientSettlementStreet","BuildingNumber","NoteAddressRecipient","RecipientWarehouse"],"properties":{"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","maxLength":36,"enum":["orderRedirecting"],"description":"Константа — orderRedirecting"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор інтернет-контрагента отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientContactName":{"type":"string","maxLength":39,"description":"ПІБ контактної особи отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача (якщо замовлено отримувачем, ігнорується)"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"Customer":{"type":"string","maxLength":36,"description":"Замовник переадресування (отримувачу не дозволяється змінювати дані отримувача)"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги (DoorsWarehouse, WarehouseWarehouse)"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту (за умови створення переадресування на адресу)"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці в населеному пункті (за умови створення переадресування на адресу)"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку (за умови створення переадресування на адресу)"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Коментар до адреси (за умови створення переадресування на адресу)"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відділення отримувача (куди необхідно переадресувати вантаж)"}}},"SaveRedirectingOrderResponse":{"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/SaveRedirectingOrderItem"}},"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"}}}},"SaveRedirectingOrderItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на переадресацію"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"}}}}}}
```

## Створити переадресацію відправлення (XML)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> \
> Цей метод дозволяє створити заявку на переадресування відправлення на відділення або на адресу. Метод доступний тільки для клієнтів відправників.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Service","version":"2.0.0"},"tags":[{"name":"AdditionalService","description":"Операції з додатковими послугами (включно з переадресацією)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["AdditionalService"],"operationId":"saveRedirectingOrderXml","summary":"Створити переадресацію відправлення (XML)","description":"Метод **save** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\n\nЦей метод дозволяє створити заявку на переадресування відправлення на відділення або на адресу. Метод доступний тільки для клієнтів відправників.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveRedirectingOrderXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveRedirectingOrderXmlResponse"}}}}}}}},"components":{"schemas":{"SaveRedirectingOrderXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral","AdditionalService"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveRedirectingOrderXmlMethodProperties"}}},"SaveRedirectingOrderXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveRedirectingOrderMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveRedirectingOrderMethodProperties":{"type":"object","additionalProperties":false,"required":["IntDocNumber","PaymentMethod","OrderType","Customer","ServiceType","RecipientSettlement","RecipientSettlementStreet","BuildingNumber","NoteAddressRecipient","RecipientWarehouse"],"properties":{"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","maxLength":36,"enum":["orderRedirecting"],"description":"Константа — orderRedirecting"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор інтернет-контрагента отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientContactName":{"type":"string","maxLength":39,"description":"ПІБ контактної особи отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача (якщо замовлено отримувачем, ігнорується)"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"Customer":{"type":"string","maxLength":36,"description":"Замовник переадресування (отримувачу не дозволяється змінювати дані отримувача)"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги (DoorsWarehouse, WarehouseWarehouse)"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту (за умови створення переадресування на адресу)"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці в населеному пункті (за умови створення переадресування на адресу)"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку (за умови створення переадресування на адресу)"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Коментар до адреси (за умови створення переадресування на адресу)"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відділення отримувача (куди необхідно переадресувати вантаж)"}}},"SaveRedirectingOrderXmlResponse":{"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/SaveRedirectingOrderXmlItem"}},"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"}}}}},"SaveRedirectingOrderXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveRedirectingOrderItem"}],"xml":{"name":"item"}},"SaveRedirectingOrderItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на переадресацію"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"}}}}}}
```

## Редагувати заявку на переадресацію (JSON)

> Метод \*\*update\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> \
> Цей метод дозволяє редагувати вже створену заявку на переадресування відправлення. Редагувати замовлення можна, лише якщо статус замовлення \`OrderStatus = "Прийняте"\`.\
> \
> Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри.\
> \
> \<details>\
> \<summary>\<b>Особливості прав редагування\</b>\</summary>\
> \
> \*\*Відправник може:\*\*\
> \* Змінити платника за переадресацію (\`PayerType\`)\
> \* Змінити спосіб оплати (\`PaymentMethod\`)\
> \* Змінити отримувача (\`Recipient\`)\
> \* Змінити контактні дані отримувача\
> \* Змінити ідентифікатор відділення отримувача (\`RecipientWarehouse\`) або адресні дані отримувача:\
> &#x20; \* Місто отримувача (\`CityRecipient\`)\
> &#x20; \* Населений пункт отримувача (\`SettlementRecipient\`)\
> &#x20; \* Вулицю отримувача (\`RecipientSettlementStreet\`)\
> &#x20; \* Примітку до адреси отримувача (\`NoteAddressRecipient\`)\
> \* Змінити примітку до замовлення (\`Note\`)\
> \
> \*\*Отримувач може:\*\*\
> \* Редагувати ідентифікатор відділення отримувача (\`RecipientWarehouse\`)\
> \* Змінювати адресні дані отримувача:\
> &#x20; \* Місто отримувача (\`CityRecipient\`)\
> &#x20; \* Населений пункт отримувача (\`SettlementRecipient\`)\
> &#x20; \* Вулицю отримувача (\`RecipientSettlementStreet\`)\
> &#x20; \* Примітку до адреси отримувача (\`NoteAddressRecipient\`)\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Service","version":"2.0.0"},"tags":[{"name":"AdditionalService","description":"Операції з додатковими послугами (включно з переадресацією)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["AdditionalService"],"operationId":"updateRedirectingOrderJson","summary":"Редагувати заявку на переадресацію (JSON)","description":"Метод **update** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\n\nЦей метод дозволяє редагувати вже створену заявку на переадресування відправлення. Редагувати замовлення можна, лише якщо статус замовлення `OrderStatus = \"Прийняте\"`.\n\nМетод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри.\n\n<details>\n<summary><b>Особливості прав редагування</b></summary>\n\n**Відправник може:**\n* Змінити платника за переадресацію (`PayerType`)\n* Змінити спосіб оплати (`PaymentMethod`)\n* Змінити отримувача (`Recipient`)\n* Змінити контактні дані отримувача\n* Змінити ідентифікатор відділення отримувача (`RecipientWarehouse`) або адресні дані отримувача:\n  * Місто отримувача (`CityRecipient`)\n  * Населений пункт отримувача (`SettlementRecipient`)\n  * Вулицю отримувача (`RecipientSettlementStreet`)\n  * Примітку до адреси отримувача (`NoteAddressRecipient`)\n* Змінити примітку до замовлення (`Note`)\n\n**Отримувач може:**\n* Редагувати ідентифікатор відділення отримувача (`RecipientWarehouse`)\n* Змінювати адресні дані отримувача:\n  * Місто отримувача (`CityRecipient`)\n  * Населений пункт отримувача (`SettlementRecipient`)\n  * Вулицю отримувача (`RecipientSettlementStreet`)\n  * Примітку до адреси отримувача (`NoteAddressRecipient`)\n\n</details>\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRedirectingOrderJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRedirectingOrderResponse"}}}}}}}},"components":{"schemas":{"UpdateRedirectingOrderJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateRedirectingOrderMethodProperties"}}},"UpdateRedirectingOrderMethodProperties":{"type":"object","additionalProperties":false,"required":["PaymentMethod","NoteAddressRecipient","Recipient","CityRecipient","Customer","Ref","RecipientContactName","IntDocNumber","RecipientPhone","SettlementRecipient","ServiceType","PayerType","OrderType"],"properties":{"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Примітка до адреси отримувача. Використовується тільки у разі переадресування на адресу"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) отримувача"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"Note":{"type":"string","maxLength":50,"description":"Примітка до замовлення"},"Customer":{"type":"string","maxLength":36,"description":"Ініціатор редагування (Sender/Recipient)"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеного замовлення"},"RecipientContactName":{"type":"string","maxLength":36,"description":"ПІБ контактної особи отримувача"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) нового відділення отримувача (куди необхідно переадресувати вантаж). Використовується тільки у разі переадресування на відділення"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"SettlementRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту отримувача"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Використовується тільки у разі переадресації на адресу"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці отримувача. Використовується тільки у разі переадресування на адресу"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги. Для відділення — WarehouseWarehouse, для адреси — WarehouseDoors"},"PayerType":{"type":"string","maxLength":36,"description":"Хто оплачує послугу (Sender/Recipient)"},"OrderType":{"type":"string","maxLength":36,"enum":["orderRedirecting"],"description":"Тип замовлення. Константа, що завжди має значення orderRedirecting"}}},"UpdateRedirectingOrderResponse":{"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/UpdateRedirectingOrderItem"}},"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"}}}},"UpdateRedirectingOrderItem":{"type":"object","additionalProperties":false,"properties":{"SettlementType":{"type":"string","maxLength":36,"description":"Тип поселення"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Повертається тільки у разі переадресування на адресу"},"PhoneSender":{"type":"string","maxLength":36,"description":"Телефон відправника (якщо доступно)"},"WarehouseDescription":{"type":"string","maxLength":50,"description":"Опис відділення, на яке створено переадресування. Повертається тільки у разі переадресування на відділення"},"Number":{"type":"string","maxLength":36,"description":"Номер замовлення"},"PhoneRecipient":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"PayerType":{"type":"string","maxLength":36,"description":"Хто оплачує послугу (Sender/Recipient)"},"DocumentWeight":{"type":"string","maxLength":36,"description":"Вага документа (якщо доступно)"},"SettlementRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту отримувача"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Примітка до адреси отримувача"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"InternationalDeliveryType":{"type":"string","maxLength":36,"description":"Тип міжнародної доставки (якщо доступно)"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги. Для відділення — WarehouseWarehouse, для адреси — WarehouseDoors"},"SettlementRecipientDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту отримувача"},"EdrpouRecipient":{"type":"string","maxLength":36,"description":"ЄДРПОУ отримувача (якщо доступно)"},"AddressDescription":{"type":"string","maxLength":50,"description":"Опис нової адреси, на яку створено переадресування. Повертається тільки у разі переадресування на адресу"},"CounterpartyRecipientRef":{"type":"string","maxLength":36,"description":"Ідентифікатор контрагента отримувача"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці отримувача. Повертається тільки у разі переадресування на адресу"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеного замовлення"},"WarehouseRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) нового відділення отримувача (куди необхідно переадресувати вантаж). Використовується тільки у разі переадресування на відділення"},"CounterpartyRecipientDescription":{"type":"string","maxLength":36,"description":"Опис контрагента отримувача"},"CityRecipientDescription":{"type":"string","maxLength":36,"description":"Опис міста отримувача"},"StreetDescription":{"type":"string","maxLength":36,"description":"Вулиця отримувача. Повертається тільки у разі переадресування на адресу"},"RecipientName":{"type":"string","maxLength":36,"description":"ПІБ контактної особи отримувача"}}}}}}
```

## Редагувати заявку на переадресацію (XML)

> Метод \*\*update\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> \
> Цей метод дозволяє редагувати вже створену заявку на переадресування відправлення. Редагувати замовлення можна, лише якщо статус замовлення \`OrderStatus = "Прийняте"\`.\
> \
> Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри.\
> \
> \<details>\
> \<summary>\<b>Особливості прав редагування\</b>\</summary>\
> \
> \*\*Відправник може:\*\*\
> \* Змінити платника за переадресацію (\`PayerType\`)\
> \* Змінити спосіб оплати (\`PaymentMethod\`)\
> \* Змінити отримувача (\`Recipient\`)\
> \* Змінити контактні дані отримувача\
> \* Змінити ідентифікатор відділення отримувача (\`RecipientWarehouse\`) або адресні дані отримувача:\
> &#x20; \* Місто отримувача (\`CityRecipient\`)\
> &#x20; \* Населений пункт отримувача (\`SettlementRecipient\`)\
> &#x20; \* Вулицю отримувача (\`RecipientSettlementStreet\`)\
> &#x20; \* Примітку до адреси отримувача (\`NoteAddressRecipient\`)\
> \* Змінити примітку до замовлення (\`Note\`)\
> \
> \*\*Отримувач може:\*\*\
> \* Редагувати ідентифікатор відділення отримувача (\`RecipientWarehouse\`)\
> \* Змінювати адресні дані отримувача:\
> &#x20; \* Місто отримувача (\`CityRecipient\`)\
> &#x20; \* Населений пункт отримувача (\`SettlementRecipient\`)\
> &#x20; \* Вулицю отримувача (\`RecipientSettlementStreet\`)\
> &#x20; \* Примітку до адреси отримувача (\`NoteAddressRecipient\`)\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Service","version":"2.0.0"},"tags":[{"name":"AdditionalService","description":"Операції з додатковими послугами (включно з переадресацією)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["AdditionalService"],"operationId":"updateRedirectingOrderXml","summary":"Редагувати заявку на переадресацію (XML)","description":"Метод **update** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\n\nЦей метод дозволяє редагувати вже створену заявку на переадресування відправлення. Редагувати замовлення можна, лише якщо статус замовлення `OrderStatus = \"Прийняте\"`.\n\nМетод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри.\n\n<details>\n<summary><b>Особливості прав редагування</b></summary>\n\n**Відправник може:**\n* Змінити платника за переадресацію (`PayerType`)\n* Змінити спосіб оплати (`PaymentMethod`)\n* Змінити отримувача (`Recipient`)\n* Змінити контактні дані отримувача\n* Змінити ідентифікатор відділення отримувача (`RecipientWarehouse`) або адресні дані отримувача:\n  * Місто отримувача (`CityRecipient`)\n  * Населений пункт отримувача (`SettlementRecipient`)\n  * Вулицю отримувача (`RecipientSettlementStreet`)\n  * Примітку до адреси отримувача (`NoteAddressRecipient`)\n* Змінити примітку до замовлення (`Note`)\n\n**Отримувач може:**\n* Редагувати ідентифікатор відділення отримувача (`RecipientWarehouse`)\n* Змінювати адресні дані отримувача:\n  * Місто отримувача (`CityRecipient`)\n  * Населений пункт отримувача (`SettlementRecipient`)\n  * Вулицю отримувача (`RecipientSettlementStreet`)\n  * Примітку до адреси отримувача (`NoteAddressRecipient`)\n\n</details>\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateRedirectingOrderXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateRedirectingOrderXmlResponse"}}}}}}}},"components":{"schemas":{"UpdateRedirectingOrderXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateRedirectingOrderXmlMethodProperties"}}},"UpdateRedirectingOrderXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/UpdateRedirectingOrderMethodProperties"}],"xml":{"name":"methodProperties"}},"UpdateRedirectingOrderMethodProperties":{"type":"object","additionalProperties":false,"required":["PaymentMethod","NoteAddressRecipient","Recipient","CityRecipient","Customer","Ref","RecipientContactName","IntDocNumber","RecipientPhone","SettlementRecipient","ServiceType","PayerType","OrderType"],"properties":{"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Примітка до адреси отримувача. Використовується тільки у разі переадресування на адресу"},"Recipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) отримувача"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"Note":{"type":"string","maxLength":50,"description":"Примітка до замовлення"},"Customer":{"type":"string","maxLength":36,"description":"Ініціатор редагування (Sender/Recipient)"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеного замовлення"},"RecipientContactName":{"type":"string","maxLength":36,"description":"ПІБ контактної особи отримувача"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) нового відділення отримувача (куди необхідно переадресувати вантаж). Використовується тільки у разі переадресування на відділення"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"SettlementRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту отримувача"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Використовується тільки у разі переадресації на адресу"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці отримувача. Використовується тільки у разі переадресування на адресу"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги. Для відділення — WarehouseWarehouse, для адреси — WarehouseDoors"},"PayerType":{"type":"string","maxLength":36,"description":"Хто оплачує послугу (Sender/Recipient)"},"OrderType":{"type":"string","maxLength":36,"enum":["orderRedirecting"],"description":"Тип замовлення. Константа, що завжди має значення orderRedirecting"}}},"UpdateRedirectingOrderXmlResponse":{"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/UpdateRedirectingOrderXmlItem"}},"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"}}}}},"UpdateRedirectingOrderXmlItem":{"allOf":[{"$ref":"#/components/schemas/UpdateRedirectingOrderItem"}],"xml":{"name":"item"}},"UpdateRedirectingOrderItem":{"type":"object","additionalProperties":false,"properties":{"SettlementType":{"type":"string","maxLength":36,"description":"Тип поселення"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Повертається тільки у разі переадресування на адресу"},"PhoneSender":{"type":"string","maxLength":36,"description":"Телефон відправника (якщо доступно)"},"WarehouseDescription":{"type":"string","maxLength":50,"description":"Опис відділення, на яке створено переадресування. Повертається тільки у разі переадресування на відділення"},"Number":{"type":"string","maxLength":36,"description":"Номер замовлення"},"PhoneRecipient":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"PayerType":{"type":"string","maxLength":36,"description":"Хто оплачує послугу (Sender/Recipient)"},"DocumentWeight":{"type":"string","maxLength":36,"description":"Вага документа (якщо доступно)"},"SettlementRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) населеного пункту отримувача"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Примітка до адреси отримувача"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"InternationalDeliveryType":{"type":"string","maxLength":36,"description":"Тип міжнародної доставки (якщо доступно)"},"CityRecipient":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста отримувача"},"ServiceType":{"type":"string","maxLength":36,"description":"Тип послуги. Для відділення — WarehouseWarehouse, для адреси — WarehouseDoors"},"SettlementRecipientDescription":{"type":"string","maxLength":36,"description":"Опис населеного пункту отримувача"},"EdrpouRecipient":{"type":"string","maxLength":36,"description":"ЄДРПОУ отримувача (якщо доступно)"},"AddressDescription":{"type":"string","maxLength":50,"description":"Опис нової адреси, на яку створено переадресування. Повертається тільки у разі переадресування на адресу"},"CounterpartyRecipientRef":{"type":"string","maxLength":36,"description":"Ідентифікатор контрагента отримувача"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці отримувача. Повертається тільки у разі переадресування на адресу"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеного замовлення"},"WarehouseRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) нового відділення отримувача (куди необхідно переадресувати вантаж). Використовується тільки у разі переадресування на відділення"},"CounterpartyRecipientDescription":{"type":"string","maxLength":36,"description":"Опис контрагента отримувача"},"CityRecipientDescription":{"type":"string","maxLength":36,"description":"Опис міста отримувача"},"StreetDescription":{"type":"string","maxLength":36,"description":"Вулиця отримувача. Повертається тільки у разі переадресування на адресу"},"RecipientName":{"type":"string","maxLength":36,"description":"ПІБ контактної особи отримувача"}}}}}}
```

## Отримати список переадресацій відправлень (JSON)

> Метод \*\*getRedirectionOrdersList\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> \
> Цей метод дозволяє отримати список створених заявок на переадресування відправлень.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Service","version":"2.0.0"},"tags":[{"name":"AdditionalService","description":"Операції з додатковими послугами (включно з переадресацією)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["AdditionalService"],"operationId":"getRedirectionOrdersListJson","summary":"Отримати список переадресацій відправлень (JSON)","description":"Метод **getRedirectionOrdersList** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\n\nЦей метод дозволяє отримати список створених заявок на переадресування відправлень.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRedirectionOrdersListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRedirectionOrdersListResponse"}}}}}}}},"components":{"schemas":{"GetRedirectionOrdersListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getRedirectionOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetRedirectionOrdersListMethodProperties"}}},"GetRedirectionOrdersListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на переадресування"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки на переадресування"},"BeginDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «З» у форматі дд.мм.рррр"},"EndDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «ДО» у форматі дд.мм.рррр"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Limit":{"type":"string","maxLength":36,"description":"Ліміт на сторінці"}}},"GetRedirectionOrdersListResponse":{"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/GetRedirectionOrdersListItem"}},"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"}}}},"GetRedirectionOrdersListItem":{"type":"object","additionalProperties":false,"properties":{"OrderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"},"OrderNumber":{"type":"string","maxLength":36,"description":"Номер заявки"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення заявки"},"DocumentNumber":{"type":"string","maxLength":36,"description":"Номер документа, на який створено заявку"},"Note":{"type":"string","maxLength":36,"description":"Причина переадресування"},"CityRecipient":{"type":"string","maxLength":36,"description":"Місто отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Адреса отримувача"},"CounterpartyRecipient":{"type":"string","maxLength":36,"description":"Контрагент отримувача"},"RecipientName":{"type":"string","maxLength":36,"description":"Контактна особа"},"PhoneRecipient":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"DeliveryCost":{"type":"string","maxLength":36,"description":"Вартість експрес-накладної (ЕН) переадресування (якщо створено ЕН)"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Розрахункова дата доставки переадресування (якщо створено ЕН)"},"ExpressWaybillNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної (ЕН) переадресування (якщо створено ЕН)"},"ExpressWaybillStatus":{"type":"string","maxLength":36,"description":"Статус експрес-накладної (ЕН) переадресування (якщо створено ЕН)"}}}}}}
```

## Отримати список переадресацій відправлень (XML)

> Метод \*\*getRedirectionOrdersList\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> \
> Цей метод дозволяє отримати список створених заявок на переадресування відправлень.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Service","version":"2.0.0"},"tags":[{"name":"AdditionalService","description":"Операції з додатковими послугами (включно з переадресацією)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["AdditionalService"],"operationId":"getRedirectionOrdersListXml","summary":"Отримати список переадресацій відправлень (XML)","description":"Метод **getRedirectionOrdersList** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\n\nЦей метод дозволяє отримати список створених заявок на переадресування відправлень.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetRedirectionOrdersListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetRedirectionOrdersListXmlResponse"}}}}}}}},"components":{"schemas":{"GetRedirectionOrdersListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getRedirectionOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetRedirectionOrdersListXmlMethodProperties"}}},"GetRedirectionOrdersListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetRedirectionOrdersListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetRedirectionOrdersListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на переадресування"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки на переадресування"},"BeginDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «З» у форматі дд.мм.рррр"},"EndDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «ДО» у форматі дд.мм.рррр"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Limit":{"type":"string","maxLength":36,"description":"Ліміт на сторінці"}}},"GetRedirectionOrdersListXmlResponse":{"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/GetRedirectionOrdersListXmlItem"}},"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"}}}}},"GetRedirectionOrdersListXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetRedirectionOrdersListItem"}],"xml":{"name":"item"}},"GetRedirectionOrdersListItem":{"type":"object","additionalProperties":false,"properties":{"OrderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки"},"OrderNumber":{"type":"string","maxLength":36,"description":"Номер заявки"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення заявки"},"DocumentNumber":{"type":"string","maxLength":36,"description":"Номер документа, на який створено заявку"},"Note":{"type":"string","maxLength":36,"description":"Причина переадресування"},"CityRecipient":{"type":"string","maxLength":36,"description":"Місто отримувача"},"RecipientAddress":{"type":"string","maxLength":36,"description":"Адреса отримувача"},"CounterpartyRecipient":{"type":"string","maxLength":36,"description":"Контрагент отримувача"},"RecipientName":{"type":"string","maxLength":36,"description":"Контактна особа"},"PhoneRecipient":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"DeliveryCost":{"type":"string","maxLength":36,"description":"Вартість експрес-накладної (ЕН) переадресування (якщо створено ЕН)"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Розрахункова дата доставки переадресування (якщо створено ЕН)"},"ExpressWaybillNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної (ЕН) переадресування (якщо створено ЕН)"},"ExpressWaybillStatus":{"type":"string","maxLength":36,"description":"Статус експрес-накладної (ЕН) переадресування (якщо створено ЕН)"}}}}}}
```

## Перевірити можливість редагування переадресації (JSON)

> Метод \*\*checkPossibilityForRedirecting\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> Дозволяє перевірити можливість редагування вже створеної заявки на переадресування.\
> Доступний відправнику та отримувачу з обмеженнями щодо редагованих полів.\
> \
> \<details>\
> \<summary>Особливості редагування для відправника та отримувача\</summary>\
> \
> Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри. Існують такі особливості редагування:\
> \
> Якщо замовник перевірки є відправником, він може:\
> \* Змінити отримувача\
> \* Змінити адресу доставки\
> \* Вказати платника за переадресацію (себе, якщо вибрано безготівкову форму розрахунку, або отримувача, якщо йому доступна ця форма оплати)\
> \
> Якщо замовник перевірки є отримувачем, він може редагувати лише адресу доставки.\
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Redirecting","description":"Операції, пов'язані з переадресацією відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Redirecting"],"operationId":"checkPossibilityForEditingRedirectingJson","summary":"Перевірити можливість редагування переадресації (JSON)","description":"Метод **checkPossibilityForRedirecting** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\nДозволяє перевірити можливість редагування вже створеної заявки на переадресування.\nДоступний відправнику та отримувачу з обмеженнями щодо редагованих полів.\n\n<details>\n<summary>Особливості редагування для відправника та отримувача</summary>\n\nМетод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри. Існують такі особливості редагування:\n\nЯкщо замовник перевірки є відправником, він може:\n* Змінити отримувача\n* Змінити адресу доставки\n* Вказати платника за переадресацію (себе, якщо вибрано безготівкову форму розрахунку, або отримувача, якщо йому доступна ця форма оплати)\n\nЯкщо замовник перевірки є отримувачем, він може редагувати лише адресу доставки.\n</details>\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForEditingRedirectingJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForEditingRedirectingResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityForEditingRedirectingJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["checkPossibilityForRedirecting"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityForEditingRedirectingMethodProperties"}}},"CheckPossibilityForEditingRedirectingMethodProperties":{"type":"object","additionalProperties":false,"required":["OrderRef"],"properties":{"OrderRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) створеного замовлення"},"AddressDescription":{"type":"string","description":"Текстовий опис адреси (якщо переадресування на адресу)"},"RecipientName":{"type":"string","description":"ПІБ контактної особи отримувача. Цей параметр може редагувати лише відправник"},"PhoneSender":{"type":"string","description":"Телефон відправника"},"StreetDescription":{"type":"string","description":"Текстовий опис вулиці (якщо переадресування на адресу)"},"PhoneRecipient":{"type":"string","description":"Телефон отримувача. Цей параметр може редагувати лише відправник"},"BuildingNumber":{"type":"string","description":"Номер будинку (за умови створення переадресування на адресу)"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"DocumentWeight":{"type":"string","description":"Загальна вага відправлення"},"SettlementRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) населеного пункту отримувача"},"SettlementType":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) типу населеного пункту отримувача"},"PayerType":{"type":"string","description":"Тип платника. Цей параметр може редагувати лише відправник"},"PaymentMethod":{"type":"string","description":"Форма розрахунку (Cash/NonCash). Цей параметр може редагувати лише відправник"},"CounterpartyRecipientRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) інтернет-контрагента отримувача"},"WarehouseRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відділення"}}},"CheckPossibilityForEditingRedirectingResponse":{"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/CheckEditingRedirectingPossibilityItem"}},"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"}}}},"CheckEditingRedirectingPossibilityItem":{"type":"object","properties":{"PhoneSender":{"type":"string","description":"Телефон відправника"},"BuildingNumber":{"type":"string","description":"Номер будинку (за умови створення переадресування на адресу)"},"PhoneRecipient":{"type":"string","description":"Телефон отримувача"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"DocumentWeight":{"type":"string","description":"Загальна вага відправлення"},"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) документа"},"CityRecipientDescription":{"type":"string","description":"Назва міста отримувача"},"Number":{"type":"string","description":"Номер документа"},"SettlementRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) населеного пункту отримувача"},"SettlementRecipientDescription":{"type":"string","description":"Назва населеного пункту отримувача"},"PayerType":{"type":"string","description":"Тип платника"},"SettlementType":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) типу населеного пункту отримувача"},"PaymentMethod":{"type":"string","description":"Форма розрахунку (Cash/NonCash)"},"CounterpartyRecipientRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) інтернет-контрагента отримувача"},"WarehouseRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відділення"},"CounterpartyRecipientDescription":{"type":"string","description":"Назва інтернет-контрагента отримувача"},"WarehouseDescription":{"type":"string","description":"Опис відділення"},"AddressDescription":{"type":"string","description":"Текстовий опис адреси (за умови створення переадресування на адресу)"},"RecipientName":{"type":"string","description":"ПІБ контактної особи отримувача"},"StreetDescription":{"type":"string","description":"Текстовий опис вулиці (за умови створення переадресування на адресу)"}}}}}}
```

## Перевірити можливість редагування переадресації (XML)

> Метод \*\*checkPossibilityForRedirecting\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*).\
> Дозволяє перевірити можливість редагування вже створеної заявки на переадресування.\
> Доступний відправнику та отримувачу з обмеженнями щодо редагованих полів.\
> \
> \<details>\
> \<summary>Особливості редагування для відправника та отримувача\</summary>\
> \
> Метод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри. Існують такі особливості редагування:\
> \
> Якщо замовник перевірки є відправником, він може:\
> \* Змінити отримувача\
> \* Змінити адресу доставки\
> \* Вказати платника за переадресацію (себе, якщо вибрано безготівкову форму розрахунку, або отримувача, якщо йому доступна ця форма оплати)\
> \
> Якщо замовник перевірки є отримувачем, він може редагувати лише адресу доставки.\
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Redirecting","description":"Операції, пов'язані з переадресацією відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Redirecting"],"operationId":"checkPossibilityForEditingRedirectingXml","summary":"Перевірити можливість редагування переадресації (XML)","description":"Метод **checkPossibilityForRedirecting** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**).\nДозволяє перевірити можливість редагування вже створеної заявки на переадресування.\nДоступний відправнику та отримувачу з обмеженнями щодо редагованих полів.\n\n<details>\n<summary>Особливості редагування для відправника та отримувача</summary>\n\nМетод доступний як відправнику, так і отримувачу, проте отримувач може редагувати не всі параметри. Існують такі особливості редагування:\n\nЯкщо замовник перевірки є відправником, він може:\n* Змінити отримувача\n* Змінити адресу доставки\n* Вказати платника за переадресацію (себе, якщо вибрано безготівкову форму розрахунку, або отримувача, якщо йому доступна ця форма оплати)\n\nЯкщо замовник перевірки є отримувачем, він може редагувати лише адресу доставки.\n</details>\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForEditingRedirectingXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityForEditingRedirectingXmlResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityForEditingRedirectingXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["checkPossibilityForRedirecting"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityForEditingRedirectingXmlMethodProperties"}}},"CheckPossibilityForEditingRedirectingXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["OrderRef"],"properties":{"OrderRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) створеного замовлення"},"AddressDescription":{"type":"string","description":"Текстовий опис адреси (якщо переадресування на адресу)"},"RecipientName":{"type":"string","description":"ПІБ контактної особи отримувача. Цей параметр може редагувати лише відправник"},"PhoneSender":{"type":"string","description":"Телефон відправника"},"StreetDescription":{"type":"string","description":"Текстовий опис вулиці (якщо переадресування на адресу)"},"PhoneRecipient":{"type":"string","description":"Телефон отримувача. Цей параметр може редагувати лише відправник"},"BuildingNumber":{"type":"string","description":"Номер будинку (за умови створення переадресування на адресу)"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"DocumentWeight":{"type":"string","description":"Загальна вага відправлення"},"SettlementRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) населеного пункту отримувача"},"SettlementType":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) типу населеного пункту отримувача"},"PayerType":{"type":"string","description":"Тип платника. Цей параметр може редагувати лише відправник"},"PaymentMethod":{"type":"string","description":"Форма розрахунку (Cash/NonCash). Цей параметр може редагувати лише відправник"},"CounterpartyRecipientRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) інтернет-контрагента отримувача"},"WarehouseRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відділення"}}},"CheckPossibilityForEditingRedirectingXmlResponse":{"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/CheckEditingRedirectingPossibilityXmlItem"}},"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"}}}}},"CheckEditingRedirectingPossibilityXmlItem":{"allOf":[{"$ref":"#/components/schemas/CheckEditingRedirectingPossibilityItem"}],"xml":{"name":"item"}},"CheckEditingRedirectingPossibilityItem":{"type":"object","properties":{"PhoneSender":{"type":"string","description":"Телефон відправника"},"BuildingNumber":{"type":"string","description":"Номер будинку (за умови створення переадресування на адресу)"},"PhoneRecipient":{"type":"string","description":"Телефон отримувача"},"CityRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) міста отримувача"},"DocumentWeight":{"type":"string","description":"Загальна вага відправлення"},"Ref":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) документа"},"CityRecipientDescription":{"type":"string","description":"Назва міста отримувача"},"Number":{"type":"string","description":"Номер документа"},"SettlementRecipient":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) населеного пункту отримувача"},"SettlementRecipientDescription":{"type":"string","description":"Назва населеного пункту отримувача"},"PayerType":{"type":"string","description":"Тип платника"},"SettlementType":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) типу населеного пункту отримувача"},"PaymentMethod":{"type":"string","description":"Форма розрахунку (Cash/NonCash)"},"CounterpartyRecipientRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) інтернет-контрагента отримувача"},"WarehouseRef":{"type":"string","format":"uuid","description":"Ідентифікатор (REF) відділення"},"CounterpartyRecipientDescription":{"type":"string","description":"Назва інтернет-контрагента отримувача"},"WarehouseDescription":{"type":"string","description":"Опис відділення"},"AddressDescription":{"type":"string","description":"Текстовий опис адреси (за умови створення переадресування на адресу)"},"RecipientName":{"type":"string","description":"ПІБ контактної особи отримувача"},"StreetDescription":{"type":"string","description":"Текстовий опис вулиці (за умови створення переадресування на адресу)"}}}}}}
```

## Розрахувати переадресацію (JSON)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*). Цей метод дозволяє розрахувати переадресування.\
> \
> \<details>\
> \<summary>Особливості використання\</summary>\
> \
> Запит майже ідентичний до створення заявки на переадресування. Відмінність тільки в тому, що використовується параметр \`OnlyGetPricing\` із значенням «1». Метод доступний лише для клієнтів-відправників.\
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Redirecting","description":"Операції, пов'язані з переадресацією відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Redirecting"],"operationId":"calculateRedirectingJson","summary":"Розрахувати переадресацію (JSON)","description":"Метод **save** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**). Цей метод дозволяє розрахувати переадресування.\n\n<details>\n<summary>Особливості використання</summary>\n\nЗапит майже ідентичний до створення заявки на переадресування. Відмінність тільки в тому, що використовується параметр `OnlyGetPricing` із значенням «1». Метод доступний лише для клієнтів-відправників.\n</details>\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateRedirectingJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateRedirectingResponse"}}}}}}}},"components":{"schemas":{"CalculateRedirectingJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CalculateRedirectingMethodProperties"}}},"CalculateRedirectingMethodProperties":{"type":"object","additionalProperties":false,"required":["RecipientSettlement","Recipient","RecipientSettlementStreet","RecipientWarehouse","BuildingNumber","NoteAddressRecipient","Customer","RecipientContactName","RecipientPhone","IntDocNumber","PaymentMethod","PayerType","OrderType","ServiceType"],"properties":{"RecipientSettlement":{"type":"string","description":"Ідентифікатор (REF) населеного пункту (за умови створення переадресування на адресу)"},"Recipient":{"type":"string","description":"Ідентифікатор інтернет-контрагента отримувача"},"RecipientSettlementStreet":{"type":"string","description":"Ідентифікатор (REF) вулиці в населеному пункті (за умови створення переадресування на адресу)"},"RecipientWarehouse":{"type":"string","description":"Ідентифікатор (REF) відділення отримувача, куди необхідно переадресувати вантаж (за умови створення переадресування на відділення)"},"BuildingNumber":{"type":"string","description":"Номер будинку (за умови створення переадресування на адресу)"},"NoteAddressRecipient":{"type":"string","description":"Коментар до адреси (за умови створення переадресування на адресу)"},"Customer":{"type":"string","description":"Замовник переадресування (отримувачу не дозволяється змінювати дані отримувача)"},"RecipientContactName":{"type":"string","description":"ПІБ контактної особи отримувача"},"RecipientPhone":{"type":"string","description":"Номер телефону отримувача"},"IntDocNumber":{"type":"string","description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","description":"Форма розрахунку (Cash/NonCash)"},"PayerType":{"type":"string","description":"Тип платника"},"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","description":"Константа — orderRedirecting"},"ServiceType":{"type":"string","description":"Тип послуги (DoorsWarehouse, WarehouseWarehouse, WarehouseDoors, DoorsDoors)"},"OnlyGetPricing":{"type":"string","description":"Використовується параметр `OnlyGetPricing` із значенням «1»"}}},"CalculateRedirectingResponse":{"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/CalculateRedirectingItem"}},"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"}}}},"CalculateRedirectingItem":{"type":"object","properties":{"Pricing":{"$ref":"#/components/schemas/PricingDetails"},"ScheduledDeliveryDate":{"type":"string","description":"Запланована дата доставки переадресування у форматі yyyy-mm-dd hh:mm:ss"}}},"PricingDetails":{"type":"object","description":"Об'єкт, що містить інформацію про вартість послуг","properties":{"Services":{"type":"array","description":"Масив з двох об'єктів, що містить перелік послуг та їхню вартість","items":{"$ref":"#/components/schemas/ServiceDetailItem"}},"Total":{"type":"integer","description":"Загальна вартість усіх послуг"},"FirstDayStorage":{"type":"string","description":"Інформація про перший день зберігання"}}},"ServiceDetailItem":{"type":"object","properties":{"Service":{"type":"string","description":"Назва послуги"},"Cost":{"type":"integer","description":"Вартість послуги"}}}}}}
```

## Розрахувати переадресацію (XML)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*). Цей метод дозволяє розрахувати переадресування.\
> \
> \<details>\
> \<summary>Особливості використання\</summary>\
> \
> Запит майже ідентичний до створення заявки на переадресування. Відмінність тільки в тому, що використовується параметр \`OnlyGetPricing\` із значенням «1». Метод доступний лише для клієнтів-відправників.\
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Redirecting","description":"Операції, пов'язані з переадресацією відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Redirecting"],"operationId":"calculateRedirectingXml","summary":"Розрахувати переадресацію (XML)","description":"Метод **save** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**). Цей метод дозволяє розрахувати переадресування.\n\n<details>\n<summary>Особливості використання</summary>\n\nЗапит майже ідентичний до створення заявки на переадресування. Відмінність тільки в тому, що використовується параметр `OnlyGetPricing` із значенням «1». Метод доступний лише для клієнтів-відправників.\n</details>\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CalculateRedirectingXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)\n","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CalculateRedirectingXmlResponse"}}}}}}}},"components":{"schemas":{"CalculateRedirectingXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CalculateRedirectingXmlMethodProperties"}}},"CalculateRedirectingXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["RecipientSettlement","Recipient","RecipientSettlementStreet","RecipientWarehouse","BuildingNumber","NoteAddressRecipient","Customer","RecipientContactName","RecipientPhone","IntDocNumber","PaymentMethod","PayerType","OrderType","ServiceType"],"properties":{"RecipientSettlement":{"type":"string","description":"Ідентифікатор (REF) населеного пункту (за умови створення переадресування на адресу)"},"Recipient":{"type":"string","description":"Ідентифікатор інтернет-контрагента отримувача"},"RecipientSettlementStreet":{"type":"string","description":"Ідентифікатор (REF) вулиці в населеному пункті (за умови створення переадресування на адресу)"},"RecipientWarehouse":{"type":"string","description":"Ідентифікатор (REF) відділення отримувача, куди необхідно переадресувати вантаж (за умови створення переадресування на відділення)"},"BuildingNumber":{"type":"string","description":"Номер будинку (за умови створення переадресування на адресу)"},"NoteAddressRecipient":{"type":"string","description":"Коментар до адреси (за умови створення переадресування на адресу)"},"Customer":{"type":"string","description":"Замовник переадресування (отримувачу не дозволяється змінювати дані отримувача)"},"RecipientContactName":{"type":"string","description":"ПІБ контактної особи отримувача"},"RecipientPhone":{"type":"string","description":"Номер телефону отримувача"},"IntDocNumber":{"type":"string","description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","description":"Форма розрахунку (Cash/NonCash)"},"PayerType":{"type":"string","description":"Тип платника"},"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","description":"Константа — orderRedirecting"},"ServiceType":{"type":"string","description":"Тип послуги (DoorsWarehouse, WarehouseWarehouse, WarehouseDoors, DoorsDoors)"},"OnlyGetPricing":{"type":"string","description":"Використовується параметр `OnlyGetPricing` із значенням «1»"}}},"CalculateRedirectingXmlResponse":{"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/CalculateRedirectingXmlItem"}},"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"}}}}},"CalculateRedirectingXmlItem":{"type":"object","xml":{"name":"item"},"properties":{"Pricing":{"$ref":"#/components/schemas/PricingXmlDetails"},"ScheduledDeliveryDate":{"type":"string","description":"Запланована дата доставки переадресування у форматі yyyy-mm-dd hh:mm:ss"}}},"PricingXmlDetails":{"type":"object","description":"Об'єкт, що містить інформацію про вартість послуг","properties":{"Services":{"type":"array","description":"Масив з двох об'єктів, що містить перелік послуг та їхню вартість","xml":{"name":"Services","wrapped":true},"items":{"$ref":"#/components/schemas/ServiceDetailXmlItem"}},"Total":{"type":"integer","description":"Загальна вартість усіх послуг"},"FirstDayStorage":{"type":"string","description":"Інформація про перший день зберігання"}}},"ServiceDetailXmlItem":{"allOf":[{"$ref":"#/components/schemas/ServiceDetailItem"}],"xml":{"name":"item"}},"ServiceDetailItem":{"type":"object","properties":{"Service":{"type":"string","description":"Назва послуги"},"Cost":{"type":"integer","description":"Вартість послуги"}}}}}}
```

### Створити повернення

## Перевірити можливість створення повернення (JSON)

> Метод \*\*CheckPossibilityCreateReturn\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє перевірити можливість створення заявки на повернення.\
> \
> Метод доступний лише для клієнтів-відправників. У разі успіху повертаються блоки адрес, які можна використовувати для створення заявки.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"checkPossibilityCreateReturnJson","summary":"Перевірити можливість створення повернення (JSON)","description":"Метод **CheckPossibilityCreateReturn** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє перевірити можливість створення заявки на повернення.\n\nМетод доступний лише для клієнтів-відправників. У разі успіху повертаються блоки адрес, які можна використовувати для створення заявки.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnJsonResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityCreateReturnJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["CheckPossibilityCreateReturn"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnMethodProperties"}}},"CheckPossibilityCreateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["Number"],"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер документа"}}},"CheckPossibilityCreateReturnJsonResponse":{"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/CheckPossibilityCreateReturnItem"}},"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"}}}},"CheckPossibilityCreateReturnItem":{"type":"object","additionalProperties":false,"properties":{"NonCash":{"type":"boolean","description":"Можливість використання безготівкового розрахунку (false/true)"},"City":{"type":"string","maxLength":36,"description":"Місто отримувача"},"Counterparty":{"type":"string","maxLength":36,"description":"Контрагент-отримувач"},"ContactPerson":{"type":"string","maxLength":36,"description":"Контактна персона"},"Address":{"type":"string","maxLength":100,"description":"Адреса отримувача"},"Phone":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор блоку"}}}}}}
```

## Перевірити можливість створення повернення (XML)

> Метод \*\*CheckPossibilityCreateReturn\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє перевірити можливість створення заявки на повернення.\
> \
> Метод доступний лише для клієнтів-відправників. У разі успіху повертаються блоки адрес, які можна використовувати для створення заявки.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"checkPossibilityCreateReturnXml","summary":"Перевірити можливість створення повернення (XML)","description":"Метод **CheckPossibilityCreateReturn** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє перевірити можливість створення заявки на повернення.\n\nМетод доступний лише для клієнтів-відправників. У разі успіху повертаються блоки адрес, які можна використовувати для створення заявки.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnXmlResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityCreateReturnXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["CheckPossibilityCreateReturn"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnXmlMethodProperties"}}},"CheckPossibilityCreateReturnXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["Number"],"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер документа"}}},"CheckPossibilityCreateReturnXmlResponse":{"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/CheckPossibilityCreateReturnXmlItem"}},"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"}}}}},"CheckPossibilityCreateReturnXmlItem":{"allOf":[{"$ref":"#/components/schemas/CheckPossibilityCreateReturnItem"}],"xml":{"name":"item"}},"CheckPossibilityCreateReturnItem":{"type":"object","additionalProperties":false,"properties":{"NonCash":{"type":"boolean","description":"Можливість використання безготівкового розрахунку (false/true)"},"City":{"type":"string","maxLength":36,"description":"Місто отримувача"},"Counterparty":{"type":"string","maxLength":36,"description":"Контрагент-отримувач"},"ContactPerson":{"type":"string","maxLength":36,"description":"Контактна персона"},"Address":{"type":"string","maxLength":100,"description":"Адреса отримувача"},"Phone":{"type":"string","maxLength":36,"description":"Телефон отримувача"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор блоку"}}}}}}
```

## Створити повернення (JSON)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalService\*\* і дозволяє створити заявку на повернення (метод доступний тільки для клієнтів відправників). Цей метод підтримує декілька варіантів повернення: на адресу відправника, на нову адресу та на нове відділення. Основна частина методу однакова для всіх випадків, але відрізняються параметри адреси у запиті.\
> \
> \<details>\
> \<summary>\<b>Повернення на адресу відправлення\</b>\</summary>\
> \
> Необхідно вказати ідентифікатор адреси відправлення. Адреса повертається у відповіді методу CheckPossibilityCreateReturn.\
> \
> \*\*Приклад:\*\*\
> \`\`\`json\
> {\
> &#x20; "apiKey": "\[ВАШ КЛЮЧ]",\
> &#x20; "modelName": "AdditionalServiceGeneral",\
> &#x20; "calledMethod": "save",\
> &#x20; "methodProperties": {\
> &#x20;   "IntDocNumber": "206004560074695",\
> &#x20;   "PaymentMethod": "Cash",\
> &#x20;   "Reason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "SubtypeReason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "Note": "Additional information",\
> &#x20;   "OrderType": "orderCargoReturn",\
> &#x20;   "ReturnAddressRef": "00000000-0000-0000-0000-000000000000"\
> &#x20; }\
> }\
> \`\`\`\
> \</details>\
> \
> \<details>\
> \<summary>\<b>Повернення на нову адресу\</b>\</summary>\
> \
> Необхідно вказати параметри нової адреси.\
> \
> \*\*Приклад:\*\*\
> \`\`\`json\
> {\
> &#x20; "apiKey": "\[ВАШ КЛЮЧ]",\
> &#x20; "modelName": "AdditionalServiceGeneral",\
> &#x20; "calledMethod": "save",\
> &#x20; "methodProperties": {\
> &#x20;   "IntDocNumber": "206004560074695",\
> &#x20;   "PaymentMethod": "Cash",\
> &#x20;   "Reason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "SubtypeReason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "Note": "Additional information",\
> &#x20;   "OrderType": "orderCargoReturn",\
> &#x20;   "RecipientSettlement": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "BuildingNumber": "4",\
> &#x20;   "NoteAddressRecipient": "2"\
> &#x20; }\
> }\
> \`\`\`\
> \</details>\
> \
> \<details>\
> \<summary>\<b>Повернення на нове відділення\</b>\</summary>\
> \
> Необхідно вказати ідентифікатор відділення для повернення. Ідентифікатор повертається у відповіді методу CheckPossibilityCreateReturn.\
> \
> \*\*Приклад:\*\*\
> \`\`\`json\
> {\
> &#x20; "apiKey": "\[ВАШ КЛЮЧ]",\
> &#x20; "modelName": "AdditionalServiceGeneral",\
> &#x20; "calledMethod": "save",\
> &#x20; "methodProperties": {\
> &#x20;   "IntDocNumber": "206004560074695",\
> &#x20;   "PaymentMethod": "Cash",\
> &#x20;   "Reason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "SubtypeReason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "Note": "Additional information",\
> &#x20;   "OrderType": "orderCargoReturn",\
> &#x20;   "RecipientWarehouse": "00000000-0000-0000-0000-000000000000"\
> &#x20; }\
> }\
> \`\`\`\
> \</details>\
> \
> Відповідь однакова у всіх випадках.<br>

````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"createReturnJson","summary":"Створити повернення (JSON)","description":"Метод **save** працює в моделі **AdditionalService** і дозволяє створити заявку на повернення (метод доступний тільки для клієнтів відправників). Цей метод підтримує декілька варіантів повернення: на адресу відправника, на нову адресу та на нове відділення. Основна частина методу однакова для всіх випадків, але відрізняються параметри адреси у запиті.\n\n<details>\n<summary><b>Повернення на адресу відправлення</b></summary>\n\nНеобхідно вказати ідентифікатор адреси відправлення. Адреса повертається у відповіді методу CheckPossibilityCreateReturn.\n\n**Приклад:**\n```json\n{\n  \"apiKey\": \"[ВАШ КЛЮЧ]\",\n  \"modelName\": \"AdditionalServiceGeneral\",\n  \"calledMethod\": \"save\",\n  \"methodProperties\": {\n    \"IntDocNumber\": \"206004560074695\",\n    \"PaymentMethod\": \"Cash\",\n    \"Reason\": \"00000000-0000-0000-0000-000000000000\",\n    \"SubtypeReason\": \"00000000-0000-0000-0000-000000000000\",\n    \"Note\": \"Additional information\",\n    \"OrderType\": \"orderCargoReturn\",\n    \"ReturnAddressRef\": \"00000000-0000-0000-0000-000000000000\"\n  }\n}\n```\n</details>\n\n<details>\n<summary><b>Повернення на нову адресу</b></summary>\n\nНеобхідно вказати параметри нової адреси.\n\n**Приклад:**\n```json\n{\n  \"apiKey\": \"[ВАШ КЛЮЧ]\",\n  \"modelName\": \"AdditionalServiceGeneral\",\n  \"calledMethod\": \"save\",\n  \"methodProperties\": {\n    \"IntDocNumber\": \"206004560074695\",\n    \"PaymentMethod\": \"Cash\",\n    \"Reason\": \"00000000-0000-0000-0000-000000000000\",\n    \"SubtypeReason\": \"00000000-0000-0000-0000-000000000000\",\n    \"Note\": \"Additional information\",\n    \"OrderType\": \"orderCargoReturn\",\n    \"RecipientSettlement\": \"00000000-0000-0000-0000-000000000000\",\n    \"RecipientSettlementStreet\": \"00000000-0000-0000-0000-000000000000\",\n    \"BuildingNumber\": \"4\",\n    \"NoteAddressRecipient\": \"2\"\n  }\n}\n```\n</details>\n\n<details>\n<summary><b>Повернення на нове відділення</b></summary>\n\nНеобхідно вказати ідентифікатор відділення для повернення. Ідентифікатор повертається у відповіді методу CheckPossibilityCreateReturn.\n\n**Приклад:**\n```json\n{\n  \"apiKey\": \"[ВАШ КЛЮЧ]\",\n  \"modelName\": \"AdditionalServiceGeneral\",\n  \"calledMethod\": \"save\",\n  \"methodProperties\": {\n    \"IntDocNumber\": \"206004560074695\",\n    \"PaymentMethod\": \"Cash\",\n    \"Reason\": \"00000000-0000-0000-0000-000000000000\",\n    \"SubtypeReason\": \"00000000-0000-0000-0000-000000000000\",\n    \"Note\": \"Additional information\",\n    \"OrderType\": \"orderCargoReturn\",\n    \"RecipientWarehouse\": \"00000000-0000-0000-0000-000000000000\"\n  }\n}\n```\n</details>\n\nВідповідь однакова у всіх випадках.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveReturnJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveReturnJsonResponse"}}}}}}}},"components":{"schemas":{"SaveReturnJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveReturnMethodProperties"}}},"SaveReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["BuildingNumber","RecipientSettlement","RecipientWarehouse","IntDocNumber","PaymentMethod","Reason","SubtypeReason","OrderType","ReturnAddressRef","RecipientSettlementStreet"],"properties":{"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Параметр використовується для повернення на нову адресу"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Коментар до адреси  (квартира, поверх, під'їзд тощо). Параметр використовується для повернення на нову адресу"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту отримувача. Параметр використовується для повернення на нову адресу"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відділення для повернення (дані з відповіді методу CheckPossibilityCreateReturn). Параметр використовується для повернення на нове відділення"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"Reason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини повернення"},"SubtypeReason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини повернення"},"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","maxLength":36,"description":"Константа — orderCargoReturn"},"ReturnAddressRef":{"type":"string","maxLength":36,"description":"Адреса для повернення (дані з відповіді методу CheckPossibilityCreateReturn). Параметр використовується для повернення на адресу відправника"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Вулиця отримувача. Параметр використовується для повернення на нову адресу"}}},"SaveReturnJsonResponse":{"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/SaveReturnItem"}},"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"}}}},"SaveReturnItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на повернення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"}}}}}}
````

## Створити повернення (XML)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalService\*\* і дозволяє створити заявку на повернення (метод доступний тільки для клієнтів відправників). Цей метод підтримує декілька варіантів повернення: на адресу відправника, на нову адресу та на нове відділення. Основна частина методу однакова для всіх випадків, але відрізняються параметри адреси у запиті.\
> \
> \<details>\
> \<summary>\<b>Повернення на адресу відправлення\</b>\</summary>\
> \
> Необхідно вказати ідентифікатор адреси відправлення. Адреса повертається у відповіді методу CheckPossibilityCreateReturn.\
> \
> \*\*Приклад:\*\*\
> \`\`\`json\
> {\
> &#x20; "apiKey": "\[ВАШ КЛЮЧ]",\
> &#x20; "modelName": "AdditionalServiceGeneral",\
> &#x20; "calledMethod": "save",\
> &#x20; "methodProperties": {\
> &#x20;   "IntDocNumber": "206004560074695",\
> &#x20;   "PaymentMethod": "Cash",\
> &#x20;   "Reason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "SubtypeReason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "Note": "Additional information",\
> &#x20;   "OrderType": "orderCargoReturn",\
> &#x20;   "ReturnAddressRef": "00000000-0000-0000-0000-000000000000"\
> &#x20; }\
> }\
> \`\`\`\
> \</details>\
> \
> \<details>\
> \<summary>\<b>Повернення на нову адресу\</b>\</summary>\
> \
> Необхідно вказати параметри нової адреси.\
> \
> \*\*Приклад:\*\*\
> \`\`\`json\
> {\
> &#x20; "apiKey": "\[ВАШ КЛЮЧ]",\
> &#x20; "modelName": "AdditionalServiceGeneral",\
> &#x20; "calledMethod": "save",\
> &#x20; "methodProperties": {\
> &#x20;   "IntDocNumber": "206004560074695",\
> &#x20;   "PaymentMethod": "Cash",\
> &#x20;   "Reason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "SubtypeReason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "Note": "Additional information",\
> &#x20;   "OrderType": "orderCargoReturn",\
> &#x20;   "RecipientSettlement": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "RecipientSettlementStreet": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "BuildingNumber": "4",\
> &#x20;   "NoteAddressRecipient": "2"\
> &#x20; }\
> }\
> \`\`\`\
> \</details>\
> \
> \<details>\
> \<summary>\<b>Повернення на нове відділення\</b>\</summary>\
> \
> Необхідно вказати ідентифікатор відділення для повернення. Ідентифікатор повертається у відповіді методу CheckPossibilityCreateReturn.\
> \
> \*\*Приклад:\*\*\
> \`\`\`json\
> {\
> &#x20; "apiKey": "\[ВАШ КЛЮЧ]",\
> &#x20; "modelName": "AdditionalServiceGeneral",\
> &#x20; "calledMethod": "save",\
> &#x20; "methodProperties": {\
> &#x20;   "IntDocNumber": "206004560074695",\
> &#x20;   "PaymentMethod": "Cash",\
> &#x20;   "Reason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "SubtypeReason": "00000000-0000-0000-0000-000000000000",\
> &#x20;   "Note": "Additional information",\
> &#x20;   "OrderType": "orderCargoReturn",\
> &#x20;   "RecipientWarehouse": "00000000-0000-0000-0000-000000000000"\
> &#x20; }\
> }\
> \`\`\`\
> \</details>\
> \
> Відповідь однакова у всіх випадках.<br>

````json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"createReturnXml","summary":"Створити повернення (XML)","description":"Метод **save** працює в моделі **AdditionalService** і дозволяє створити заявку на повернення (метод доступний тільки для клієнтів відправників). Цей метод підтримує декілька варіантів повернення: на адресу відправника, на нову адресу та на нове відділення. Основна частина методу однакова для всіх випадків, але відрізняються параметри адреси у запиті.\n\n<details>\n<summary><b>Повернення на адресу відправлення</b></summary>\n\nНеобхідно вказати ідентифікатор адреси відправлення. Адреса повертається у відповіді методу CheckPossibilityCreateReturn.\n\n**Приклад:**\n```json\n{\n  \"apiKey\": \"[ВАШ КЛЮЧ]\",\n  \"modelName\": \"AdditionalServiceGeneral\",\n  \"calledMethod\": \"save\",\n  \"methodProperties\": {\n    \"IntDocNumber\": \"206004560074695\",\n    \"PaymentMethod\": \"Cash\",\n    \"Reason\": \"00000000-0000-0000-0000-000000000000\",\n    \"SubtypeReason\": \"00000000-0000-0000-0000-000000000000\",\n    \"Note\": \"Additional information\",\n    \"OrderType\": \"orderCargoReturn\",\n    \"ReturnAddressRef\": \"00000000-0000-0000-0000-000000000000\"\n  }\n}\n```\n</details>\n\n<details>\n<summary><b>Повернення на нову адресу</b></summary>\n\nНеобхідно вказати параметри нової адреси.\n\n**Приклад:**\n```json\n{\n  \"apiKey\": \"[ВАШ КЛЮЧ]\",\n  \"modelName\": \"AdditionalServiceGeneral\",\n  \"calledMethod\": \"save\",\n  \"methodProperties\": {\n    \"IntDocNumber\": \"206004560074695\",\n    \"PaymentMethod\": \"Cash\",\n    \"Reason\": \"00000000-0000-0000-0000-000000000000\",\n    \"SubtypeReason\": \"00000000-0000-0000-0000-000000000000\",\n    \"Note\": \"Additional information\",\n    \"OrderType\": \"orderCargoReturn\",\n    \"RecipientSettlement\": \"00000000-0000-0000-0000-000000000000\",\n    \"RecipientSettlementStreet\": \"00000000-0000-0000-0000-000000000000\",\n    \"BuildingNumber\": \"4\",\n    \"NoteAddressRecipient\": \"2\"\n  }\n}\n```\n</details>\n\n<details>\n<summary><b>Повернення на нове відділення</b></summary>\n\nНеобхідно вказати ідентифікатор відділення для повернення. Ідентифікатор повертається у відповіді методу CheckPossibilityCreateReturn.\n\n**Приклад:**\n```json\n{\n  \"apiKey\": \"[ВАШ КЛЮЧ]\",\n  \"modelName\": \"AdditionalServiceGeneral\",\n  \"calledMethod\": \"save\",\n  \"methodProperties\": {\n    \"IntDocNumber\": \"206004560074695\",\n    \"PaymentMethod\": \"Cash\",\n    \"Reason\": \"00000000-0000-0000-0000-000000000000\",\n    \"SubtypeReason\": \"00000000-0000-0000-0000-000000000000\",\n    \"Note\": \"Additional information\",\n    \"OrderType\": \"orderCargoReturn\",\n    \"RecipientWarehouse\": \"00000000-0000-0000-0000-000000000000\"\n  }\n}\n```\n</details>\n\nВідповідь однакова у всіх випадках.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveReturnXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveReturnXmlResponse"}}}}}}}},"components":{"schemas":{"SaveReturnXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveReturnXmlMethodProperties"}}},"SaveReturnXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveReturnMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["BuildingNumber","RecipientSettlement","RecipientWarehouse","IntDocNumber","PaymentMethod","Reason","SubtypeReason","OrderType","ReturnAddressRef","RecipientSettlementStreet"],"properties":{"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Параметр використовується для повернення на нову адресу"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Коментар до адреси  (квартира, поверх, під'їзд тощо). Параметр використовується для повернення на нову адресу"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор населеного пункту отримувача. Параметр використовується для повернення на нову адресу"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відділення для повернення (дані з відповіді методу CheckPossibilityCreateReturn). Параметр використовується для повернення на нове відділення"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"Reason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини повернення"},"SubtypeReason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини повернення"},"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","maxLength":36,"description":"Константа — orderCargoReturn"},"ReturnAddressRef":{"type":"string","maxLength":36,"description":"Адреса для повернення (дані з відповіді методу CheckPossibilityCreateReturn). Параметр використовується для повернення на адресу відправника"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Вулиця отримувача. Параметр використовується для повернення на нову адресу"}}},"SaveReturnXmlResponse":{"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/SaveReturnXmlItem"}},"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"}}}}},"SaveReturnXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveReturnItem"}],"xml":{"name":"item"}},"SaveReturnItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на повернення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"}}}}}}
````

## Редагувати створене повернення (JSON)

> Метод \*\*update\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*). Цей метод дозволяє редагувати вже створену заявку на повернення відправлення.\
> \
> Редагувати можна, лише якщо статус замовлення \`OrderStatus = "Прийняте"\`. Клієнт передає ідентифікатор створеного замовлення (\`Ref\`) та параметри, які необхідно відредагувати.\
> \
> \<details>\
> \<summary>\<b>Варіанти редагування адреси повернення\</b>\</summary>\
> \
> \* \*\*Редагування замовлення до нового відділення:\*\* Клієнт може змінить відділення, до якого буде здійснюватися повернення. Для цього необхідно передати новий ідентифікатор відділення у параметрі \`RecipientWarehouse\`. Цей параметр використовується для зазначення нового місця доставки відправлення у межах мережі відділень.\
> \* \*\*Редагування замовлення до нової адреси:\*\* Клієнт може змінить адресу, до якої буде здійснюватися повернення. Для цього необхідно передати нові значення для параметрів \`RecipientSettlement\`, \`RecipientSettlementStreet\`, \`BuildingNumber\` та інших, що стосуються адреси. Цей параметр використовується для зазначення нового місця доставки відправлення поза межами стандартних відділень, наприклад, на домашню або офісну адресу.\
> \
> В обох випадках клієнт також може передавати інші параметри, які необхідно відредагувати, зокрема \`PaymentMethod\`, \`Reason\`, \`SubtypeReason\` тощо. У відповіді надається інформація щодо ціноутворення та запланованої дати доставки для відредагованого замовлення на повернення.\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"updateReturnJson","summary":"Редагувати створене повернення (JSON)","description":"Метод **update** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**). Цей метод дозволяє редагувати вже створену заявку на повернення відправлення.\n\nРедагувати можна, лише якщо статус замовлення `OrderStatus = \"Прийняте\"`. Клієнт передає ідентифікатор створеного замовлення (`Ref`) та параметри, які необхідно відредагувати.\n\n<details>\n<summary><b>Варіанти редагування адреси повернення</b></summary>\n\n* **Редагування замовлення до нового відділення:** Клієнт може змінить відділення, до якого буде здійснюватися повернення. Для цього необхідно передати новий ідентифікатор відділення у параметрі `RecipientWarehouse`. Цей параметр використовується для зазначення нового місця доставки відправлення у межах мережі відділень.\n* **Редагування замовлення до нової адреси:** Клієнт може змінить адресу, до якої буде здійснюватися повернення. Для цього необхідно передати нові значення для параметрів `RecipientSettlement`, `RecipientSettlementStreet`, `BuildingNumber` та інших, що стосуються адреси. Цей параметр використовується для зазначення нового місця доставки відправлення поза межами стандартних відділень, наприклад, на домашню або офісну адресу.\n\nВ обох випадках клієнт також може передавати інші параметри, які необхідно відредагувати, зокрема `PaymentMethod`, `Reason`, `SubtypeReason` тощо. У відповіді надається інформація щодо ціноутворення та запланованої дати доставки для відредагованого замовлення на повернення.\n\n</details>\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateReturnJsonResponse"}}}}}}}},"components":{"schemas":{"UpdateReturnJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateReturnMethodProperties"}}},"UpdateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","IntDocNumber","PaymentMethod","BuildingNumber","OrderType","Reason","SubtypeReason"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеного замовлення"},"OnlyGetPricing":{"type":"boolean","description":"Опціональний параметр, який використовується для отримання тільки цінової інформації"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста. Параметр використовується у разі редагування замовлення до нової адреси"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відділення. Параметр використовується у разі редагування замовлення до нового відділення"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці. Параметр використовується у разі редагування замовлення до нової адреси"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Параметр використовується у разі редагування замовлення до нової адреси"},"OrderType":{"type":"string","maxLength":36,"enum":["orderCargoReturn"],"description":"Тип замовлення. Константа, що завжди має значення orderCargoReturn"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Коментар до адреси (квартира, поверх, під'їзд тощо)"},"Reason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини повернення"},"SubtypeReason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини повернення"}}},"UpdateReturnJsonResponse":{"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/UpdateReturnItem"}},"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"}}}},"UpdateReturnItem":{"type":"object","additionalProperties":false,"properties":{"ScheduledDeliveryDate":{"type":"string","maxLength":36,"description":"Запланована дата та час доставки замовлення на повернення"},"Pricing":{"$ref":"#/components/schemas/PricingObject"}}},"PricingObject":{"type":"object","additionalProperties":false,"properties":{"Services":{"type":"array","description":"Масив об'єктів, що містить інформацію про окремі послуги","items":{"$ref":"#/components/schemas/PricingServiceItem"}},"Total":{"type":"string","description":"Загальна вартість послуг"},"FirstDayStorage":{"type":"string","description":"Вартість першого дня зберігання"}}},"PricingServiceItem":{"type":"object","additionalProperties":false,"properties":{"Service":{"type":"string","description":"Назва послуги"},"Cost":{"type":"number","description":"Вартість послуги"}}}}}}
```

## Редагувати створене повернення (XML)

> Метод \*\*update\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*). Цей метод дозволяє редагувати вже створену заявку на повернення відправлення.\
> \
> Редагувати можна, лише якщо статус замовлення \`OrderStatus = "Прийняте"\`. Клієнт передає ідентифікатор створеного замовлення (\`Ref\`) та параметри, які необхідно відредагувати.\
> \
> \<details>\
> \<summary>\<b>Варіанти редагування адреси повернення\</b>\</summary>\
> \
> \* \*\*Редагування замовлення до нового відділення:\*\* Клієнт може змінить відділення, до якого буде здійснюватися повернення. Для цього необхідно передати новий ідентифікатор відділення у параметрі \`RecipientWarehouse\`. Цей параметр використовується для зазначення нового місця доставки відправлення у межах мережі відділень.\
> \* \*\*Редагування замовлення до нової адреси:\*\* Клієнт може змінить адресу, до якої буде здійснюватися повернення. Для цього необхідно передати нові значення для параметрів \`RecipientSettlement\`, \`RecipientSettlementStreet\`, \`BuildingNumber\` та інших, що стосуються адреси. Цей параметр використовується для зазначення нового місця доставки відправлення поза межами стандартних відділень, наприклад, на домашню або офісну адресу.\
> \
> В обох випадках клієнт також може передавати інші параметри, які необхідно відредагувати, зокрема \`PaymentMethod\`, \`Reason\`, \`SubtypeReason\` тощо. У відповіді надається інформація щодо ціноутворення та запланованої дати доставки для відредагованого замовлення на повернення.\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"updateReturnXml","summary":"Редагувати створене повернення (XML)","description":"Метод **update** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**). Цей метод дозволяє редагувати вже створену заявку на повернення відправлення.\n\nРедагувати можна, лише якщо статус замовлення `OrderStatus = \"Прийняте\"`. Клієнт передає ідентифікатор створеного замовлення (`Ref`) та параметри, які необхідно відредагувати.\n\n<details>\n<summary><b>Варіанти редагування адреси повернення</b></summary>\n\n* **Редагування замовлення до нового відділення:** Клієнт може змінить відділення, до якого буде здійснюватися повернення. Для цього необхідно передати новий ідентифікатор відділення у параметрі `RecipientWarehouse`. Цей параметр використовується для зазначення нового місця доставки відправлення у межах мережі відділень.\n* **Редагування замовлення до нової адреси:** Клієнт може змінить адресу, до якої буде здійснюватися повернення. Для цього необхідно передати нові значення для параметрів `RecipientSettlement`, `RecipientSettlementStreet`, `BuildingNumber` та інших, що стосуються адреси. Цей параметр використовується для зазначення нового місця доставки відправлення поза межами стандартних відділень, наприклад, на домашню або офісну адресу.\n\nВ обох випадках клієнт також може передавати інші параметри, які необхідно відредагувати, зокрема `PaymentMethod`, `Reason`, `SubtypeReason` тощо. У відповіді надається інформація щодо ціноутворення та запланованої дати доставки для відредагованого замовлення на повернення.\n\n</details>\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateReturnXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateReturnXmlResponse"}}}}}}}},"components":{"schemas":{"UpdateReturnXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["update"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateReturnXmlMethodProperties"}}},"UpdateReturnXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/UpdateReturnMethodProperties"}],"xml":{"name":"methodProperties"}},"UpdateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","IntDocNumber","PaymentMethod","BuildingNumber","OrderType","Reason","SubtypeReason"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеного замовлення"},"OnlyGetPricing":{"type":"boolean","description":"Опціональний параметр, який використовується для отримання тільки цінової інформації"},"RecipientSettlement":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) міста. Параметр використовується у разі редагування замовлення до нової адреси"},"RecipientWarehouse":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) відділення. Параметр використовується у разі редагування замовлення до нового відділення"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"RecipientSettlementStreet":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) вулиці. Параметр використовується у разі редагування замовлення до нової адреси"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"BuildingNumber":{"type":"string","maxLength":36,"description":"Номер будинку. Параметр використовується у разі редагування замовлення до нової адреси"},"OrderType":{"type":"string","maxLength":36,"enum":["orderCargoReturn"],"description":"Тип замовлення. Константа, що завжди має значення orderCargoReturn"},"NoteAddressRecipient":{"type":"string","maxLength":36,"description":"Коментар до адреси (квартира, поверх, під'їзд тощо)"},"Reason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини повернення"},"SubtypeReason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини повернення"}}},"UpdateReturnXmlResponse":{"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/UpdateReturnXmlItem"}},"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"}}}}},"UpdateReturnXmlItem":{"allOf":[{"$ref":"#/components/schemas/UpdateReturnItem"}],"xml":{"name":"item"}},"UpdateReturnItem":{"type":"object","additionalProperties":false,"properties":{"ScheduledDeliveryDate":{"type":"string","maxLength":36,"description":"Запланована дата та час доставки замовлення на повернення"},"Pricing":{"$ref":"#/components/schemas/PricingObject"}}},"PricingObject":{"type":"object","additionalProperties":false,"properties":{"Services":{"type":"array","description":"Масив об'єктів, що містить інформацію про окремі послуги","items":{"$ref":"#/components/schemas/PricingServiceItem"}},"Total":{"type":"string","description":"Загальна вартість послуг"},"FirstDayStorage":{"type":"string","description":"Вартість першого дня зберігання"}}},"PricingServiceItem":{"type":"object","additionalProperties":false,"properties":{"Service":{"type":"string","description":"Назва послуги"},"Cost":{"type":"number","description":"Вартість послуги"}}}}}}
```

## Отримати список повернень (JSON)

> Метод \*\*getReturnOrdersList\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список заявок на повернення.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"getReturnOrdersListJson","summary":"Отримати список повернень (JSON)","description":"Метод **getReturnOrdersList** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список заявок на повернення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnOrdersListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnOrdersListJsonResponse"}}}}}}}},"components":{"schemas":{"GetReturnOrdersListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getReturnOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetReturnOrdersListMethodProperties"}}},"GetReturnOrdersListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на повернення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"},"BeginDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «З» у форматі дд.мм.рррр"},"EndDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «ДО» у форматі дд.мм.рррр"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Limit":{"type":"string","maxLength":36,"description":"Ліміт на сторінці"}}},"GetReturnOrdersListJsonResponse":{"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/ReturnOrderItem"}},"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"}}}},"ReturnOrderItem":{"type":"object","additionalProperties":false,"properties":{"OrderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"},"OrderNumber":{"type":"string","maxLength":36,"description":"Номер заявки на повернення"},"OrderStatus":{"type":"string","maxLength":36,"description":"Статус заявки"},"DocumentNumber":{"type":"string","maxLength":36,"description":"Номер документа, на основі якого створено заявку"},"CounterpartyRecipient":{"type":"string","maxLength":36,"description":"Контрагент, що буде отримувачем в експрес-накладній (ЕН) повернення"},"ContactPersonRecipient":{"type":"string","maxLength":36,"description":"Контактна особа, що буде отримувачем в експрес-накладній (ЕН) повернення"},"AddressRecipient":{"type":"string","maxLength":36,"description":"Адреса, на яку буде оформлено експрес-накладну (ЕН) повернення"},"DeliveryCost":{"type":"string","maxLength":36,"description":"Вартість експрес-накладної (ЕН) повернення (якщо створено ЕН)"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Розрахункова дата доставки повернення (якщо створено ЕН)"},"ExpressWaybillNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної (ЕН) повернення (якщо створено ЕН)"},"ExpressWaybillStatus":{"type":"string","maxLength":36,"description":"Статус експрес-накладної (ЕН) повернення (якщо створено ЕН)"}}}}}}
```

## Отримати список повернень (XML)

> Метод \*\*getReturnOrdersList\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список заявок на повернення.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"getReturnOrdersListXml","summary":"Отримати список повернень (XML)","description":"Метод **getReturnOrdersList** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список заявок на повернення.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetReturnOrdersListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetReturnOrdersListXmlResponse"}}}}}}}},"components":{"schemas":{"GetReturnOrdersListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getReturnOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetReturnOrdersListXmlMethodProperties"}}},"GetReturnOrdersListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetReturnOrdersListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetReturnOrdersListMethodProperties":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на повернення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"},"BeginDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «З» у форматі дд.мм.рррр"},"EndDate":{"type":"string","maxLength":36,"description":"Дата створення заявки «ДО» у форматі дд.мм.рррр"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Limit":{"type":"string","maxLength":36,"description":"Ліміт на сторінці"}}},"GetReturnOrdersListXmlResponse":{"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/ReturnOrderXmlItem"}},"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"}}}}},"ReturnOrderXmlItem":{"allOf":[{"$ref":"#/components/schemas/ReturnOrderItem"}],"xml":{"name":"item"}},"ReturnOrderItem":{"type":"object","additionalProperties":false,"properties":{"OrderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"},"OrderNumber":{"type":"string","maxLength":36,"description":"Номер заявки на повернення"},"OrderStatus":{"type":"string","maxLength":36,"description":"Статус заявки"},"DocumentNumber":{"type":"string","maxLength":36,"description":"Номер документа, на основі якого створено заявку"},"CounterpartyRecipient":{"type":"string","maxLength":36,"description":"Контрагент, що буде отримувачем в експрес-накладній (ЕН) повернення"},"ContactPersonRecipient":{"type":"string","maxLength":36,"description":"Контактна особа, що буде отримувачем в експрес-накладній (ЕН) повернення"},"AddressRecipient":{"type":"string","maxLength":36,"description":"Адреса, на яку буде оформлено експрес-накладну (ЕН) повернення"},"DeliveryCost":{"type":"string","maxLength":36,"description":"Вартість експрес-накладної (ЕН) повернення (якщо створено ЕН)"},"EstimatedDeliveryDate":{"type":"string","maxLength":36,"description":"Розрахункова дата доставки повернення (якщо створено ЕН)"},"ExpressWaybillNumber":{"type":"string","maxLength":36,"description":"Номер експрес-накладної (ЕН) повернення (якщо створено ЕН)"},"ExpressWaybillStatus":{"type":"string","maxLength":36,"description":"Статус експрес-накладної (ЕН) повернення (якщо створено ЕН)"}}}}}}
```

## Розрахувати повернення (JSON)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*). Цей метод дозволяє здійснити розрахунок повернення.\
> Запит майже ідентичний до створення заявки на повернення, відмінність тільки в тому, що використовується параметр \`OnlyGetPricing\` із значенням «1». Метод доступний лише для клієнтів-відправників.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"calculateReturnJson","summary":"Розрахувати повернення (JSON)","description":"Метод **save** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**). Цей метод дозволяє здійснити розрахунок повернення.\nЗапит майже ідентичний до створення заявки на повернення, відмінність тільки в тому, що використовується параметр `OnlyGetPricing` із значенням «1». Метод доступний лише для клієнтів-відправників.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateReturnJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateReturnJsonResponse"}}}}}}}},"components":{"schemas":{"CalculateReturnJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CalculateReturnMethodProperties"}}},"CalculateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["OrderType","ReturnAddressRef","IntDocNumber","PaymentMethod","Reason","OnlyGetPricing","SubtypeReason"],"properties":{"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","maxLength":36,"description":"Константа — orderCargoReturn"},"ReturnAddressRef":{"type":"string","maxLength":36,"description":"Адреса для повернення (дані з відповіді методу CheckPossibilityCreateReturn)"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"Reason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини повернення"},"OnlyGetPricing":{"type":"integer","description":"Параметр, що визначає дію: розрахунок (1) або створення замовлення (0)"},"SubtypeReason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини"}}},"CalculateReturnJsonResponse":{"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/CalculateReturnItem"}},"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"}}}},"CalculateReturnItem":{"type":"object","additionalProperties":false,"properties":{"ScheduledDeliveryDate":{"type":"string","maxLength":36,"description":"Запланована дата доставки повернення у форматі YYYY-MM-DD HH:MM:SS"},"Pricing":{"$ref":"#/components/schemas/PricingObject"}}},"PricingObject":{"type":"object","additionalProperties":false,"description":"Об'єкт, що містить інформацію про вартість послуг","properties":{"Services":{"type":"array","description":"Масив з двох об'єктів, що містить перелік послуг та їхню вартість","items":{"$ref":"#/components/schemas/ReturnServiceItem"}},"Total":{"type":"number","description":"Загальна вартість усіх послуг"},"FirstDayStorage":{"type":"string","description":"Інформація про перший день зберігання"}}},"ReturnServiceItem":{"type":"object","additionalProperties":false,"properties":{"Service":{"type":"string","description":"Назва послуги"},"Cost":{"type":"number","description":"Вартість послуги"}}}}}}
```

## Розрахувати повернення (XML)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* (або \*\*AdditionalService\*\*). Цей метод дозволяє здійснити розрахунок повернення.\
> Запит майже ідентичний до створення заявки на повернення, відмінність тільки в тому, що використовується параметр \`OnlyGetPricing\` із значенням «1». Метод доступний лише для клієнтів-відправників.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"calculateReturnXml","summary":"Розрахувати повернення (XML)","description":"Метод **save** працює в моделі **AdditionalServiceGeneral** (або **AdditionalService**). Цей метод дозволяє здійснити розрахунок повернення.\nЗапит майже ідентичний до створення заявки на повернення, відмінність тільки в тому, що використовується параметр `OnlyGetPricing` із значенням «1». Метод доступний лише для клієнтів-відправників.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CalculateReturnXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CalculateReturnXmlResponse"}}}}}}}},"components":{"schemas":{"CalculateReturnXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CalculateReturnXmlMethodProperties"}}},"CalculateReturnXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/CalculateReturnMethodProperties"}],"xml":{"name":"methodProperties"}},"CalculateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["OrderType","ReturnAddressRef","IntDocNumber","PaymentMethod","Reason","OnlyGetPricing","SubtypeReason"],"properties":{"Note":{"type":"string","maxLength":100,"description":"Опис клієнта (необов'язково)"},"OrderType":{"type":"string","maxLength":36,"description":"Константа — orderCargoReturn"},"ReturnAddressRef":{"type":"string","maxLength":36,"description":"Адреса для повернення (дані з відповіді методу CheckPossibilityCreateReturn)"},"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер інтернет-документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"Reason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини повернення"},"OnlyGetPricing":{"type":"integer","description":"Параметр, що визначає дію: розрахунок (1) або створення замовлення (0)"},"SubtypeReason":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини"}}},"CalculateReturnXmlResponse":{"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/CalculateReturnXmlItem"}},"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"}}}}},"CalculateReturnXmlItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"ScheduledDeliveryDate":{"type":"string","maxLength":36,"description":"Запланована дата доставки повернення у форматі YYYY-MM-DD HH:MM:SS"},"Pricing":{"$ref":"#/components/schemas/PricingXmlObject"}}},"PricingXmlObject":{"type":"object","additionalProperties":false,"description":"Об'єкт, що містить інформацію про вартість послуг","xml":{"name":"Pricing"},"properties":{"Services":{"type":"array","description":"Масив з двох об'єктів, що містить перелік послуг та їхню вартість","xml":{"name":"Services","wrapped":true},"items":{"$ref":"#/components/schemas/ReturnServiceXmlItem"}},"Total":{"type":"number","description":"Загальна вартість усіх послуг"},"FirstDayStorage":{"type":"string","description":"Інформація про перший день зберігання"}}},"ReturnServiceXmlItem":{"allOf":[{"$ref":"#/components/schemas/ReturnServiceItem"}],"xml":{"name":"item"}},"ReturnServiceItem":{"type":"object","additionalProperties":false,"properties":{"Service":{"type":"string","description":"Назва послуги"},"Cost":{"type":"number","description":"Вартість послуги"}}}}}}
```

## Отримати список причин повернення (JSON)

> Метод \*\*getReturnReasons\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список доступних причин повернення.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"getReturnReasonsJson","summary":"Отримати список причин повернення (JSON)","description":"Метод **getReturnReasons** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список доступних причин повернення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsJsonResponse"}}}}}}}},"components":{"schemas":{"GetReturnReasonsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getReturnReasons"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetReturnReasonsMethodProperties"}}},"GetReturnReasonsMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetReturnReasonsJsonResponse":{"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/GetReturnReasonsItem"}},"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"}}}},"GetReturnReasonsItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини"},"Description":{"type":"string","maxLength":100,"description":"Опис причини українською мовою"}}}}}}
```

## Отримати список причин повернення (XML)

> Метод \*\*getReturnReasons\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список доступних причин повернення.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"getReturnReasonsXml","summary":"Отримати список причин повернення (XML)","description":"Метод **getReturnReasons** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список доступних причин повернення.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsXmlResponse"}}}}}}}},"components":{"schemas":{"GetReturnReasonsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getReturnReasons"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetReturnReasonsXmlMethodProperties"}}},"GetReturnReasonsXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetReturnReasonsMethodProperties"}],"xml":{"name":"methodProperties"}},"GetReturnReasonsMethodProperties":{"type":"object","additionalProperties":false,"description":"Властивості методу (порожній об'єкт)"},"GetReturnReasonsXmlResponse":{"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/GetReturnReasonsXmlItem"}},"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"}}}}},"GetReturnReasonsXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetReturnReasonsItem"}],"xml":{"name":"item"}},"GetReturnReasonsItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини"},"Description":{"type":"string","maxLength":100,"description":"Опис причини українською мовою"}}}}}}
```

## Перевірити можливість редагування вже створеного повернення (JSON)

> Метод \*\*CheckPossibilityCreateReturn\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* і дозволяє перевірити можливість створення заявки на повернення або редагування вже створеної заявки залежно від запиту. Метод доступний лише відправнику.\
> \
> \<details>\
> \<summary>\<b>Типи адрес у відповіді (параметр Type)\</b>\</summary>\
> \
> \* \*\*OrderReturn:\*\* Поточна адреса повернення (за наявності замовлення на повернення).\
> \* \*\*CustomReturnAddress:\*\* Нестандартна адреса повернення, що не відповідає адресі відправника з експрес-накладної (здійснюється налаштування відмінної адреси повернення від адреси відправки в експрес-накладній за типами відправлення).\
> \* \*\*ExpressWaybill:\*\* Адреса відправника з експрес-накладної.\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"checkPossibilityCreateReturnJson","summary":"Перевірити можливість редагування вже створеного повернення (JSON)","description":"Метод **CheckPossibilityCreateReturn** працює в моделі **AdditionalServiceGeneral** і дозволяє перевірити можливість створення заявки на повернення або редагування вже створеної заявки залежно від запиту. Метод доступний лише відправнику.\n\n<details>\n<summary><b>Типи адрес у відповіді (параметр Type)</b></summary>\n\n* **OrderReturn:** Поточна адреса повернення (за наявності замовлення на повернення).\n* **CustomReturnAddress:** Нестандартна адреса повернення, що не відповідає адресі відправника з експрес-накладної (здійснюється налаштування відмінної адреси повернення від адреси відправки в експрес-накладній за типами відправлення).\n* **ExpressWaybill:** Адреса відправника з експрес-накладної.\n\n</details>\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnJsonResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityCreateReturnJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["CheckPossibilityCreateReturn"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnMethodProperties"}}},"CheckPossibilityCreateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","Address"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"},"Address":{"type":"string","maxLength":100,"description":"Адреса отримувача"}}},"CheckPossibilityCreateReturnJsonResponse":{"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/CheckPossibilityCreateReturnItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив додаткової інформації","items":{"$ref":"#/components/schemas/InfoItem"}},"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"}}}},"CheckPossibilityCreateReturnItem":{"type":"object","additionalProperties":false,"properties":{"NonCash":{"type":"boolean","description":"Ознака безготівкового розрахунку"},"City":{"type":"string","description":"Назва міста"},"Counterparty":{"type":"string","description":"Назва контрагента"},"Address":{"type":"string","description":"Адреса повернення"},"Phone":{"type":"string","description":"Номер телефону"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"ContactPerson":{"type":"string","description":"Контактна особа"},"Type":{"type":"string","enum":["OrderReturn","CustomReturnAddress","ExpressWaybill"],"description":"Тип адреси повернення (OrderReturn, CustomReturnAddress, ExpressWaybill)"}}},"InfoItem":{"type":"object","additionalProperties":false,"properties":{"PayerTypeDefault":{"type":"string","description":"Платник за замовчуванням"},"Number":{"type":"string","description":"Номер заявки"}}}}}}
```

## Перевірити можливість редагування вже створеного повернення (XML)

> Метод \*\*CheckPossibilityCreateReturn\*\* працює в моделі \*\*AdditionalServiceGeneral\*\* і дозволяє перевірити можливість створення заявки на повернення або редагування вже створеної заявки залежно від запиту. Метод доступний лише відправнику.\
> \
> \<details>\
> \<summary>\<b>Типи адрес у відповіді (параметр Type)\</b>\</summary>\
> \
> \* \*\*OrderReturn:\*\* Поточна адреса повернення (за наявності замовлення на повернення).\
> \* \*\*CustomReturnAddress:\*\* Нестандартна адреса повернення, що не відповідає адресі відправника з експрес-накладної (здійснюється налаштування відмінної адреси повернення від адреси відправки в експрес-накладній за типами відправлення).\
> \* \*\*ExpressWaybill:\*\* Адреса відправника з експрес-накладної.\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"checkPossibilityCreateReturnXml","summary":"Перевірити можливість редагування вже створеного повернення (XML)","description":"Метод **CheckPossibilityCreateReturn** працює в моделі **AdditionalServiceGeneral** і дозволяє перевірити можливість створення заявки на повернення або редагування вже створеної заявки залежно від запиту. Метод доступний лише відправнику.\n\n<details>\n<summary><b>Типи адрес у відповіді (параметр Type)</b></summary>\n\n* **OrderReturn:** Поточна адреса повернення (за наявності замовлення на повернення).\n* **CustomReturnAddress:** Нестандартна адреса повернення, що не відповідає адресі відправника з експрес-накладної (здійснюється налаштування відмінної адреси повернення від адреси відправки в експрес-накладній за типами відправлення).\n* **ExpressWaybill:** Адреса відправника з експрес-накладної.\n\n</details>\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnXmlResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityCreateReturnXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["CheckPossibilityCreateReturn"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityCreateReturnXmlMethodProperties"}}},"CheckPossibilityCreateReturnXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/CheckPossibilityCreateReturnMethodProperties"}],"xml":{"name":"methodProperties"}},"CheckPossibilityCreateReturnMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","Address"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) заявки на повернення"},"Address":{"type":"string","maxLength":100,"description":"Адреса отримувача"}}},"CheckPossibilityCreateReturnXmlResponse":{"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/CheckPossibilityCreateReturnXmlItem"}},"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":{"$ref":"#/components/schemas/InfoXmlItem"}},"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"}}}}},"CheckPossibilityCreateReturnXmlItem":{"allOf":[{"$ref":"#/components/schemas/CheckPossibilityCreateReturnItem"}],"xml":{"name":"element"}},"CheckPossibilityCreateReturnItem":{"type":"object","additionalProperties":false,"properties":{"NonCash":{"type":"boolean","description":"Ознака безготівкового розрахунку"},"City":{"type":"string","description":"Назва міста"},"Counterparty":{"type":"string","description":"Назва контрагента"},"Address":{"type":"string","description":"Адреса повернення"},"Phone":{"type":"string","description":"Номер телефону"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси"},"ContactPerson":{"type":"string","description":"Контактна особа"},"Type":{"type":"string","enum":["OrderReturn","CustomReturnAddress","ExpressWaybill"],"description":"Тип адреси повернення (OrderReturn, CustomReturnAddress, ExpressWaybill)"}}},"InfoXmlItem":{"allOf":[{"$ref":"#/components/schemas/InfoItem"}],"xml":{"name":"element"}},"InfoItem":{"type":"object","additionalProperties":false,"properties":{"PayerTypeDefault":{"type":"string","description":"Платник за замовчуванням"},"Number":{"type":"string","description":"Номер заявки"}}}}}}
```

## Отримати список підтипів причини повернення (JSON)

> Метод \*\*getReturnReasonsSubtypes\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список підтипів доступних причин повернення.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Return"],"operationId":"getReturnReasonsSubtypesJson","summary":"Отримати список підтипів причини повернення (JSON)","description":"Метод **getReturnReasonsSubtypes** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список підтипів доступних причин повернення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsSubtypesJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsSubtypesJsonResponse"}}}}}}}},"components":{"schemas":{"GetReturnReasonsSubtypesJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getReturnReasonsSubtypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetReturnReasonsSubtypesMethodProperties"}}},"GetReturnReasonsSubtypesMethodProperties":{"type":"object","additionalProperties":false,"required":["ReasonRef"],"properties":{"ReasonRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини зі списку причин повернення"}}},"GetReturnReasonsSubtypesJsonResponse":{"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/GetReturnReasonsSubtypesItem"}},"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"}}}},"GetReturnReasonsSubtypesItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини"},"Description":{"type":"string","maxLength":100,"description":"Опис причини українською мовою"},"ReasonRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини зі списку причин повернення"}}}}}}
```

## Отримати список підтипів причини повернення (XML)

> Метод \*\*getReturnReasonsSubtypes\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список підтипів доступних причин повернення.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Return","description":"Операції, пов'язані з поверненням відправлень"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Return"],"operationId":"getReturnReasonsSubtypesXml","summary":"Отримати список підтипів причини повернення (XML)","description":"Метод **getReturnReasonsSubtypes** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список підтипів доступних причин повернення.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsSubtypesXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetReturnReasonsSubtypesXmlResponse"}}}}}}}},"components":{"schemas":{"GetReturnReasonsSubtypesXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getReturnReasonsSubtypes"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetReturnReasonsSubtypesXmlMethodProperties"}}},"GetReturnReasonsSubtypesXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetReturnReasonsSubtypesMethodProperties"}],"xml":{"name":"methodProperties"}},"GetReturnReasonsSubtypesMethodProperties":{"type":"object","additionalProperties":false,"required":["ReasonRef"],"properties":{"ReasonRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини зі списку причин повернення"}}},"GetReturnReasonsSubtypesXmlResponse":{"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/GetReturnReasonsSubtypesXmlItem"}},"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"}}}}},"GetReturnReasonsSubtypesXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetReturnReasonsSubtypesItem"}],"xml":{"name":"item"}},"GetReturnReasonsSubtypesItem":{"type":"object","additionalProperties":false,"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) підтипу причини"},"Description":{"type":"string","maxLength":100,"description":"Опис причини українською мовою"},"ReasonRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) причини зі списку причин повернення"}}}}}}
```

### Змінити дані

## Отримати список заявок щодо зміни даних (JSON)

> Метод \*\*getChangeEWOrdersList\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список заявок щодо зміни даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"ChangeEW","description":"Операції, пов'язані зі зміною даних експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ChangeEW"],"operationId":"getChangeEWOrdersListJson","summary":"Отримати список заявок щодо зміни даних (JSON)","description":"Метод **getChangeEWOrdersList** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список заявок щодо зміни даних.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChangeEWOrdersListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChangeEWOrdersListJsonResponse"}}}}}}}},"components":{"schemas":{"GetChangeEWOrdersListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getChangeEWOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetChangeEWOrdersListMethodProperties"}}},"GetChangeEWOrdersListMethodProperties":{"type":"object","additionalProperties":false,"required":["BeginDate","EndDate","Page","Limit"],"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"BeginDate":{"type":"string","maxLength":36,"description":"Дата створення «з»"},"EndDate":{"type":"string","maxLength":36,"description":"Дата створення «до»"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці"}}},"GetChangeEWOrdersListJsonResponse":{"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/GetChangeEWOrdersListItem"}},"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"}}}},"GetChangeEWOrdersListItem":{"type":"object","additionalProperties":false,"properties":{"OrderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор замовлення"},"OrderNumber":{"type":"string","maxLength":36,"description":"Номер замовлення"},"OrderStatus":{"type":"string","maxLength":36,"description":"Статус замовлення"},"DocumentNumber":{"type":"string","maxLength":36,"description":"Номер документа"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення замовлення"},"BeforeChangeSenderCounterparty":{"type":"string","maxLength":36,"description":"Дані до зміни"},"AfterChangeChangeSenderCounterparty":{"type":"string","maxLength":36,"description":"Дані після зміни"},"Cost":{"type":"string","maxLength":36,"description":"Вартість"},"BeforeChangeSenderPhone":{"type":"string","maxLength":36,"description":"Телефон до зміни"},"AfterChangeSenderPhone":{"type":"string","maxLength":36,"description":"Телефон після зміни"}}}}}}
```

## Отримати список заявок щодо зміни даних (XML)

> Метод \*\*getChangeEWOrdersList\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє отримати список заявок щодо зміни даних.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"ChangeEW","description":"Операції, пов'язані зі зміною даних експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ChangeEW"],"operationId":"getChangeEWOrdersListXml","summary":"Отримати список заявок щодо зміни даних (XML)","description":"Метод **getChangeEWOrdersList** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє отримати список заявок щодо зміни даних.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetChangeEWOrdersListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetChangeEWOrdersListXmlResponse"}}}}}}}},"components":{"schemas":{"GetChangeEWOrdersListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getChangeEWOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetChangeEWOrdersListXmlMethodProperties"}}},"GetChangeEWOrdersListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetChangeEWOrdersListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetChangeEWOrdersListMethodProperties":{"type":"object","additionalProperties":false,"required":["BeginDate","EndDate","Page","Limit"],"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"},"BeginDate":{"type":"string","maxLength":36,"description":"Дата створення «з»"},"EndDate":{"type":"string","maxLength":36,"description":"Дата створення «до»"},"Page":{"type":"string","maxLength":36,"description":"Номер сторінки"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці"}}},"GetChangeEWOrdersListXmlResponse":{"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/GetChangeEWOrdersListXmlItem"}},"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"}}}}},"GetChangeEWOrdersListXmlItem":{"allOf":[{"$ref":"#/components/schemas/GetChangeEWOrdersListItem"}],"xml":{"name":"item"}},"GetChangeEWOrdersListItem":{"type":"object","additionalProperties":false,"properties":{"OrderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор замовлення"},"OrderNumber":{"type":"string","maxLength":36,"description":"Номер замовлення"},"OrderStatus":{"type":"string","maxLength":36,"description":"Статус замовлення"},"DocumentNumber":{"type":"string","maxLength":36,"description":"Номер документа"},"DateTime":{"type":"string","maxLength":36,"description":"Дата створення замовлення"},"BeforeChangeSenderCounterparty":{"type":"string","maxLength":36,"description":"Дані до зміни"},"AfterChangeChangeSenderCounterparty":{"type":"string","maxLength":36,"description":"Дані після зміни"},"Cost":{"type":"string","maxLength":36,"description":"Вартість"},"BeforeChangeSenderPhone":{"type":"string","maxLength":36,"description":"Телефон до зміни"},"AfterChangeSenderPhone":{"type":"string","maxLength":36,"description":"Телефон після зміни"}}}}}}
```

## Створити заявку щодо зміни даних (JSON)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє створити заявку щодо зміни даних.\
> \
> \<details>\
> \<summary>Обмеження щодо зміни даних відправника\</summary>\
> \
> \* Зміна контрагента-відправника (\`SenderCounterparty\`) не допускається.\
> \* Зміна ПІБ контактної особи відправника (\`SenderContactName\`) дозволена лише за відсутності післяплати.\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"ChangeEW","description":"Операції, пов'язані зі зміною даних експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ChangeEW"],"operationId":"saveChangeEWOrderJson","summary":"Створити заявку щодо зміни даних (JSON)","description":"Метод **save** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє створити заявку щодо зміни даних.\n\n<details>\n<summary>Обмеження щодо зміни даних відправника</summary>\n\n* Зміна контрагента-відправника (`SenderCounterparty`) не допускається.\n* Зміна ПІБ контактної особи відправника (`SenderContactName`) дозволена лише за відсутності післяплати.\n\n</details>\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveChangeEWOrderJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveChangeEWOrderJsonResponse"}}}}}}}},"components":{"schemas":{"SaveChangeEWOrderJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveChangeEWOrderMethodProperties"}}},"SaveChangeEWOrderMethodProperties":{"type":"object","additionalProperties":false,"required":["IntDocNumber","OrderType"],"properties":{"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"OrderType":{"type":"string","maxLength":36,"description":"Тип заявки"},"SenderContactName":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":37,"description":"Номер телефону відправника"},"Recipient":{"type":"string","maxLength":38,"description":"Ідентифікатор інтернет-контрагента отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientContactName":{"type":"string","maxLength":39,"description":"ПІБ контактної особи отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientPhone":{"type":"string","maxLength":40,"description":"Номер телефону отримувача (якщо замовлено отримувачем, ігнорується)"},"PayerType":{"type":"string","maxLength":41,"description":"Тип платника"}}},"SaveChangeEWOrderJsonResponse":{"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/SaveChangeEWOrderItem"}},"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"}}}},"SaveChangeEWOrderItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"}}}}}}
```

## Створити заявку щодо зміни даних (XML)

> Метод \*\*save\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє створити заявку щодо зміни даних.\
> \
> \<details>\
> \<summary>Обмеження щодо зміни даних відправника\</summary>\
> \
> \* Зміна контрагента-відправника (\`SenderCounterparty\`) не допускається.\
> \* Зміна ПІБ контактної особи відправника (\`SenderContactName\`) дозволена лише за відсутності післяплати.\
> \
> \</details><br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"ChangeEW","description":"Операції, пов'язані зі зміною даних експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ChangeEW"],"operationId":"saveChangeEWOrderXml","summary":"Створити заявку щодо зміни даних (XML)","description":"Метод **save** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє створити заявку щодо зміни даних.\n\n<details>\n<summary>Обмеження щодо зміни даних відправника</summary>\n\n* Зміна контрагента-відправника (`SenderCounterparty`) не допускається.\n* Зміна ПІБ контактної особи відправника (`SenderContactName`) дозволена лише за відсутності післяплати.\n\n</details>\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveChangeEWOrderXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveChangeEWOrderXmlResponse"}}}}}}}},"components":{"schemas":{"SaveChangeEWOrderXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["save"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveChangeEWOrderXmlMethodProperties"}}},"SaveChangeEWOrderXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveChangeEWOrderMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveChangeEWOrderMethodProperties":{"type":"object","additionalProperties":false,"required":["IntDocNumber","OrderType"],"properties":{"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер документа"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"},"OrderType":{"type":"string","maxLength":36,"description":"Тип заявки"},"SenderContactName":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":37,"description":"Номер телефону відправника"},"Recipient":{"type":"string","maxLength":38,"description":"Ідентифікатор інтернет-контрагента отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientContactName":{"type":"string","maxLength":39,"description":"ПІБ контактної особи отримувача (якщо замовлено отримувачем, ігнорується)"},"RecipientPhone":{"type":"string","maxLength":40,"description":"Номер телефону отримувача (якщо замовлено отримувачем, ігнорується)"},"PayerType":{"type":"string","maxLength":41,"description":"Тип платника"}}},"SaveChangeEWOrderXmlResponse":{"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/SaveChangeEWOrderXmlItem"}},"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"}}}}},"SaveChangeEWOrderXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveChangeEWOrderItem"}],"xml":{"name":"item"}},"SaveChangeEWOrderItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор заявки"}}}}}}
```

## Перевірити можливість зміни даних (JSON)

> Метод \*\*CheckPossibilityChangeEW\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє перевірити можливість створення заявки на зміну даних.\
> У разі успіху повертаються необхідні параметри створення заявки.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"ChangeEW","description":"Операції, пов'язані зі зміною даних експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["ChangeEW"],"operationId":"checkPossibilityChangeEWJson","summary":"Перевірити можливість зміни даних (JSON)","description":"Метод **CheckPossibilityChangeEW** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє перевірити можливість створення заявки на зміну даних.\nУ разі успіху повертаються необхідні параметри створення заявки.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityChangeEWJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckPossibilityChangeEWJsonResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityChangeEWJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["CheckPossibilityChangeEW"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityChangeEWMethodProperties"}}},"CheckPossibilityChangeEWMethodProperties":{"type":"object","additionalProperties":false,"required":["IntDocNumber"],"properties":{"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер документа, для якого буде створено заявку"}}},"CheckPossibilityChangeEWJsonResponse":{"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/CheckPossibilityChangeEWItem"}},"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"}}}},"CheckPossibilityChangeEWItem":{"type":"object","additionalProperties":false,"properties":{"CanChangeSender":{"type":"boolean","description":"Можливість зміни даних відправника"},"CanChangeRecipient":{"type":"boolean","description":"Можливість зміни даних отримувача"},"CanChangePayerTypeOrPaymentMethod":{"type":"boolean","description":"Можливість зміни даних платника або форми оплати"},"CanChangeBackwardDeliveryDocuments":{"type":"boolean","description":"Можливість зміни послуги «Зворотна доставка документів»"},"CanChangeBackwardDeliveryMoney":{"type":"boolean","description":"Можливість зміни грошового переказу"},"CanChangeCash2Card":{"type":"boolean","description":"Можливість зміни номера картки для виплати грошового переказу"},"CanChangeBackwardDeliveryOther":{"type":"boolean","description":"Можливість зміни зворотної доставки"},"CanChangeAfterpaymentType":{"type":"boolean","description":"Можливість зміни суми контролю оплати"},"CanChangeLiftingOnFloor":{"type":"boolean","description":"Можливість зміни підйому на поверх"},"CanChangeLiftingOnFloorWithElevator":{"type":"boolean","description":"Можливість зміни підйому на поверх за допомогою ліфта"},"CanChangeFillingWarranty":{"type":"boolean","description":"Можливість зміни послуги «Гарантія заповнення»"},"SenderCounterparty":{"type":"string","maxLength":36,"description":"Контрагент відправника"},"ContactPersonSender":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"RecipientCounterparty":{"type":"string","maxLength":36,"description":"Контрагент отримувача"},"ContactPersonRecipient":{"type":"string","maxLength":36,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"}}}}}}
```

## Перевірити можливість зміни даних (XML)

> Метод \*\*CheckPossibilityChangeEW\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє перевірити можливість створення заявки на зміну даних.\
> У разі успіху повертаються необхідні параметри створення заявки.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"ChangeEW","description":"Операції, пов'язані зі зміною даних експрес-накладних"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["ChangeEW"],"operationId":"checkPossibilityChangeEWXml","summary":"Перевірити можливість зміни даних (XML)","description":"Метод **CheckPossibilityChangeEW** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє перевірити можливість створення заявки на зміну даних.\nУ разі успіху повертаються необхідні параметри створення заявки.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityChangeEWXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/CheckPossibilityChangeEWXmlResponse"}}}}}}}},"components":{"schemas":{"CheckPossibilityChangeEWXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["CheckPossibilityChangeEW"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/CheckPossibilityChangeEWXmlMethodProperties"}}},"CheckPossibilityChangeEWXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/CheckPossibilityChangeEWMethodProperties"}],"xml":{"name":"methodProperties"}},"CheckPossibilityChangeEWMethodProperties":{"type":"object","additionalProperties":false,"required":["IntDocNumber"],"properties":{"IntDocNumber":{"type":"string","maxLength":36,"description":"Номер документа, для якого буде створено заявку"}}},"CheckPossibilityChangeEWXmlResponse":{"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/CheckPossibilityChangeEWXmlItem"}},"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"}}}}},"CheckPossibilityChangeEWXmlItem":{"allOf":[{"$ref":"#/components/schemas/CheckPossibilityChangeEWItem"}],"xml":{"name":"item"}},"CheckPossibilityChangeEWItem":{"type":"object","additionalProperties":false,"properties":{"CanChangeSender":{"type":"boolean","description":"Можливість зміни даних відправника"},"CanChangeRecipient":{"type":"boolean","description":"Можливість зміни даних отримувача"},"CanChangePayerTypeOrPaymentMethod":{"type":"boolean","description":"Можливість зміни даних платника або форми оплати"},"CanChangeBackwardDeliveryDocuments":{"type":"boolean","description":"Можливість зміни послуги «Зворотна доставка документів»"},"CanChangeBackwardDeliveryMoney":{"type":"boolean","description":"Можливість зміни грошового переказу"},"CanChangeCash2Card":{"type":"boolean","description":"Можливість зміни номера картки для виплати грошового переказу"},"CanChangeBackwardDeliveryOther":{"type":"boolean","description":"Можливість зміни зворотної доставки"},"CanChangeAfterpaymentType":{"type":"boolean","description":"Можливість зміни суми контролю оплати"},"CanChangeLiftingOnFloor":{"type":"boolean","description":"Можливість зміни підйому на поверх"},"CanChangeLiftingOnFloorWithElevator":{"type":"boolean","description":"Можливість зміни підйому на поверх за допомогою ліфта"},"CanChangeFillingWarranty":{"type":"boolean","description":"Можливість зміни послуги «Гарантія заповнення»"},"SenderCounterparty":{"type":"string","maxLength":36,"description":"Контрагент відправника"},"ContactPersonSender":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"SenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"RecipientCounterparty":{"type":"string","maxLength":36,"description":"Контрагент отримувача"},"ContactPersonRecipient":{"type":"string","maxLength":36,"description":"Контактна особа отримувача"},"RecipientPhone":{"type":"string","maxLength":36,"description":"Номер телефону отримувача"},"PayerType":{"type":"string","maxLength":36,"description":"Тип платника"},"PaymentMethod":{"type":"string","maxLength":36,"description":"Форма розрахунку (Cash/NonCash)"}}}}}}
```

### Видалити заявку (на переадресацію, повернення, зміну даних)

## Видалити заявку (JSON)

> Метод \*\*delete\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє видалити:\
> \* заявку на повернення;\
> \* заявку на зміну даних (можна видалити заявку лише зі статусом «Прийнято»);\
> \* заявку на переадресацію.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Requests","description":"Операції, пов'язані з керуванням заявками (повернення, переадресація, зміна даних)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["Requests"],"operationId":"deleteRequestJson","summary":"Видалити заявку (JSON)","description":"Метод **delete** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє видалити:\n* заявку на повернення;\n* заявку на зміну даних (можна видалити заявку лише зі статусом «Прийнято»);\n* заявку на переадресацію.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRequestJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRequestJsonResponse"}}}}}}}},"components":{"schemas":{"DeleteRequestJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["delete"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteRequestMethodProperties"}}},"DeleteRequestMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref"],"properties":{"Ref":{"type":"string","description":"Ідентифікатор (REF) заявки"}}},"DeleteRequestJsonResponse":{"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/DeleteRequestItem"}},"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"}}}},"DeleteRequestItem":{"type":"object","properties":{"Number":{"type":"string","description":"Номер заявки"}}}}}}
```

## Видалити заявку (XML)

> Метод \*\*delete\*\* працює в моделі \*\*AdditionalService\*\* (або \*\*AdditionalServiceGeneral\*\*) і дозволяє видалити:\
> \* заявку на повернення;\
> \* заявку на зміну даних (можна видалити заявку лише зі статусом «Прийнято»);\
> \* заявку на переадресацію.<br>

```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Additional Services","version":"2.0.0"},"tags":[{"name":"Requests","description":"Операції, пов'язані з керуванням заявками (повернення, переадресація, зміна даних)"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["Requests"],"operationId":"deleteRequestXml","summary":"Видалити заявку (XML)","description":"Метод **delete** працює в моделі **AdditionalService** (або **AdditionalServiceGeneral**) і дозволяє видалити:\n* заявку на повернення;\n* заявку на зміну даних (можна видалити заявку лише зі статусом «Прийнято»);\n* заявку на переадресацію.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteRequestXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteRequestXmlResponse"}}}}}}}},"components":{"schemas":{"DeleteRequestXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["AdditionalService","AdditionalServiceGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["delete"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteRequestXmlMethodProperties"}}},"DeleteRequestXmlMethodProperties":{"type":"object","additionalProperties":false,"xml":{"name":"methodProperties"},"required":["Ref"],"properties":{"Ref":{"type":"string","description":"Ідентифікатор (REF) заявки"}}},"DeleteRequestXmlResponse":{"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/DeleteRequestXmlItem"}},"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"}}}}},"DeleteRequestXmlItem":{"allOf":[{"$ref":"#/components/schemas/DeleteRequestItem"}]},"DeleteRequestItem":{"type":"object","properties":{"Number":{"type":"string","description":"Номер заявки"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/dodatkovi-poslugi.md?ask=<question>&goal=<endgoal>
```

`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.