> 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/viklik-kuryera.md).
# Виклик кур'єра
:link:[Початок роботи з API](https://api-portal.novapost.com/api-docs-ua)
### Cписки заявок на виклик кур'єра
## Отримати список заявок на виклик кур’єра (JSON)
> Метод \*\*getOrdersListCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> Цей метод дозволяє отримати перелік створених заявок на виклик кур’єра.\
> Відображаються заявки із будь-яким статусом. Термін відображення заявок — 7 днів із дати створення.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Courier Call Service","version":"2.0.0"},"tags":[{"name":"CourierCall"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/json":{"post":{"tags":["CourierCall"],"summary":"Отримати список заявок на виклик кур’єра (JSON)","description":"Метод **getOrdersListCourierCall** працює в моделі **CarCallGeneral**.\nЦей метод дозволяє отримати перелік створених заявок на виклик кур’єра.\nВідображаються заявки із будь-яким статусом. Термін відображення заявок — 7 днів із дати створення.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string"},"calledMethod":{"type":"string"},"methodProperties":{"type":"object","description":"Порожній об'єкт параметрів"}}}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список заявок на виклик кур'єра","items":{"$ref":"#/components/schemas/CourierCallOrderItem"}},"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"}}}}}}}}}}},"components":{"schemas":{"CourierCallOrderItem":{"type":"object","properties":{"TimeIntervalDescription":{"type":"string","maxLength":36,"description":"Значення часового інтервалу"},"SenderDescription":{"type":"string","maxLength":36,"description":"Ініціали відправника"},"Status":{"type":"string","maxLength":36,"description":"Код статусу наявних заявок на виклик кур’єра:\n* `Done` — «Виконано»\n* `Rejection` — «Відмова клієнта»\n* `NotDone` — «Не виконано»\n* `ReadyToDone` — «Готово до виконання»\n* `InProcessing` — «В обробці»\n* `ClientNotFormalized` — «Недооформлено клієнтом»\n* `RejectionWithPayment` — «Відмова клієнта (з оплатою)»\n"},"DateTime":{"type":"string","maxLength":36,"description":"Дата вибраного часового інтервалу"},"FactualWeight":{"type":"number","format":"double","description":"Фактична вага"},"ContactSenderDescription":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"AggregatedOrderInfo":{"type":"array","description":"Агреговані дані посилки","items":{"$ref":"#/components/schemas/AggregatedOrderInfoItem"}},"AvailableActions":{"type":"array","description":"Доступні для керування дії","items":{"$ref":"#/components/schemas/AvailableActionItem"}},"SenderAddressDescription":{"type":"string","maxLength":36,"description":"Адреса відправника"},"ContactSenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"StatusDescription":{"type":"string","maxLength":36,"description":"Опис статусу заявок на виклик кур’єра"},"SenderSettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста пункту відправлення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"TimeInterval":{"type":"string","maxLength":36,"description":"Часовий інтервал (для замовлення послуги «Часові інтервали»)"},"PlanedWeight":{"type":"number","format":"double","description":"Планова вага"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}},"AggregatedOrderInfoItem":{"type":"object","properties":{"ParcelsAmount":{"type":"integer","description":"Загальна кількість посилок"},"ParcelsAmountByCargoType":{"$ref":"#/components/schemas/ParcelsAmountByCargoType"},"SeatsAmount":{"type":"integer","description":"Кількість місць"}}},"ParcelsAmountByCargoType":{"type":"object","properties":{"Documents":{"type":"integer","description":"Кількість документів"},"Parcel":{"type":"integer","description":"Кількість посылок"},"Cargo":{"type":"integer","description":"Кількість вантажів"},"Pallet":{"type":"integer","description":"Кількість палет"},"TiresWheels":{"type":"integer","description":"Кількість шин/дисків"}}},"AvailableActionItem":{"type":"object","properties":{"CanCancel":{"type":"boolean","description":"Можливість скасування заявки"},"CanEdit":{"type":"boolean","description":"Можливість редагування заявки"}}}}}}
```
## Отримати список заявок на виклик кур’єра (XML)
> Метод \*\*getOrdersListCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> Цей метод дозволяє отримати перелік створених заявок на виклик кур’єра.\
> Відображаються заявки із будь-яким статусом. Термін відображення заявок — 7 днів із дати створення.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Courier Call Service","version":"2.0.0"},"tags":[{"name":"CourierCall"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/xml":{"post":{"tags":["CourierCall"],"summary":"Отримати список заявок на виклик кур’єра (XML)","description":"Метод **getOrdersListCourierCall** працює в моделі **CarCallGeneral**.\nЦей метод дозволяє отримати перелік створених заявок на виклик кур’єра.\nВідображаються заявки із будь-яким статусом. Термін відображення заявок — 7 днів із дати створення.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача","xml":{"name":"apiKey"}},"modelName":{"type":"string","xml":{"name":"modelName"}},"calledMethod":{"type":"string","xml":{"name":"calledMethod"}},"methodProperties":{"type":"object","xml":{"name":"methodProperties"}}}}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список заявок на виклик кур'єра","items":{"$ref":"#/components/schemas/CourierCallOrderItem"}},"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"}}}}}}}}}}},"components":{"schemas":{"CourierCallOrderItem":{"type":"object","properties":{"TimeIntervalDescription":{"type":"string","maxLength":36,"description":"Значення часового інтервалу"},"SenderDescription":{"type":"string","maxLength":36,"description":"Ініціали відправника"},"Status":{"type":"string","maxLength":36,"description":"Код статусу наявних заявок на виклик кур’єра:\n* `Done` — «Виконано»\n* `Rejection` — «Відмова клієнта»\n* `NotDone` — «Не виконано»\n* `ReadyToDone` — «Готово до виконання»\n* `InProcessing` — «В обробці»\n* `ClientNotFormalized` — «Недооформлено клієнтом»\n* `RejectionWithPayment` — «Відмова клієнта (з оплатою)»\n"},"DateTime":{"type":"string","maxLength":36,"description":"Дата вибраного часового інтервалу"},"FactualWeight":{"type":"number","format":"double","description":"Фактична вага"},"ContactSenderDescription":{"type":"string","maxLength":36,"description":"Контактна особа відправника"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"AggregatedOrderInfo":{"type":"array","description":"Агреговані дані посилки","items":{"$ref":"#/components/schemas/AggregatedOrderInfoItem"}},"AvailableActions":{"type":"array","description":"Доступні для керування дії","items":{"$ref":"#/components/schemas/AvailableActionItem"}},"SenderAddressDescription":{"type":"string","maxLength":36,"description":"Адреса відправника"},"ContactSenderPhone":{"type":"string","maxLength":36,"description":"Номер телефону відправника"},"StatusDescription":{"type":"string","maxLength":36,"description":"Опис статусу заявок на виклик кур’єра"},"SenderSettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста пункту відправлення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"TimeInterval":{"type":"string","maxLength":36,"description":"Часовий інтервал (для замовлення послуги «Часові інтервали»)"},"PlanedWeight":{"type":"number","format":"double","description":"Планова вага"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}},"AggregatedOrderInfoItem":{"type":"object","properties":{"ParcelsAmount":{"type":"integer","description":"Загальна кількість посилок"},"ParcelsAmountByCargoType":{"$ref":"#/components/schemas/ParcelsAmountByCargoType"},"SeatsAmount":{"type":"integer","description":"Кількість місць"}}},"ParcelsAmountByCargoType":{"type":"object","properties":{"Documents":{"type":"integer","description":"Кількість документів"},"Parcel":{"type":"integer","description":"Кількість посылок"},"Cargo":{"type":"integer","description":"Кількість вантажів"},"Pallet":{"type":"integer","description":"Кількість палет"},"TiresWheels":{"type":"integer","description":"Кількість шин/дисків"}}},"AvailableActionItem":{"type":"object","properties":{"CanCancel":{"type":"boolean","description":"Можливість скасування заявки"},"CanEdit":{"type":"boolean","description":"Можливість редагування заявки"}}}}}}
```
## Отримати список заявок на виклик кур’єра з фільтрацією (JSON)
> Метод \*\*getOrdersListCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> Цей метод дозволяє отримати перелік заявок на виклик кур’єра. Щоб переглянути окремі елементи переліку, здійснюється пошук за визначеними фільтрами.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Courier Call Service","version":"2.0.0"},"tags":[{"name":"CourierCall"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/json":{"post":{"tags":["CourierCall"],"summary":"Отримати список заявок на виклик кур’єра з фільтрацією (JSON)","description":"Метод **getOrdersListCourierCall** працює в моделі **CarCallGeneral**.\nЦей метод дозволяє отримати перелік заявок на виклик кур’єра. Щоб переглянути окремі елементи переліку, здійснюється пошук за визначеними фільтрами.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string"},"calledMethod":{"type":"string"},"methodProperties":{"type":"object","required":["StatusCode","ContactSenderPhone","DateTime","Page","Limit","SenderRef","Number","PreferredDeliveryDate"],"properties":{"StatusCode":{"type":"string","maxLength":255,"description":"Код статусу наявних заявок на виклик кур’єра.\nВаріанти значень:\nDone — «Виконано»;\nRejection — «Відмова клієнта»;\nNotDone — «Не виконано»;\nReadyToDone — «Готово до виконання»;\nInProcessing — «В обробці»;\nClientNotFormalized — «Недооформлено клієнтом»;\nRejectionWithPayment — «Відмова клієнта (з оплатою)».\n"},"ContactSenderPhone":{"type":"string","maxLength":12,"description":"Номер телефону відправника"},"DateTime":{"type":"string","maxLength":36,"description":"Дата заявок на виклик кур'єра"},"Page":{"type":"string","maxLength":36,"description":"Сторінка (працює разом із параметром Limit)"},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці (працює разом із параметром Page)"},"SenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента-відправника"},"Number":{"type":"string","maxLength":12,"description":"Номер заявки на виклик кур’єра"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список заявок на виклик кур'єра","items":{"$ref":"#/components/schemas/CourierCallOrderItem"}},"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"}}}}}}}}}}},"components":{"schemas":{"CourierCallOrderItem":{"type":"object","properties":{"StatusDescription":{"type":"string","maxLength":36,"description":"Опис статусу наявних заявок на виклик кур’єра"},"SenderSettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста пункту відправлення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"TimeInterval":{"type":"string","maxLength":36,"description":"Часовий інтервал (для замовлення послуги «Часові інтервали»)"},"PlanedWeight":{"type":"string","maxLength":10,"description":"Планова вага"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}}}}}
```
## Отримати список заявок на виклик кур’єра з фільтрацією (XML)
> Метод \*\*getOrdersListCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> Цей метод дозволяє отримати перелік заявок на виклик кур’єра. Щоб переглянути окремі елементи переліку, здійснюється пошук за визначеними фільтрами.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post — Courier Call Service","version":"2.0.0"},"tags":[{"name":"CourierCall"}],"servers":[{"description":"production","url":"https://api.novaposhta.ua/v2.0"}],"paths":{"/xml":{"post":{"tags":["CourierCall"],"summary":"Отримати список заявок на виклик кур’єра з фільтрацією (XML)","description":"Метод **getOrdersListCourierCall** працює в моделі **CarCallGeneral**.\nЦей метод дозволяє отримати перелік заявок на виклик кур’єра. Щоб переглянути окремі елементи переліку, здійснюється пошук за визначеними фільтрами.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"type":"object","xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача","xml":{"name":"apiKey"}},"modelName":{"type":"string","xml":{"name":"modelName"}},"calledMethod":{"type":"string","xml":{"name":"calledMethod"}},"methodProperties":{"type":"object","xml":{"name":"methodProperties"},"required":["StatusCode","ContactSenderPhone","DateTime","Page","Limit","SenderRef","Number","PreferredDeliveryDate"],"properties":{"StatusCode":{"type":"string","maxLength":255,"description":"Код статусу наявних заявок на виклик кур’єра.\nВаріанти значень:\nDone — «Виконано»;\nRejection — «Відмова клієнта»;\nNotDone — «Не виконано»;\nReadyToDone — «Готово до виконання»;\nInProcessing — «В обробці»;\nClientNotFormalized — «Недооформлено клієнтом»;\nRejectionWithPayment — «Відмова клієнта (з оплатою)».\n","xml":{"name":"StatusCode"}},"ContactSenderPhone":{"type":"string","maxLength":12,"description":"Номер телефону відправника","xml":{"name":"ContactSenderPhone"}},"DateTime":{"type":"string","maxLength":36,"description":"Дата заявок","xml":{"name":"DateTime"}},"Page":{"type":"string","maxLength":36,"description":"Сторінка","xml":{"name":"Page"}},"Limit":{"type":"string","maxLength":36,"description":"Кількість записів на сторінці","xml":{"name":"Limit"}},"SenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента-відправника","xml":{"name":"SenderRef"}},"Number":{"type":"string","maxLength":12,"description":"Номер заявки","xml":{"name":"Number"}},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки","xml":{"name":"PreferredDeliveryDate"}}}}}}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"type":"object","required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Список заявок на виклик кур'єра","items":{"$ref":"#/components/schemas/CourierCallOrderItem"}},"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"}}}}}}}}}}},"components":{"schemas":{"CourierCallOrderItem":{"type":"object","properties":{"StatusDescription":{"type":"string","maxLength":36,"description":"Опис статусу наявних заявок на виклик кур’єра"},"SenderSettlementRef":{"type":"string","maxLength":36,"description":"Ідентифікатор міста пункту відправлення"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"TimeInterval":{"type":"string","maxLength":36,"description":"Часовий інтервал (для замовлення послуги «Часові інтервали»)"},"PlanedWeight":{"type":"string","maxLength":10,"description":"Планова вага"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}}}}}
```
### Робота із заявками на виклик кур'єра
## Додати документи до заявки на виклик кур’єра (JSON)
> Метод \*\*insertDocuments\*\* працює в моделі \*\*CarCallGeneral\*\*\*.\
> \
> Цей метод дозволяє додавати до заявки на виклик кур’єра інтернет-документи (ІД), які будуть передані кур'єру. Підтримуються два варіанти додавання: по одному документу або масово. Основна логіка методу залишається однаковою, змінюється лише кількість доданих документів.\
> \
> \\
> \\Детальні умови додавання документів\\
\
> \
> До заявки можливо додавати ІД від:\
> \* різних контрагентів, які працюють в одному корпоративному кабінеті (один логін);\
> \* одного контрагента, але відправлення створюються з різних кабінетів від різних контактних осіб цього контрагента.\
> \
> Додавання інтернет-документів до заявки доступне в таких випадках:\
> \* Заявка на виклик кур’єра має статус «Готово до виконання».\
> \* Адреса відправника в ІД співпадає із адресою відправки у заявці на виклик кур’єра до вулиці та номеру будинку включно.\
> \* Для заявки на виклик кур’єра ще не минули вказані дата та часовий інтервал (ЧІ).\
> \* Кур’єр на адресі відправника, але ще не підтвердив кількість та вагу відправлень у заявці.\
> \* Якщо до закінчення ЧІ залишилось більше 2 годин — без обмежень за вагою в інтернет-документах.\
> \* Якщо до закінчення ЧІ залишилось менше 2 годин — вага в інтернет-документі, який необхідно додати, не повинна перевищувати 20% від планової ваги у заявці.\
> \
> \ \
> \
> \*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*).
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CarCall"],"operationId":"insertDocumentsJson","summary":"Додати документи до заявки на виклик кур’єра (JSON)","description":"Метод **insertDocuments** працює в моделі **CarCallGeneral***.\n\nЦей метод дозволяє додавати до заявки на виклик кур’єра інтернет-документи (ІД), які будуть передані кур'єру. Підтримуються два варіанти додавання: по одному документу або масово. Основна логіка методу залишається однаковою, змінюється лише кількість доданих документів.\n\n\nДетальні умови додавання документів
\n\nДо заявки можливо додавати ІД від:\n* різних контрагентів, які працюють в одному корпоративному кабінеті (один логін);\n* одного контрагента, але відправлення створюються з різних кабінетів від різних контактних осіб цього контрагента.\n\nДодавання інтернет-документів до заявки доступне в таких випадках:\n* Заявка на виклик кур’єра має статус «Готово до виконання».\n* Адреса відправника в ІД співпадає із адресою відправки у заявці на виклик кур’єра до вулиці та номеру будинку включно.\n* Для заявки на виклик кур’єра ще не минули вказані дата та часовий інтервал (ЧІ).\n* Кур’єр на адресі відправника, але ще не підтвердив кількість та вагу відправлень у заявці.\n* Якщо до закінчення ЧІ залишилось більше 2 годин — без обмежень за вагою в інтернет-документах.\n* Якщо до закінчення ЧІ залишилось менше 2 годин — вага в інтернет-документі, який необхідно додати, не повинна перевищувати 20% від планової ваги у заявці.\n\n \n\n*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод **getEWTemplateList** моделі **InternetDocument**).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsertDocumentsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsertDocumentsResponse"}}}}}}}},"components":{"schemas":{"InsertDocumentsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["insertDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/InsertDocumentsMethodProperties"}}},"InsertDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["LinkedDocuments","Number"],"properties":{"LinkedDocuments":{"type":"array","description":"Інтернет-документи, що передаються кур’єру в рамках цієї заявки","items":{"type":"string","maxLength":36}},"Number":{"type":"string","maxLength":12,"description":"Номер заявки на виклик кур’єра"}}},"InsertDocumentsResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів виконання запиту","items":{"$ref":"#/components/schemas/InsertDocumentsItem"}},"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"}}}},"InsertDocumentsItem":{"type":"object","additionalProperties":false,"properties":{"succeeded":{"type":"array","description":"Номер доданого документа до заявки на виклик кур’єра","items":{"type":"string","maxLength":36}},"Barcode":{"type":"string","maxLength":36,"description":"Номер створеної заявки на виклик кур’єра"}}}}}}
```
## Додати документи до заявки на виклик кур’єра (XML)
> Метод \*\*insertDocuments\*\* працює в моделі \*\*CarCallGeneral\*\*\*.\
> \
> Цей метод дозволяє додавати до заявки на виклик кур’єра інтернет-документи (ІД), які будуть передані кур'єру. Підтримуються два варіанти додавання: по одному документу або масово. Основна логіка методу залишається однаковою, змінюється лише кількість доданих документів.\
> \
> \\
> \\Детальні умови додавання документів\\
\
> \
> До заявки можливо додавати ІД від:\
> \* різних контрагентів, які працюють в одному корпоративному кабінеті (один логін);\
> \* одного контрагента, але відправлення створюються з різних кабінетів від різних контактних осіб цього контрагента.\
> \
> Додавання інтернет-документів до заявки доступне в таких випадках:\
> \* Заявка на виклик кур’єра має статус «Готово до виконання».\
> \* Адреса відправника в ІД співпадає із адресою відправки у заявці на виклик кур’єра до вулиці та номеру будинку включно.\
> \* Для заявки на виклик кур’єра ще не минули вказані дата та часовий інтервал (ЧІ).\
> \* Кур’єр на адресі відправника, але ще не підтвердив кількість та вагу відправлень у заявці.\
> \* Якщо до закінчення ЧІ залишилось більше 2 годин — без обмежень за вагою в інтернет-документах.\
> \* Якщо до закінчення ЧІ залишилось менше 2 годин — вага в інтернет-документі, який необхідно додати, не повинна перевищувати 20% від планової ваги у заявці.\
> \
> \ \
> \
> \*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*).
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CarCall"],"operationId":"insertDocumentsXml","summary":"Додати документи до заявки на виклик кур’єра (XML)","description":"Метод **insertDocuments** працює в моделі **CarCallGeneral***.\n\nЦей метод дозволяє додавати до заявки на виклик кур’єра інтернет-документи (ІД), які будуть передані кур'єру. Підтримуються два варіанти додавання: по одному документу або масово. Основна логіка методу залишається однаковою, змінюється лише кількість доданих документів.\n\n\nДетальні умови додавання документів
\n\nДо заявки можливо додавати ІД від:\n* різних контрагентів, які працюють в одному корпоративному кабінеті (один логін);\n* одного контрагента, але відправлення створюються з різних кабінетів від різних контактних осіб цього контрагента.\n\nДодавання інтернет-документів до заявки доступне в таких випадках:\n* Заявка на виклик кур’єра має статус «Готово до виконання».\n* Адреса відправника в ІД співпадає із адресою відправки у заявці на виклик кур’єра до вулиці та номеру будинку включно.\n* Для заявки на виклик кур’єра ще не минули вказані дата та часовий інтервал (ЧІ).\n* Кур’єр на адресі відправника, але ще не підтвердив кількість та вагу відправлень у заявці.\n* Якщо до закінчення ЧІ залишилось більше 2 годин — без обмежень за вагою в інтернет-документах.\n* Якщо до закінчення ЧІ залишилось менше 2 годин — вага в інтернет-документі, який необхідно додати, не повинна перевищувати 20% від планової ваги у заявці.\n\n \n\n*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод **getEWTemplateList** моделі **InternetDocument**).\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/InsertDocumentsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/InsertDocumentsXmlResponse"}}}}}}}},"components":{"schemas":{"InsertDocumentsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["insertDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/InsertDocumentsXmlMethodProperties"}}},"InsertDocumentsXmlMethodProperties":{"type":"object","additionalProperties":false,"required":["LinkedDocuments","Number"],"properties":{"LinkedDocuments":{"type":"array","description":"Інтернет-документи, що передаються кур’єру в рамках цієї заявки","xml":{"name":"LinkedDocuments","wrapped":true},"items":{"type":"string","maxLength":36,"xml":{"name":"item"}}},"Number":{"type":"string","maxLength":12,"description":"Номер заявки на виклик кур’єра"}},"xml":{"name":"methodProperties"}},"InsertDocumentsXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів виконання запиту","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/InsertDocumentsXmlItem"}},"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"}}}}},"InsertDocumentsXmlItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"succeeded":{"type":"array","description":"Номер доданого документа до заявки на виклик кур’єра","xml":{"name":"succeeded","wrapped":true},"items":{"type":"string","maxLength":36,"xml":{"name":"item"}}},"Barcode":{"type":"string","maxLength":36,"description":"Номер створеної заявки на виклик кур’єра"}}}}}}
```
## Отримати список доступних заявок для додавання документів (JSON)
> Метод \*\*getAvailableOrdersList\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє отримати список наявних заявок на виклик кур’єра зі статусом «Готово до виконання», у яких ще не закінчився часовий інтервал, тобто доступних для додавання інтернет-документів.\
> \
> \\
> \\Додаткові посилання та супутні методи\\
\
> \
> \* Для перегляду списку доданих інтернет-документів за номером заявки використовується метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*.\
> \* Для перегляду доступних часових інтервалів для виклику кур’єра використовується метод \*\*getPickupTimeIntervals\*\* моделі \*\*CommonGeneral\*\*.\
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CarCall"],"operationId":"getAvailableOrdersListJson","summary":"Отримати список доступних заявок для додавання документів (JSON)","description":"Метод **getAvailableOrdersList** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє отримати список наявних заявок на виклик кур’єра зі статусом «Готово до виконання», у яких ще не закінчився часовий інтервал, тобто доступних для додавання інтернет-документів.\n\n\nДодаткові посилання та супутні методи
\n\n* Для перегляду списку доданих інтернет-документів за номером заявки використовується метод **getEWTemplateList** моделі **InternetDocument**.\n* Для перегляду доступних часових інтервалів для виклику кур’єра використовується метод **getPickupTimeIntervals** моделі **CommonGeneral**.\n \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAvailableOrdersListJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAvailableOrdersListResponse"}}}}}}}},"components":{"schemas":{"GetAvailableOrdersListJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getAvailableOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetAvailableOrdersListMethodProperties"}}},"GetAvailableOrdersListMethodProperties":{"type":"object","additionalProperties":false,"required":["Number"],"properties":{"Number":{"type":"string","maxLength":16,"description":"Номер інтернет-документа"}}},"GetAvailableOrdersListResponse":{"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/AvailableOrderItem"}},"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"}}}},"AvailableOrderItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"TimeIntervalDescription":{"type":"string","maxLength":36,"description":"Часовий інтервал"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"SenderAddressDescription":{"type":"string","maxLength":36,"description":"Текстовий опис адреси"}}}}}}
```
## Отримати список доступних заявок для додавання документів (XML)
> Метод \*\*getAvailableOrdersList\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє отримати список наявних заявок на виклик кур’єра зі статусом «Готово до виконання», у яких ще не закінчився часовий інтервал, тобто доступних для додавання інтернет-документів.\
> \
> \\
> \\Додаткові посилання та супутні методи\\
\
> \
> \* Для перегляду списку доданих інтернет-документів за номером заявки використовується метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*.\
> \* Для перегляду доступних часових інтервалів для виклику кур’єра використовується метод \*\*getPickupTimeIntervals\*\* моделі \*\*CommonGeneral\*\*.\
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CarCall"],"operationId":"getAvailableOrdersListXml","summary":"Отримати список доступних заявок для додавання документів (XML)","description":"Метод **getAvailableOrdersList** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє отримати список наявних заявок на виклик кур’єра зі статусом «Готово до виконання», у яких ще не закінчився часовий інтервал, тобто доступних для додавання інтернет-документів.\n\n\nДодаткові посилання та супутні методи
\n\n* Для перегляду списку доданих інтернет-документів за номером заявки використовується метод **getEWTemplateList** моделі **InternetDocument**.\n* Для перегляду доступних часових інтервалів для виклику кур’єра використовується метод **getPickupTimeIntervals** моделі **CommonGeneral**.\n \n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetAvailableOrdersListXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/GetAvailableOrdersListXmlResponse"}}}}}}}},"components":{"schemas":{"GetAvailableOrdersListXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["getAvailableOrdersList"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/GetAvailableOrdersListXmlMethodProperties"}}},"GetAvailableOrdersListXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/GetAvailableOrdersListMethodProperties"}],"xml":{"name":"methodProperties"}},"GetAvailableOrdersListMethodProperties":{"type":"object","additionalProperties":false,"required":["Number"],"properties":{"Number":{"type":"string","maxLength":16,"description":"Номер інтернет-документа"}}},"GetAvailableOrdersListXmlResponse":{"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/AvailableOrderXmlItem"}},"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"}}}}},"AvailableOrderXmlItem":{"allOf":[{"$ref":"#/components/schemas/AvailableOrderItem"}],"xml":{"name":"item"}},"AvailableOrderItem":{"type":"object","additionalProperties":false,"properties":{"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"},"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"TimeIntervalDescription":{"type":"string","maxLength":36,"description":"Часовий інтервал"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Бажана дата доставки"},"SenderAddressDescription":{"type":"string","maxLength":36,"description":"Текстовий опис адреси"}}}}}}
```
## Скасувати заявку на виклик кур’єра (JSON)
> Метод \*\*deleteCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*\*.\
> \
> Цей метод дозволяє скасувати заявку на виклик кур’єра. Якщо заявка скасовується менше ніж за годину до закінчення часового інтервалу та у замовника доступний безготівковий розрахунок, нараховується оплата за відміну заявки — 350 грн.\
> \
> \\
> \\Обмеження та детальні умови скасування\\
\
> \
> Скасування заявки заборонено, якщо:\
> \* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлення у заявці;\
> \* заявка має статус «Виконано».\
> \
> \ \
> \
> \*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CarCall"],"operationId":"deleteCourierCallJson","summary":"Скасувати заявку на виклик кур’єра (JSON)","description":"Метод **deleteCourierCall** працює в моделі **CarCallGeneral***.\n\nЦей метод дозволяє скасувати заявку на виклик кур’єра. Якщо заявка скасовується менше ніж за годину до закінчення часового інтервалу та у замовника доступний безготівковий розрахунок, нараховується оплата за відміну заявки — 350 грн.\n\n\nОбмеження та детальні умови скасування
\n\nСкасування заявки заборонено, якщо:\n* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлення у заявці;\n* заявка має статус «Виконано».\n\n \n\n*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати метод **getEWTemplateList** моделі **InternetDocument**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCourierCallJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCourierCallResponse"}}}}}}}},"components":{"schemas":{"DeleteCourierCallJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["deleteCourierCall"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteCourierCallMethodProperties"}}},"DeleteCourierCallMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"}}},"DeleteCourierCallResponse":{"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/DeleteCourierCallItem"}},"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"}}}},"DeleteCourierCallItem":{"type":"object","additionalProperties":false,"properties":{"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}}}}}
```
## Скасувати заявку на виклик кур’єра (XML)
> Метод \*\*deleteCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*\*.\
> \
> Цей метод дозволяє скасувати заявку на виклик кур’єра. Якщо заявка скасовується менше ніж за годину до закінчення часового інтервалу та у замовника доступний безготівковий розрахунок, нараховується оплата за відміну заявки — 350 грн.\
> \
> \\
> \\Обмеження та детальні умови скасування\\
\
> \
> Скасування заявки заборонено, якщо:\
> \* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлення у заявці;\
> \* заявка має статус «Виконано».\
> \
> \ \
> \
> \*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CarCall"],"operationId":"deleteCourierCallXml","summary":"Скасувати заявку на виклик кур’єра (XML)","description":"Метод **deleteCourierCall** працює в моделі **CarCallGeneral***.\n\nЦей метод дозволяє скасувати заявку на виклик кур’єра. Якщо заявка скасовується менше ніж за годину до закінчення часового інтервалу та у замовника доступний безготівковий розрахунок, нараховується оплата за відміну заявки — 350 грн.\n\n\nОбмеження та детальні умови скасування
\n\nСкасування заявки заборонено, якщо:\n* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлення у заявці;\n* заявка має статус «Виконано».\n\n \n\n*Для перегляду списку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати метод **getEWTemplateList** моделі **InternetDocument**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteCourierCallXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/DeleteCourierCallXmlResponse"}}}}}}}},"components":{"schemas":{"DeleteCourierCallXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["deleteCourierCall"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/DeleteCourierCallXmlMethodProperties"}}},"DeleteCourierCallXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/DeleteCourierCallMethodProperties"}],"xml":{"name":"methodProperties"}},"DeleteCourierCallMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"}}},"DeleteCourierCallXmlResponse":{"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/DeleteCourierCallXmlItem"}},"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"}}}}},"DeleteCourierCallXmlItem":{"allOf":[{"$ref":"#/components/schemas/DeleteCourierCallItem"}],"xml":{"name":"item"}},"DeleteCourierCallItem":{"type":"object","additionalProperties":false,"properties":{"Cost":{"type":"string","maxLength":36,"description":"Оціночна вартість"},"Number":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}}}}}
```
## Редагувати заявку на виклик кур’єра (JSON)
> Метод \*\*updateCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє редагувати дані вже створеної заявки на виклик кур'єра. Усі параметри заповнювати обов'язково. Після оновлення замінюються лише ті, які було модифіковано.\
> \
> \\
> \\Обмеження та детальні умови редагування\\
\
> \
> \* Заявку можна редагувати не пізніше ніж за 2 години до кінця зазначеної дати та часового інтервалу.\
> \* Редагування заборонено, якщо кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень.\
> \* Метод доступний відправнику в межах заявки, проте не всі параметри можна оновлювати. Відправник може редагувати такі параметри:\
> \* дату та часовий інтервал;\
> \* планову вагу у заявці.\
> \* Щоб дізнатися про доступні часові інтервали для послуги «Виклик кур’єра», потрібно використовувати метод отримання доступних часових інтервалів (див. метод \*\*getPickupTimeIntervals\*\* моделі \*\*CommonGeneral\*\*).\
> \
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CarCall"],"operationId":"updateCourierCallJson","summary":"Редагувати заявку на виклик кур’єра (JSON)","description":"Метод **updateCourierCall** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє редагувати дані вже створеної заявки на виклик кур'єра. Усі параметри заповнювати обов'язково. Після оновлення замінюються лише ті, які було модифіковано.\n\n\nОбмеження та детальні умови редагування
\n\n* Заявку можна редагувати не пізніше ніж за 2 години до кінця зазначеної дати та часового інтервалу.\n* Редагування заборонено, якщо кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень.\n* Метод доступний відправнику в межах заявки, проте не всі параметри можна оновлювати. Відправник може редагувати такі параметри:\n * дату та часовий інтервал;\n * планову вагу у заявці.\n* Щоб дізнатися про доступні часові інтервали для послуги «Виклик кур’єра», потрібно використовувати метод отримання доступних часових інтервалів (див. метод **getPickupTimeIntervals** моделі **CommonGeneral**).\n\n \n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCourierCallJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCourierCallResponse"}}}}}}}},"components":{"schemas":{"UpdateCourierCallJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["updateCourierCall"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateCourierCallMethodProperties"}}},"UpdateCourierCallMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","PreferredDeliveryDate","PlanedWeight","TimeInterval"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"PreferredDeliveryDate":{"type":"string","maxLength":10,"description":"Бажана дата доставки/забору (дд.мм.рррр)"},"PlanedWeight":{"type":"string","maxLength":36,"description":"Планова вага у заявці (кг)"},"TimeInterval":{"type":"string","maxLength":36,"description":"Ідентифікатор часового інтервалу"}}},"UpdateCourierCallResponse":{"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/UpdateCourierCallItem"}},"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"}}}},"UpdateCourierCallItem":{"type":"object","additionalProperties":false,"properties":{"Barcode":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}}}}}
```
## Редагувати заявку на виклик кур’єра (XML)
> Метод \*\*updateCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє редагувати дані вже створеної заявки на виклик кур'єра. Усі параметри заповнювати обов'язково. Після оновлення замінюються лише ті, які було модифіковано.\
> \
> \\
> \\Обмеження та детальні умови редагування\\
\
> \
> \* Заявку можна редагувати не пізніше ніж за 2 години до кінця зазначеної дати та часового інтервалу.\
> \* Редагування заборонено, якщо кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень.\
> \* Метод доступний відправнику в межах заявки, проте не всі параметри можна оновлювати. Відправник може редагувати такі параметри:\
> \* дату та часовий інтервал;\
> \* планову вагу у заявці.\
> \* Щоб дізнатися про доступні часові інтервали для послуги «Виклик кур’єра», потрібно використовувати метод отримання доступних часових інтервалів (див. метод \*\*getPickupTimeIntervals\*\* моделі \*\*CommonGeneral\*\*).\
> \
> \
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CarCall"],"operationId":"updateCourierCallXml","summary":"Редагувати заявку на виклик кур’єра (XML)","description":"Метод **updateCourierCall** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє редагувати дані вже створеної заявки на виклик кур'єра. Усі параметри заповнювати обов'язково. Після оновлення замінюються лише ті, які було модифіковано.\n\n\nОбмеження та детальні умови редагування
\n\n* Заявку можна редагувати не пізніше ніж за 2 години до кінця зазначеної дати та часового інтервалу.\n* Редагування заборонено, якщо кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень.\n* Метод доступний відправнику в межах заявки, проте не всі параметри можна оновлювати. Відправник може редагувати такі параметри:\n * дату та часовий інтервал;\n * планову вагу у заявці.\n* Щоб дізнатися про доступні часові інтервали для послуги «Виклик кур’єра», потрібно використовувати метод отримання доступних часових інтервалів (див. метод **getPickupTimeIntervals** моделі **CommonGeneral**).\n\n \n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateCourierCallXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/UpdateCourierCallXmlResponse"}}}}}}}},"components":{"schemas":{"UpdateCourierCallXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["updateCourierCall"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/UpdateCourierCallXmlMethodProperties"}}},"UpdateCourierCallXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/UpdateCourierCallMethodProperties"}],"xml":{"name":"methodProperties"}},"UpdateCourierCallMethodProperties":{"type":"object","additionalProperties":false,"required":["Ref","PreferredDeliveryDate","PlanedWeight","TimeInterval"],"properties":{"Ref":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) створеної заявки на виклик кур’єра"},"PreferredDeliveryDate":{"type":"string","maxLength":10,"description":"Бажана дата доставки/забору (дд.мм.рррр)"},"PlanedWeight":{"type":"string","maxLength":36,"description":"Планова вага у заявці (кг)"},"TimeInterval":{"type":"string","maxLength":36,"description":"Ідентифікатор часового інтервалу"}}},"UpdateCourierCallXmlResponse":{"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/UpdateCourierCallXmlItem"}},"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"}}}}},"UpdateCourierCallXmlItem":{"allOf":[{"$ref":"#/components/schemas/UpdateCourierCallItem"}],"xml":{"name":"item"}},"UpdateCourierCallItem":{"type":"object","additionalProperties":false,"properties":{"Barcode":{"type":"string","maxLength":36,"description":"Номер заявки на виклик кур’єра"}}}}}}
```
## Видалити документи із заявки на виклик кур’єра (JSON)
> Метод \*\*removeDocuments\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє видалити із заявки на виклик кур’єра ті інтернет-документи, які не потрібно передавати кур’єру в її межах. Він підтримує кілька способів видалення: окремо (по одному) або масово. Основна частина методу однакова, відрізняється лише кількість документів, які видаляються.\
> \
> \\
> \\Обмеження та детальні умови видалення\\
\
> \
> Заборонено видаляти інтернет-документи із заявки на виклик кур’єра, якщо:\
> \* заявка має один зі статусів «Виконано»;\
> \* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень у заявці.\
> \
> \ \
> \
> Для перегляду переліку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*).
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CarCall"],"operationId":"removeDocumentsJson","summary":"Видалити документи із заявки на виклик кур’єра (JSON)","description":"Метод **removeDocuments** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє видалити із заявки на виклик кур’єра ті інтернет-документи, які не потрібно передавати кур’єру в її межах. Він підтримує кілька способів видалення: окремо (по одному) або масово. Основна частина методу однакова, відрізняється лише кількість документів, які видаляються.\n\n\nОбмеження та детальні умови видалення
\n\nЗаборонено видаляти інтернет-документи із заявки на виклик кур’єра, якщо:\n* заявка має один зі статусів «Виконано»;\n* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень у заявці.\n\n \n\nДля перегляду переліку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод **getEWTemplateList** моделі **InternetDocument**).\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsResponse"}}}}}}}},"components":{"schemas":{"RemoveDocumentsJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["removeDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/RemoveDocumentsMethodProperties"}}},"RemoveDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["LinkedDocuments"],"properties":{"LinkedDocuments":{"type":"array","description":"Інтернет-документи, які буде видалено із заявки на виклик кур’єра","items":{"type":"string","maxLength":36}}}},"RemoveDocumentsResponse":{"type":"object","additionalProperties":false,"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів видалення документів","items":{"$ref":"#/components/schemas/RemoveDocumentsItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","items":{"type":"string"}},"warnings":{"type":"array","description":"Масив попереджень","items":{"type":"string"}},"info":{"type":"array","description":"Масив інформаційних повідомлень","items":{"type":"string"}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","items":{"type":"string"}},"errorCodes":{"type":"array","description":"Масив кодів помилок","items":{"type":"string"}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","items":{"type":"string"}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","items":{"type":"string"}}}},"RemoveDocumentsItem":{"type":"object","additionalProperties":false,"properties":{"succeeded":{"type":"array","description":"Список номерів документів, успішно видалених із заявки","items":{"type":"integer"}}}}}}}
```
## Видалити документи із заявки на виклик кур’єра (XML)
> Метод \*\*removeDocuments\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє видалити із заявки на виклик кур’єра ті інтернет-документи, які не потрібно передавати кур’єру в її межах. Він підтримує кілька способів видалення: окремо (по одному) або масово. Основна частина методу однакова, відрізняється лише кількість документів, які видаляються.\
> \
> \\
> \\Обмеження та детальні умови видалення\\
\
> \
> Заборонено видаляти інтернет-документи із заявки на виклик кур’єра, якщо:\
> \* заявка має один зі статусів «Виконано»;\
> \* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень у заявці.\
> \
> \ \
> \
> Для перегляду переліку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод \*\*getEWTemplateList\*\* моделі \*\*InternetDocument\*\*).
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CarCall"],"operationId":"removeDocumentsXml","summary":"Видалити документи із заявки на виклик кур’єра (XML)","description":"Метод **removeDocuments** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє видалити із заявки на виклик кур’єра ті інтернет-документи, які не потрібно передавати кур’єру в її межах. Він підтримує кілька способів видалення: окремо (по одному) або масово. Основна частина методу однакова, відрізняється лише кількість документів, які видаляються.\n\n\nОбмеження та детальні умови видалення
\n\nЗаборонено видаляти інтернет-документи із заявки на виклик кур’єра, якщо:\n* заявка має один зі статусів «Виконано»;\n* кур’єр перебуває на адресі відправника та підтвердив кількість і вагу відправлень у заявці.\n\n \n\nДля перегляду переліку доданих інтернет-документів за номером заявки на виклик кур’єра потрібно використовувати відповідний метод (див. метод **getEWTemplateList** моделі **InternetDocument**).\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/RemoveDocumentsXmlResponse"}}}}}}}},"components":{"schemas":{"RemoveDocumentsXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["removeDocuments"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/RemoveDocumentsXmlMethodProperties"}}},"RemoveDocumentsXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/RemoveDocumentsMethodProperties"}],"properties":{"LinkedDocuments":{"type":"array","description":"Інтернет-документи, які буде видалено із заявки на виклик кур’єра","xml":{"name":"LinkedDocuments","wrapped":true},"items":{"type":"string","maxLength":36,"xml":{"name":"item"}}}},"xml":{"name":"methodProperties"}},"RemoveDocumentsMethodProperties":{"type":"object","additionalProperties":false,"required":["LinkedDocuments"],"properties":{"LinkedDocuments":{"type":"array","description":"Інтернет-документи, які буде видалено із заявки на виклик кур’єра","items":{"type":"string","maxLength":36}}}},"RemoveDocumentsXmlResponse":{"type":"object","additionalProperties":false,"xml":{"name":"root"},"required":["success","data","errors","warnings","info","messageCodes","errorCodes","warningCodes","infoCodes"],"properties":{"success":{"type":"boolean","description":"Прапор успішності виконання запиту"},"data":{"type":"array","description":"Масив результатів видалення документів","xml":{"name":"data","wrapped":true},"items":{"$ref":"#/components/schemas/RemoveDocumentsXmlItem"}},"errors":{"type":"array","description":"Масив повідомлень про помилки","xml":{"name":"errors","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warnings":{"type":"array","description":"Масив попереджень","xml":{"name":"warnings","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"info":{"type":"array","description":"Масив інформаційних повідомлень","xml":{"name":"info","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"messageCodes":{"type":"array","description":"Масив кодів інформаційних повідомлень","xml":{"name":"messageCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"errorCodes":{"type":"array","description":"Масив кодів помилок","xml":{"name":"errorCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"warningCodes":{"type":"array","description":"Масив кодів попереджень","xml":{"name":"warningCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}},"infoCodes":{"type":"array","description":"Масив кодів додаткової інформації","xml":{"name":"infoCodes","wrapped":true},"items":{"type":"string","xml":{"name":"item"}}}}},"RemoveDocumentsXmlItem":{"type":"object","additionalProperties":false,"xml":{"name":"item"},"properties":{"succeeded":{"type":"array","description":"Список номерів документів, успішно видалених із заявки","xml":{"name":"succeeded","wrapped":true},"items":{"type":"integer","xml":{"name":"item"}}}}}}}}
```
## Створити заявку на виклик кур’єра (JSON)
> Метод \*\*saveCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє створити заявку на виклик кур’єра для відправлення з адреси. Метод доступний лише для клієнтів-відправників, яким підключено послугу «Виклик кур’єра» через запит до персонального менеджера. Разом із підключенням цієї послуги встановлюється налаштування, що вимикає автоматичне створення заявки на підставі інтернет-документа (ІД) з адреси.\
> \
> \\
> \\Обмеження та детальні умови створення\\
\
> \
> Заявку на виклик кур’єра неможливо створити, якщо:\
> \* вже існує заявка на зазначений часовий інтервал із аналогічної адреси та від аналогічного контрагента;\
> \* часовий інтервал уже минув або недоступний для замовлення.\
> \
> \ \
> \
> Щоб отримати доступні часові інтервали для виклику кур’єра, використовується метод \*\*getPickupTimeIntervals\*\* моделі \*\*CommonGeneral\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/json/":{"post":{"tags":["CarCall"],"operationId":"saveCourierCallJson","summary":"Створити заявку на виклик кур’єра (JSON)","description":"Метод **saveCourierCall** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє створити заявку на виклик кур’єра для відправлення з адреси. Метод доступний лише для клієнтів-відправників, яким підключено послугу «Виклик кур’єра» через запит до персонального менеджера. Разом із підключенням цієї послуги встановлюється налаштування, що вимикає автоматичне створення заявки на підставі інтернет-документа (ІД) з адреси.\n\n\nОбмеження та детальні умови створення
\n\nЗаявку на виклик кур’єра неможливо створити, якщо:\n* вже існує заявка на зазначений часовий інтервал із аналогічної адреси та від аналогічного контрагента;\n* часовий інтервал уже минув або недоступний для замовлення.\n\n \n\nЩоб отримати доступні часові інтервали для виклику кур’єра, використовується метод **getPickupTimeIntervals** моделі **CommonGeneral**.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCourierCallJsonRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (JSON)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCourierCallResponse"}}}}}}}},"components":{"schemas":{"SaveCourierCallJsonRequest":{"type":"object","additionalProperties":false,"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["saveCourierCall"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveCourierCallMethodProperties"}}},"SaveCourierCallMethodProperties":{"type":"object","additionalProperties":false,"required":["ContactSenderRef","PreferredDeliveryDate","PlanedWeight","TimeInterval","CounterpartySender","AddressSenderRef"],"properties":{"ContactSenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи-відправника. Дані з відповіді методу, що реалізує завантаження списку контактних осіб контрагента (див. метод **getCounterpartyContactPersons** моделі **Counterparty**)"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Дата відправки"},"PlanedWeight":{"type":"string","maxLength":10,"description":"Планова вага"},"TimeInterval":{"type":"string","maxLength":36,"description":"Часовий інтервал (для замовлення послуги «Часові інтервали»). Для отримання доступних часових інтервалів використовується метод **getPickupTimeIntervals** моделі **CommonGeneral**"},"CounterpartySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента-відправника"},"AddressSenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу, що реалізує створення адреси контрагента (див. метод **save** моделі **Address**)"}}},"SaveCourierCallResponse":{"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/SaveCourierCallItem"}},"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"}}}},"SaveCourierCallItem":{"type":"object","additionalProperties":false,"properties":{"Barcode":{"type":"string","maxLength":36,"description":"Номер створеної заявки на виклик кур’єра"}}}}}}
```
## Створити заявку на виклик кур’єра (XML)
> Метод \*\*saveCourierCall\*\* працює в моделі \*\*CarCallGeneral\*\*.\
> \
> Цей метод дозволяє створити заявку на виклик кур’єра для відправлення з адреси. Метод доступний лише для клієнтів-відправників, яким підключено послугу «Виклик кур’єра» через запит до персонального менеджера. Разом із підключенням цієї послуги встановлюється налаштування, що вимикає автоматичне створення заявки на підставі інтернет-документа (ІД) з адреси.\
> \
> \\
> \\Обмеження та детальні умови створення\\
\
> \
> Заявку на виклик кур’єра неможливо створити, якщо:\
> \* вже існує заявка на зазначений часовий інтервал із аналогічної адреси та від аналогічного контрагента;\
> \* часовий інтервал уже минув або недоступний для замовлення.\
> \
> \ \
> \
> Щоб отримати доступні часові інтервали для виклику кур’єра, використовується метод \*\*getPickupTimeIntervals\*\* моделі \*\*CommonGeneral\*\*.
```json
{"openapi":"3.0.3","info":{"title":"API Nova Post — Car Call","version":"2.0.0"},"tags":[{"name":"CarCall","description":"Операції, пов'язані з викликом кур'єра"}],"servers":[{"url":"https://api.novaposhta.ua/v2.0/","description":"production"}],"paths":{"/xml/":{"post":{"tags":["CarCall"],"operationId":"saveCourierCallXml","summary":"Створити заявку на виклик кур’єра (XML)","description":"Метод **saveCourierCall** працює в моделі **CarCallGeneral**.\n\nЦей метод дозволяє створити заявку на виклик кур’єра для відправлення з адреси. Метод доступний лише для клієнтів-відправників, яким підключено послугу «Виклик кур’єра» через запит до персонального менеджера. Разом із підключенням цієї послуги встановлюється налаштування, що вимикає автоматичне створення заявки на підставі інтернет-документа (ІД) з адреси.\n\n\nОбмеження та детальні умови створення
\n\nЗаявку на виклик кур’єра неможливо створити, якщо:\n* вже існує заявка на зазначений часовий інтервал із аналогічної адреси та від аналогічного контрагента;\n* часовий інтервал уже минув або недоступний для замовлення.\n\n \n\nЩоб отримати доступні часові інтервали для виклику кур’єра, використовується метод **getPickupTimeIntervals** моделі **CommonGeneral**.\n","requestBody":{"required":true,"content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveCourierCallXmlRequest"}}}},"responses":{"200":{"description":"Успішна відповідь (XML)","content":{"application/xml":{"schema":{"$ref":"#/components/schemas/SaveCourierCallXmlResponse"}}}}}}}},"components":{"schemas":{"SaveCourierCallXmlRequest":{"type":"object","additionalProperties":false,"xml":{"name":"file"},"required":["apiKey","modelName","calledMethod","methodProperties"],"properties":{"apiKey":{"type":"string","description":"API-ключ користувача"},"modelName":{"type":"string","enum":["CarCallGeneral"],"description":"Назва моделі API"},"calledMethod":{"type":"string","enum":["saveCourierCall"],"description":"Назва методу API"},"methodProperties":{"$ref":"#/components/schemas/SaveCourierCallXmlMethodProperties"}}},"SaveCourierCallXmlMethodProperties":{"allOf":[{"$ref":"#/components/schemas/SaveCourierCallMethodProperties"}],"xml":{"name":"methodProperties"}},"SaveCourierCallMethodProperties":{"type":"object","additionalProperties":false,"required":["ContactSenderRef","PreferredDeliveryDate","PlanedWeight","TimeInterval","CounterpartySender","AddressSenderRef"],"properties":{"ContactSenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контактної особи-відправника. Дані з відповіді методу, що реалізує завантаження списку контактних осіб контрагента (див. метод **getCounterpartyContactPersons** моделі **Counterparty**)"},"PreferredDeliveryDate":{"type":"string","maxLength":36,"description":"Дата відправки"},"PlanedWeight":{"type":"string","maxLength":10,"description":"Планова вага"},"TimeInterval":{"type":"string","maxLength":36,"description":"Часовий інтервал (для замовлення послуги «Часові інтервали»). Для отримання доступних часових інтервалів використовується метод **getPickupTimeIntervals** моделі **CommonGeneral**"},"CounterpartySender":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) контрагента-відправника"},"AddressSenderRef":{"type":"string","maxLength":36,"description":"Ідентифікатор (REF) адреси відправника. Дані з відповіді методу, що реалізує створення адреси контрагента (див. метод **save** моделі **Address**)"}}},"SaveCourierCallXmlResponse":{"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/SaveCourierCallXmlItem"}},"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"}}}}},"SaveCourierCallXmlItem":{"allOf":[{"$ref":"#/components/schemas/SaveCourierCallItem"}],"xml":{"name":"item"}},"SaveCourierCallItem":{"type":"object","additionalProperties":false,"properties":{"Barcode":{"type":"string","maxLength":36,"description":"Номер створеної заявки на виклик кур’єра"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://api-portal.novapost.com/api-docs-ua/zagalna-informaciya/viklik-kuryera.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.