> 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/metodi-1/metodi/readme/kuryerska-dostavka.md).
# Кур'єрська доставка
## Створити заявку на кур’єрський забір
> Цей метод дозволяє бізнес-клієнтам створити нову заявку на кур’єрський забір, вказавши основні параметри, такі як адреса забору, тип відправлення та додаткові відомості.\
> \
> \*\*Початковий статус (\`Draft\`)\*\*: Заявка на кур’єрський забір створюється зі статусом \`Draft\`, що дозволяє клієнтам додати до заявки всі необхідні відправлення.\
> \
> \*\*Перехід до статусу \`Created\`\*\*: Після додавання всіх відправлень клієнт повинен скористатися методом "Оновити статус заявки на кур’єрський забір", щоб змінити статус на \`Created\`. Це означає, що заявку завершено та вона готова до обробки кур’єрською службою.\
> \
> \*\*Часові інтервали\*\*: Щоб вказати бажаний часовий інтервал для забору, клієнт повинен отримати доступні часові інтервали за допомогою відповідного методу. Це гарантує, що бажаний час кур’єрського забору відповідає графіку та доступності кур’єра.\
> \
> \*\*Додаткова послуга – CourierPickupService\*\*: Клієнти можуть додатково передавати інформацію про плановий вантаж у масиві \`services\` за допомогою послуги \`CourierPickupService\`. Це дозволяє вказати орієнтовні характеристики відправлення, такі як опис вантажу, кількість місць, фактична та об'ємна вага, а також додаткові габарити. Наразі послуга доступна в Молдові. Ця інформація використовується під час планування забору та обробки кур'єрського запиту.\
> \
> Цей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Nova Post.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups":{"post":{"tags":["Pickups"],"description":"Цей метод дозволяє бізнес-клієнтам створити нову заявку на кур’єрський забір, вказавши основні параметри, такі як адреса забору, тип відправлення та додаткові відомості.\n\n**Початковий статус (`Draft`)**: Заявка на кур’єрський забір створюється зі статусом `Draft`, що дозволяє клієнтам додати до заявки всі необхідні відправлення.\n\n**Перехід до статусу `Created`**: Після додавання всіх відправлень клієнт повинен скористатися методом \"Оновити статус заявки на кур’єрський забір\", щоб змінити статус на `Created`. Це означає, що заявку завершено та вона готова до обробки кур’єрською службою.\n\n**Часові інтервали**: Щоб вказати бажаний часовий інтервал для забору, клієнт повинен отримати доступні часові інтервали за допомогою відповідного методу. Це гарантує, що бажаний час кур’єрського забору відповідає графіку та доступності кур’єра.\n\n**Додаткова послуга – CourierPickupService**: Клієнти можуть додатково передавати інформацію про плановий вантаж у масиві `services` за допомогою послуги `CourierPickupService`. Це дозволяє вказати орієнтовні характеристики відправлення, такі як опис вантажу, кількість місць, фактична та об'ємна вага, а також додаткові габарити. Наразі послуга доступна в Молдові. Ця інформація використовується під час планування забору та обробки кур'єрського запиту.\n\nЦей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Nova Post.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"Необов’язкові примітки або інструкції для кур’єра.","maxLength":255},"services":{"type":"array","nullable":true,"description":"Список додаткових послуг, пов'язаних із запитом на забір.\n\nНаразі підтримується така послуга:\n\n- `CourierPickupService` — дозволяє клієнту передати інформацію про плановий вантаж, яка буде використана під час планування забору та обробки кур'єрського запиту.\n","items":{"type":"object","properties":{"serviceCode":{"type":"string","description":"Код послуги.\n\n**🔻Це поле є обов'язковим.**\n","enum":["CourierPickupService"]},"contractNumber":{"type":"string","description":"Номер договору, який використовується для оплати послуги.\n\n**🔻Це поле є обов'язковим.**\n"},"amount":{"type":"number","minimum":1,"description":"Кількість послуги.\n\n**🔻Це поле є обов'язковим.**\n"},"payerType":{"type":"string","description":"Визначає сторону, відповідальну за оплату послуги.\n\nЗначення за замовчуванням: `Sender`.\n\n**🔻Це поле є обов'язковим.**\n","enum":["Sender","Recipient","ThirdPerson"]},"additionalParameters":{"type":"object","description":"Планові параметри вантажу.\n\n**🔻Це поле є обов'язковим.**\n","properties":{"parcelDescription":{"type":"string","description":"Опис вантажу.\n\n**🔻Це поле є обов'язковим.**\n"},"parcelsAmount":{"type":"number","description":"Планова кількість місць.\n\n**🔻Це поле є обов'язковим.**\n"},"totalActualWeight":{"type":"number","description":"Загальна планова фактична вага.\n\n**🔻Це поле є обов'язковим.**\n"},"totalVolumetricWeight":{"type":"number","description":"Загальна планова об'ємна вага.\n\n**🔻Це поле є обов'язковим.**\n"},"length":{"type":"number","description":"Планова довжина вантажу.\n"},"width":{"type":"number","description":"Планова ширина вантажу.\n"},"height":{"type":"number","description":"Планова висота вантажу.\n"}}}}}},"phone":{"type":"string","description":"Контактний номер телефону відправника, необхідний для того, щоб кур’єр міг зв’язатися у разі потреби.","minLength":8,"maxLength":14},"email":{"type":"string","description":"Хоча поле не є обов’язковим, рекомендується вказати електронну адресу як резервний спосіб зв’язку на випадок некоректного номера телефону або для отримання додаткових сповіщень щодо кур’єрського забору.","nullable":true},"fullName":{"type":"string","description":"Повне ім’я клієнта, який відправляє посилку. Необхідне для ідентифікації відправника та коректної обробки заявки на кур’єрський забір.","maxLength":100},"companyTin":{"type":"string","description":"Податковий ідентифікаційний номер (ІПН) юридичної особи.","minLength":2,"maxLength":20},"companyName":{"type":"string","description":"Назва компанії, яка оформлює заявку на кур’єрський забір.","minLength":2,"maxLength":255},"countryCode":{"type":"string","description":"Код країни місця кур’єрського забору відповідно до стандарту ISO Alpha-2.","pattern":"^[A-Z]{2}$"},"addressParts":{"type":"object","description":"Детальна інформація про адресу місця кур’єрського забору.","properties":{"city":{"type":"string","description":"Назва міста місця кур’єрського забору.","maxLength":100},"region":{"type":"string","description":"Адміністративна область, штат або регіон місця кур’єрського забору.","maxLength":100},"street":{"type":"string","description":"Назва вулиці місця кур’єрського забору.","maxLength":100},"postCode":{"type":"string","description":"Поштовий індекс місця кур’єрського забору.","maxLength":10},"building":{"type":"string","description":"Номер або назва будівлі за адресою кур’єрського забору.","maxLength":100},"flat":{"type":"string","description":"Номер квартири або офісу в будівлі.","maxLength":10},"block":{"type":"string","description":"Корпус або секція будівлі, якщо застосовується.","maxLength":100},"note":{"type":"string","description":"Додаткові інструкції для кур’єра щодо доступу до місця кур’єрського забору.","maxLength":100}}},"pickedTimeFrom":{"type":"string","format":"date-time","description":"Початок часового інтервалу кур’єрського забору, вибраного з доступних часових інтервалів, отриманих за допомогою методу повернення доступних часових слотів. Якщо часовий інтервал не вказано, кур’єр призначить час кур’єрського забору на власний розсуд.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true},"pickedTimeTo":{"type":"string","format":"date-time","description":"Кінець часового інтервалу кур’єрського забору, вибраного з доступних часових інтервалів, отриманих за допомогою методу повернення доступних часових слотів. Якщо часовий інтервал не вказано, кур’єр призначить час кур’єрського забору на власний розсуд.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true}}}}}},"responses":{"201":{"description":"Заявку на кур’єрський забір успішно створено","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Унікальний ідентифікатор заявки на кур’єрський забір.","minimum":1},"number":{"type":"string","description":"Реєстраційний номер заявки на кур’єрський забір.","pattern":"^[A-Z]{4}\\d{10}$"},"status":{"type":"string","description":"Поточний статус заявки на кур’єрський забір, що відображає етап її обробки.\n\nМожливі значення:\n - **Draft** — початковий статус, у якому заявку створено, але ще не завершено її оформлення.\n - **Created** — заявку створено та підготовлено до обробки.\n - **AppointedCourier** — для заявки призначено кур’єра.\n - **InProgress** — кур’єрський забір виконується.\n - **Done** — кур’єрський забір успішно завершено.\n - **ClientCanceled** — заявку скасовано клієнтом.\n - **NotCompleted** — кур’єрський забір не вдалося виконати.\n - **Deleted** — заявку видалено із системи.\n - **ReceivedByCourier** — відправлення отримано кур’єром.\n"},"statusDateTime":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"source":{"type":"string","description":"Джерело створення заявки, зазвичай \"clientapi\".","maxLength":50},"executor":{"type":"string","description":"Виконавець, призначений для виконання кур’єрського забору, якщо такий є.","maxLength":50,"nullable":true},"companyTin":{"type":"string","description":"ІПН юридичної особи.","minLength":2,"maxLength":20},"companyName":{"type":"string","description":"Назва компанії.","minLength":2,"maxLength":255},"fullName":{"type":"string","description":"Повне ім’я заявника.","maxLength":100},"phone":{"type":"string","description":"Контактний номер телефону.","minLength":8,"maxLength":14},"email":{"type":"string","description":"Контактна електронна адреса, якщо вказана.","nullable":true},"countryCode":{"type":"string","description":"Код країни місця кур’єрського забору.","pattern":"^[A-Z]{2}$"},"createdByUser":{"type":"string","description":"Ідентифікатор користувача, який створив заявку.","maxLength":50},"deliveryPartner":{"type":"string","description":"Партнер, відповідальний за доставку, якщо такий є.","nullable":true},"lockVersion":{"type":"integer","description":"Номер версії для контролю одночасних змін.","minimum":1},"divisionId":{"type":"integer","description":"Ідентифікатор відділення, пов’язаного із заявкою на кур’єрський забір, якщо застосовується.","minimum":1,"nullable":true},"settlementId":{"type":"integer","description":"Ідентифікатор населеного пункту місця кур’єрського забору.","minimum":1},"cityDistrict":{"type":"string","description":"Район міста місця кур’єрського забору, якщо застосовується.","maxLength":50,"nullable":true},"address":{"type":"object","description":"Відформатована адреса та географічні координати місця кур’єрського забору.","nullable":true,"properties":{"string":{"type":"string","description":"Повна адреса у відформатованому вигляді.","maxLength":255},"latitude":{"type":"number","format":"float","description":"Географічна широта місця кур’єрського забору.","minimum":-90,"maximum":90},"longitude":{"type":"number","format":"float","description":"Географічна довгота місця кур’єрського забору.","minimum":-180,"maximum":180}}},"addressParts":{"type":"object","description":"Деталізовані складові адреси, вказані у запиті.","nullable":true,"properties":{"postCode":{"type":"string","description":"Поштовий індекс місця кур’єрського забору.","maxLength":10},"building":{"type":"string","description":"Номер будівлі місця кур’єрського забору.","maxLength":100},"street":{"type":"string","description":"Назва вулиці місця кур’єрського забору.","maxLength":100},"city":{"type":"string","description":"Назва міста місця кур’єрського забору.","maxLength":100},"region":{"type":"string","description":"Назва регіону місця кур’єрського забору.","maxLength":100},"flat":{"type":"string","description":"Номер квартири або офісу.","maxLength":10},"note":{"type":"string","description":"Додаткові примітки щодо адреси.","maxLength":100},"block":{"type":"string","description":"Корпус або секція будівлі.","maxLength":100,"nullable":true}}},"pickedTimeFrom":{"type":"string","format":"date-time","description":"Початок часового інтервалу кур’єрського забору, вказаного у запиті.","nullable":true},"pickedTimeTo":{"type":"string","format":"date-time","description":"Кінець часового інтервалу кур’єрського забору, вказаного у запиті.","nullable":true},"note":{"type":"string","description":"Примітка або інструкції для кур’єра.","maxLength":255,"nullable":true},"currencyCode":{"type":"string","description":"Код валюти країни, що використовується для платіжних операцій.","pattern":"^[A-Z]{3}$"},"externalId":{"type":"string","description":"Внутрішні дані. Не призначено для використання.","nullable":true},"shipments":{"type":"array","items":{"type":"object"},"description":"Список відправлень, пов’язаних із цією заявкою на кур’єрський забір."},"services":{"type":"array","description":"Список додаткових послуг, пов'язаних із запитом на забір.","items":{"type":"object","properties":{"serviceCode":{"type":"string","description":"Код послуги."},"contractNumber":{"type":"string","description":"Номер договору для оплати послуги."},"amount":{"type":"number","description":"Кількість послуги."},"payerType":{"type":"string","description":"Тип платника."},"additionalParameters":{"type":"object","description":"Планові параметри вантажу.","properties":{"parcelDescription":{"type":"string","description":"Опис вантажу."},"parcelsAmount":{"type":"number","description":"Планова кількість місць."},"totalActualWeight":{"type":"number","description":"Загальна планова фактична вага."},"totalVolumetricWeight":{"type":"number","description":"Загальна планова об'ємна вага."},"length":{"type":"number","description":"Планова довжина вантажу.","nullable":true},"width":{"type":"number","description":"Планова ширина вантажу.","nullable":true},"height":{"type":"number","description":"Планова висота вантажу.","nullable":true}}}}}},"statuses":{"type":"array","description":"Масив об’єктів статусів, що відстежують зміни статусу заявки на кур’єрський забір.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Унікальний ідентифікатор статусу.","minimum":1},"pickupId":{"type":"integer","description":"Ідентифікатор заявки на кур’єрський забір.","minimum":1},"status":{"type":"string","description":"Поточний статус заявки на кур’єрський забір, що відображає етап її обробки.\n\nМожливі значення: Draft, Created, AppointedCourier, InProgress, Done, ClientCanceled, NotCompleted, Deleted, ReceivedByCourier.\n"},"dateTime":{"type":"string","format":"date-time","description":"Дата та час зміни статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"note":{"type":"string","description":"Необов’язкові примітки, пов’язані зі статусом.","maxLength":255,"nullable":true},"user":{"type":"string","description":"Ідентифікатор користувача, який змінив статус.","maxLength":50},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення запису статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"updatedAt":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення запису статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення запису статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true}}}},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення заявки на кур’єрський забір.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"updatedAt":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення заявки на кур’єрський забір.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення заявки на кур’єрський забір.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Створити заявку на кур’єрський забір"}}}}
```
## Оновити заявку на кур’єрський забір
> Цей метод використовується для оновлення даних уже створеної заявки на кур’єрський забір. Він дозволяє змінювати інформацію про заявку, зокрема адресу, контактні дані, часовий інтервал кур’єрського забору та інші параметри, щоб забезпечити коректний і своєчасний забір відправлень.\
> Метод доступний для бізнес-клієнтів у країнах ЄС, де працює Nova Post.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups/{id}":{"put":{"description":"Цей метод використовується для оновлення даних уже створеної заявки на кур’єрський забір. Він дозволяє змінювати інформацію про заявку, зокрема адресу, контактні дані, часовий інтервал кур’єрського забору та інші параметри, щоб забезпечити коректний і своєчасний забір відправлень.\nМетод доступний для бізнес-клієнтів у країнах ЄС, де працює Nova Post.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","tags":["Pickups"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","minimum":1},"description":"Унікальний ідентифікатор заявки на кур’єрський забір, яку потрібно оновити."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"note":{"type":"string","description":"Додаткові примітки або інструкції для кур’єра.","maxLength":255},"services":{"type":"array","items":{"type":"string"},"description":"Список додаткових послуг, які можна додати до заявки на кур’єрський забір. Наразі ця функціональність перебуває в розробці.","nullable":true},"phone":{"type":"string","description":"Контактний номер телефону відправника, необхідний для того, щоб кур’єр міг зв’язатися у разі потреби.","minLength":8,"maxLength":14},"email":{"type":"string","description":"Адреса електронної пошти. Не є обов’язковою, проте рекомендується як резервний спосіб зв’язку у випадку некоректного номера телефону або для отримання додаткових сповіщень щодо кур’єрського забору.","nullable":true},"fullName":{"type":"string","description":"Повне ім’я клієнта-відправника, необхідне для ідентифікації відправника та коректної обробки заявки на кур’єрський забір.","maxLength":100},"companyTin":{"type":"string","description":"ІПН юридичної особи.","minLength":2,"maxLength":20},"companyName":{"type":"string","description":"Назва компанії, яка створила заявку на кур’єрський забір.","minLength":2,"maxLength":255},"lockVersion":{"type":"integer","description":"Номер версії для запобігання конфліктам під час оновлення даних. При кожному наступному оновленні заявки значення цього параметра необхідно збільшувати на 1.","minimum":1},"countryCode":{"type":"string","description":"Код країни місця кур’єрського забору у форматі ISO Alpha-2.","pattern":"^[A-Z]{2}$"},"addressParts":{"type":"object","description":"Детальна інформація про адресу кур’єрського забору.","properties":{"city":{"type":"string","description":"Назва міста кур’єрського забору.","maxLength":100},"region":{"type":"string","description":"Назва області, регіону або адміністративно-територіальної одиниці кур’єрського забору.","maxLength":100},"street":{"type":"string","description":"Назва вулиці кур’єрського забору.","maxLength":100},"postCode":{"type":"string","description":"Поштовий індекс адреси кур’єрського забору.","maxLength":10},"building":{"type":"string","description":"Номер або назва будівлі за адресою кур’єрського забору.","maxLength":100},"flat":{"type":"string","description":"Номер квартири або офісу.","maxLength":10},"block":{"type":"string","description":"Номер корпусу, секції або блоку будівлі, якщо застосовується.","maxLength":100},"note":{"type":"string","description":"Додаткові інструкції для доступу кур’єра до місця кур’єрського забору.","maxLength":100}}},"pickedTimeFrom":{"type":"string","format":"date-time","description":"Початок часового інтервалу кур’єрського забору, вибраного зі списку доступних часових інтервалів, отриманих через відповідний метод.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true},"pickedTimeTo":{"type":"string","format":"date-time","description":"Кінець часового інтервалу кур’єрського забору, вибраного зі списку доступних часових інтервалів, отриманих через відповідний метод.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true}}}}}},"responses":{"200":{"description":"Заявку на кур’єрський забір успішно оновлено","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Унікальний ідентифікатор оновленої заявки на кур’єрський забір.","minimum":1},"number":{"type":"string","description":"Реєстраційний номер заявки на кур’єрський забір.","pattern":"^[A-Z]{4}\\d{10}$"},"status":{"type":"string","description":"Поточний статус заявки на кур’єрський забір, що відображає етап її обробки.\n\nМожливі значення:\n - **Draft**: Початковий етап, коли заявку створено, але ще не завершено її оформлення.\n - **Created**: Заявку створено та підготовлено до обробки.\n - **AppointedCourier**: Для заявки призначено кур’єра.\n - **InProgress**: Кур’єрський забір виконується.\n - **Done**: Кур’єрський забір успішно завершено.\n - **ClientCanceled**: Заявку скасовано клієнтом.\n - **NotCompleted**: Кур’єрський забір не вдалося виконати.\n - **Deleted**: Заявку видалено із системи.\n - **ReceivedByCourier**: Відправлення отримано кур’єром.\n"},"lockVersion":{"type":"integer","description":"Оновлений номер версії для запобігання конфліктам під час оновлення даних."},"note":{"type":"string","description":"Оновлені примітки для кур’єра.","maxLength":255},"pickedTimeFrom":{"type":"string","format":"date-time","description":"Оновлений початок часового інтервалу кур’єрського забору.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"pickedTimeTo":{"type":"string","format":"date-time","description":"Оновлений кінець часового інтервалу кур’єрського забору.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"addressParts":{"type":"object","description":"Оновлена інформація про адресу кур’єрського забору.","properties":{"city":{"type":"string","description":"Назва міста кур’єрського забору.","maxLength":100},"region":{"type":"string","description":"Назва області, регіону або адміністративно-територіальної одиниці кур’єрського забору.","maxLength":100},"street":{"type":"string","description":"Назва вулиці кур’єрського забору.","maxLength":100},"postCode":{"type":"string","description":"Поштовий індекс адреси кур’єрського забору.","maxLength":10},"building":{"type":"string","description":"Номер або назва будівлі за адресою кур’єрського забору.","maxLength":100},"flat":{"type":"string","description":"Номер квартири або офісу.","maxLength":10},"block":{"type":"string","description":"Номер корпусу, секції або блоку будівлі, якщо застосовується.","maxLength":100},"note":{"type":"string","description":"Додаткові інструкції для доступу кур’єра до місця кур’єрського забору.","maxLength":100}}},"statuses":{"type":"array","description":"Масив оновлених статусів заявки на кур’єрський забір.","items":{"type":"object"}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Оновити заявку на кур’єрський забір"}}}}
```
## Додати відправлення до заявки на кур’єрський забір
> Цей метод використовується для додавання вже створених відправлень до існуючої заявки на виклик кур'єра. Відповідно до встановленого бізнес-процесу, вже створені відправлення мають бути додані до заявки на виклик кур'єра після того, як її було створено.\
> Цей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Нова Пошта.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups/{id}/shipments":{"post":{"description":"Цей метод використовується для додавання вже створених відправлень до існуючої заявки на виклик кур'єра. Відповідно до встановленого бізнес-процесу, вже створені відправлення мають бути додані до заявки на виклик кур'єра після того, як її було створено.\nЦей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Нова Пошта.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","tags":["Pickups"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","minimum":1},"description":"Унікальний ідентифікатор заявки на кур’єрський забір, до якої додаються відправлення."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","items":{"type":"object","properties":{"shipmentId":{"type":"integer","description":"Унікальний ідентифікатор відправлення, яке необхідно додати.","minimum":1}},"required":["shipmentId"]},"description":"Список відправлень, які необхідно додати до заявки на кур’єрський забір."}}}}}},"responses":{"200":{"description":"Відправлення успішно додано до заявки на кур’єрський забір","content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Унікальний ідентифікатор запису відправлення у заявці на кур’єрський забір.","minimum":1},"pickupId":{"type":"integer","description":"Унікальний ідентифікатор пов’язаної заявки на кур’єрський забір.","minimum":1},"shipmentId":{"type":"integer","description":"Унікальний ідентифікатор доданого відправлення.","minimum":1},"status":{"type":"string","description":"Поточний статус відправлення в межах заявки на кур’єрський забір. Значення повертається системою та відображає поточний стан відправлення.\n\nМожливі значення: `Accepted`, `NotReady`, `NotPacked`, `ClientCanceled`, `Deleted`, `Added`.\n"},"note":{"type":"string","description":"Додаткові примітки щодо відправлення, якщо застосовується.","nullable":true},"deliveryPartners":{"type":"array","description":"Список партнерів доставки, пов’язаних із відправленням, якщо застосовується.","items":{"type":"object"}},"createdAt":{"type":"string","format":"date-time","description":"Дата та час додавання відправлення.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"updatedAt":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення запису відправлення.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення запису відправлення, якщо застосовується.","nullable":true}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Додати відправлення до заявки на кур’єрський забір"}}}}
```
## Оновити статус заявки на забір
> Цей метод дозволяє оновлювати статус наявної заявки на кур’єрський забір. Цей метод спеціально розроблений для переведення заявки на виклик кур'єра зі статусу \`Draft\` у статус \`Created\`.\
> \
> Поки заявка перебуває у статусі \`Draft\`, вона залишається на підготовчому етапі, під час якого можна додати всі необхідні відправлення. Щойно статус оновлюється на \`Created\`, система управління відправленнями розпізнає виклик кур'єра як завершений і готовий до обробки кур'єрською службою.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups/{id}/status":{"put":{"description":"Цей метод дозволяє оновлювати статус наявної заявки на кур’єрський забір. Цей метод спеціально розроблений для переведення заявки на виклик кур'єра зі статусу `Draft` у статус `Created`.\n\nПоки заявка перебуває у статусі `Draft`, вона залишається на підготовчому етапі, під час якого можна додати всі необхідні відправлення. Щойно статус оновлюється на `Created`, система управління відправленнями розпізнає виклик кур'єра як завершений і готовий до обробки кур'єрською службою.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","tags":["Pickups"],"parameters":[{"name":"id","in":"path","required":true,"description":"Унікальний ідентифікатор заявки на кур’єрський забір.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","description":"Використовується для оновлення статусу заявки на кур’єрський забір та підтвердження того, що її формування завершено і вона готова до обробки системою управління відправленнями.","enum":["Created"]},"lockVersion":{"type":"integer","description":"Номер версії для запобігання конфліктам під час оновлення даних. При кожному наступному оновленні заявки значення цього параметра необхідно збільшувати на 1.","minimum":1},"note":{"type":"string","description":"Обов’язкова примітка або коментар із додатковою інформацією щодо причини зміни статусу. Поле необхідно заповнювати під час зміни статусу для забезпечення належного відстеження та збереження контексту змін.","maxLength":255}},"required":["id","status","lockVersion"]}}}},"responses":{"200":{"description":"Статус успішно оновлено","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Визначає, чи було успішно оновлено статус заявки."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Оновити статус заявки на забір"}}}}
```
## Видалити заявку на виклик кур'єра
> Цей метод дозволяє бізнес-клієнтам повністю видалити існуючу заявку на виклик кур'єра. При видаленні заявки на виклик кур'єра вона позначається в системі як видалена, а також фіксується дата та час видалення.\
> Цей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Нова Пошта.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups/{id}":{"delete":{"description":"Цей метод дозволяє бізнес-клієнтам повністю видалити існуючу заявку на виклик кур'єра. При видаленні заявки на виклик кур'єра вона позначається в системі як видалена, а також фіксується дата та час видалення.\nЦей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Нова Пошта.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","tags":["Pickups"],"parameters":[{"in":"path","name":"id","required":true,"schema":{"type":"integer","minimum":1},"description":"Унікальний ідентифікатор заявки на кур’єрський забір, яку необхідно видалити."}],"responses":{"200":{"description":"Заявку на кур’єрський забір успішно видалено","content":{"application/json":{"schema":{"type":"object","properties":{"deletedAt":{"type":"string","format":"date-time","description":"Дата та час, коли заявку на кур’єрський забір було позначено як видалену.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Видалити заявку на виклик кур'єра"}}}}
```
## Отримати список заявок на кур’єрський забір
> Цей метод дозволяє бізнес-клієнтам отримати список усіх створених ними заявок на кур’єрський забір. Клієнти можуть фільтрувати список за окремими параметрами, наприклад за ідентифікатором кур’єрського забору або номером заявки.\
> \
> \*\*CourierPickupService\*\*:\\
> Ця послуга дозволяє бізнес-клієнтам замовляти платний кур'єрський забір без попереднього створення відправлень.\
> \
> \*\*Поведінка\*\*:\\
> Запит на забір із послугою \`CourierPickupService\` може бути переведений у статус \`Created\` без пов'язаних відправлень. Відправлення можуть бути додані пізніше після створення запиту на забір.\
> \
> \*\*Доступність\*\*:\\
> Послуга є обмеженою та доступна лише для авторизованих бізнес-акаунтів відповідно до індивідуальних умов договору. Наразі послуга доступна в Молдові.\
> \
> Цей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Nova Post.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups":{"get":{"tags":["Pickups"],"description":"Цей метод дозволяє бізнес-клієнтам отримати список усіх створених ними заявок на кур’єрський забір. Клієнти можуть фільтрувати список за окремими параметрами, наприклад за ідентифікатором кур’єрського забору або номером заявки.\n\n**CourierPickupService**:\nЦя послуга дозволяє бізнес-клієнтам замовляти платний кур'єрський забір без попереднього створення відправлень.\n\n**Поведінка**:\nЗапит на забір із послугою `CourierPickupService` може бути переведений у статус `Created` без пов'язаних відправлень. Відправлення можуть бути додані пізніше після створення запиту на забір.\n\n**Доступність**:\nПослуга є обмеженою та доступна лише для авторизованих бізнес-акаунтів відповідно до індивідуальних умов договору. Наразі послуга доступна в Молдові.\n\nЦей метод доступний для бізнес-клієнтів у країнах ЄС, де працює Nova Post.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","parameters":[{"in":"query","name":"numbers[]","description":"Пошук заявок на кур’єрський забір за номером документа. Може приймати як один номер для пошуку, так і масив номерів.","schema":{"type":"string"}},{"in":"query","name":"ids[]","description":"Список ідентифікаторів заявок на кур’єрський забір для пошуку. Може приймати як один ідентифікатор, так і масив ідентифікаторів.","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"serviceCodes[]","description":"Фільтрація запитів на забір за кодом послуги.\n\nДоступні значення:\n- CourierPickupService\n\nПовертає лише ті запити на забір, які містять зазначену послугу.\n","schema":{"type":"string"}},{"in":"query","name":"limit","description":"Максимальна кількість елементів, що повертаються на сторінці.","schema":{"type":"integer","format":"int32","default":15}},{"in":"query","name":"page","description":"Номер сторінки для повернення.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Список заявок на кур’єрський забір успішно отримано","content":{"application/json":{"schema":{"type":"object","properties":{"current_page":{"type":"integer","description":"Поточна сторінка результатів у пагінованій відповіді.","minimum":1},"last_page":{"type":"integer","description":"Остання доступна сторінка в пагінованій відповіді.","minimum":1},"per_page":{"type":"integer","description":"Кількість елементів на сторінці.","minimum":1},"total":{"type":"integer","description":"Загальна кількість заявок на кур’єрський забір, що відповідають критеріям фільтрації.","minimum":0},"items":{"type":"array","description":"Список заявок на кур’єрський забір.","items":{"type":"object","properties":{"id":{"type":"string","description":"Унікальний ідентифікатор заявки на кур’єрський забір.","minimum":1},"number":{"type":"string","description":"Реєстраційний номер заявки на кур’єрський забір.","pattern":"^[A-Z]{4}\\d{10}$"},"status":{"type":"string","description":"Поточний статус заявки на кур’єрський забір, що відображає етап її обробки.\n\nМожливі значення:\n - **Draft**: Початковий етап, коли заявку створено, але ще не завершено її оформлення.\n - **Created**: Заявку створено та підготовлено до обробки.\n - **AppointedCourier**: Для заявки призначено кур’єра.\n - **InProgress**: Кур’єрський забір виконується.\n - **Done**: Кур’єрський забір успішно завершено.\n - **ClientCanceled**: Заявку скасовано клієнтом.\n - **NotCompleted**: Кур’єрський забір не вдалося виконати.\n - **Deleted**: Заявку видалено із системи.\n - **ReceivedByCourier**: Відправлення отримано кур’єром.\n"},"statusDateTime":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"source":{"type":"string","description":"Джерело створення заявки (наприклад, API або вебінтерфейс)."},"executor":{"type":"string","description":"Ідентифікатор виконавця (кур’єра або служби)."},"companyTin":{"type":"string","description":"ІПН юридичної особи."},"companyName":{"type":"string","description":"Назва компанії, що створила заявку."},"fullName":{"type":"string","description":"Повне ім’я клієнта-відправника.","maxLength":100},"phone":{"type":"string","description":"Контактний номер телефону відправника.","minLength":8,"maxLength":14},"email":{"type":"string","description":"Контактна адреса електронної пошти, якщо вказана.","nullable":true},"countryCode":{"type":"string","description":"Код країни місця кур’єрського забору у форматі ISO Alpha-2.","pattern":"^[A-Z]{2}$"},"externalId":{"type":"string","description":"Зовнішній ідентифікатор заявки на кур’єрський забір, наданий клієнтом."},"createdByUser":{"type":"string","description":"Ідентифікатор користувача, який створив заявку."},"divisionId":{"type":"integer","description":"Ідентифікатор відділення, відповідального за обробку заявки."},"settlementId":{"type":"integer","description":"Ідентифікатор населеного пункту місця кур’єрського забору."},"cityDistrict":{"type":"string","description":"Район міста місця кур’єрського забору."},"deliveryPartner":{"type":"string","description":"Партнер доставки, який обробляє заявку."},"lockVersion":{"type":"integer","description":"Номер версії для запобігання конфліктам під час оновлення даних."},"address":{"type":"object","description":"Повна інформація про адресу.","properties":{"address":{"type":"string","description":"Повна адреса у відформатованому вигляді."},"latitude":{"type":"string","description":"Географічна широта місця кур’єрського забору."},"longitude":{"type":"string","description":"Географічна довгота місця кур’єрського забору."},"timeZoneId":{"type":"integer","description":"Внутрішній ідентифікатор часового поясу."},"timeZone":{"type":"string","description":"Часовий пояс місця кур’єрського забору, визначений за координатами."}}},"addressParts":{"type":"object","description":"Деталізовані складові адреси.","properties":{"postCode":{"type":"string","description":"Поштовий індекс місця кур’єрського забору.","maxLength":10},"building":{"type":"string","description":"Номер будівлі місця кур’єрського забору.","maxLength":100},"street":{"type":"string","description":"Назва вулиці місця кур’єрського забору.","maxLength":100},"city":{"type":"string","description":"Назва міста місця кур’єрського забору.","maxLength":100},"region":{"type":"string","description":"Назва регіону місця кур’єрського забору.","maxLength":100},"flat":{"type":"string","description":"Номер квартири або офісу.","maxLength":10},"note":{"type":"string","description":"Додаткові примітки щодо адреси.","maxLength":100},"block":{"type":"string","description":"Корпус або секція будівлі.","maxLength":100,"nullable":true}}},"pickedTimeFrom":{"type":"string","format":"date-time","description":"Початок часового інтервалу кур’єрського забору, вказаного у заявці.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true},"pickedTimeTo":{"type":"string","format":"date-time","description":"Кінець часового інтервалу кур’єрського забору, вказаного у заявці.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true},"currencyCode":{"type":"string","description":"Код валюти країни, що використовується для платіжних операцій.","pattern":"^[A-Z]{3}$"},"shipments":{"type":"array","items":{"type":"object"},"description":"Список відправлень, пов’язаних із цією заявкою на кур’єрський забір."},"services":{"type":"array","description":"Список додаткових послуг, пов'язаних із запитом на забір.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Унікальний ідентифікатор послуги."},"shipmentParcelRowNumber":{"type":"string","description":"Номер рядка місця відправлення, пов'язаного з послугою.","nullable":true},"serviceId":{"type":"string","description":"Внутрішній ідентифікатор послуги."},"pickupId":{"type":"integer","description":"Ідентифікатор запиту на забір."},"serviceType":{"type":"string","description":"Внутрішній тип послуги."},"serviceName":{"type":"string","description":"Назва послуги.","nullable":true},"serviceCode":{"type":"string","description":"Код послуги."},"parcelNumber":{"type":"string","description":"Номер пов'язаного відправлення.","nullable":true},"payerType":{"type":"string","description":"Сторона, відповідальна за оплату."},"contractNumber":{"type":"string","description":"Номер договору, який використовується для оплати послуги."},"amount":{"type":"number","description":"Кількість послуги."},"price":{"type":"number","description":"Вартість послуги до застосування знижок."},"discount":{"type":"number","description":"Сума застосованої знижки."},"cost":{"type":"number","description":"Підсумкова вартість послуги."},"costBeforeCheck":{"type":"boolean","description":"Вказує, чи була вартість розрахована до виконання перевірки."},"paymentStatus":{"type":"string","description":"Поточний статус оплати."},"currencyCode":{"type":"string","description":"Код валюти відповідно до стандарту ISO 4217."},"executionAt":{"type":"string","format":"date-time","description":"Дата та час виконання послуги."},"additionalParameters":{"type":"object","description":"Планові параметри вантажу, передані для послуги CourierPickupService.","properties":{"parcel_description":{"type":"string","description":"Опис вантажу."},"parcels_amount":{"type":"number","description":"Планова кількість місць."},"total_actual_weight":{"type":"number","description":"Загальна планова фактична вага."},"total_volumetric_weight":{"type":"number","description":"Загальна планова об'ємна вага."},"length":{"type":"number","description":"Планова довжина вантажу."},"width":{"type":"number","description":"Планова ширина вантажу."},"height":{"type":"number","description":"Планова висота вантажу."}}}}}},"statuses":{"type":"array","description":"Масив об’єктів статусів, що відстежують зміни статусу заявки на кур’єрський забір.","items":{"type":"object","properties":{"id":{"type":"integer","description":"Унікальний ідентифікатор статусу.","minimum":1},"pickupId":{"type":"integer","description":"Ідентифікатор заявки на кур’єрський забір.","minimum":1},"status":{"type":"string","description":"Поточний статус заявки на кур’єрський забір, що відображає етап її обробки.\n\nМожливі значення: Draft, Created, AppointedCourier, InProgress, Done, ClientCanceled, NotCompleted, Deleted, ReceivedByCourier.\n"},"dateTime":{"type":"string","format":"date-time","description":"Дата та час оновлення статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"note":{"type":"string","description":"Необов’язкові примітки, пов’язані зі статусом.","maxLength":255,"nullable":true},"user":{"type":"string","description":"Ідентифікатор користувача, який змінив статус.","maxLength":50},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення запису статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"updatedAt":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення запису статусу.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$"},"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення запису статусу, якщо застосовується.","pattern":"^20[0-9]{2}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{6}Z$","nullable":true}}}},"createdAt":{"type":"string","format":"date-time","description":"Дата та час створення заявки на кур’єрський забір."},"updatedAt":{"type":"string","format":"date-time","description":"Дата та час останнього оновлення заявки на кур’єрський забір."},"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення заявки на кур’єрський забір, якщо застосовується.","nullable":true}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Отримати список заявок на кур’єрський забір"}}}}
```
## Видалити відправлення із заявки на забір
> Цей метод дозволяє видаляти конкретні відправлення з наявної заявки на кур’єрський забір.\
> \
> 🔹\*\*Опис елементів керування:\*\*\
> \
> \*\*SCHEMA\*\*\
> \
> Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\
> \- \*\*Single line description\*\*\\
> Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\
> \- \*\*Multiline description\*\*\\
> Розширений опис, що відображає більше одного рядка тексту.\
> \
> \*\*EXAMPLE\*\*\
> \
> Показує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.
```json
{"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Pickups"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT-токен авторизації зі строком дії 1 годину у заголовку"}},"responses":{"Unauthorized":{"description":"Неавторизований доступ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Вказаний ресурс не знайдено","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Помилка валідації","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Час очікування з’єднання вичерпано","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/pickups/{id}/shipments":{"delete":{"description":"Цей метод дозволяє видаляти конкретні відправлення з наявної заявки на кур’єрський забір.\n\n🔹**Опис елементів керування:**\n\n**SCHEMA**\n\nВідображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.\n- **Single line description**\n Опис, що вміщується в один рядок; текст, який не поміщається, залишається прихованим.\n- **Multiline description**\n Розширений опис, що відображає більше одного рядка тексту.\n \n**EXAMPLE**\n\nПоказує готовий приклад JSON із правильно сформованими значеннями для демонстрації того, як має виглядати валідний запит або відповідь.\n","tags":["Pickups"],"parameters":[{"name":"id","in":"path","required":true,"description":"Унікальний ідентифікатор заявки на кур’єрський забір.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","description":"Список відправлень, які необхідно видалити із заявки на кур’єрський забір.","items":{"type":"object","properties":{"shipmentId":{"type":"integer","description":"Унікальний ідентифікатор відправлення, яке необхідно видалити.","minimum":1}}}}}}}}},"responses":{"200":{"description":"Відправлення успішно видалено","content":{"application/json":{"schema":{"type":"object","properties":{"shipments":{"type":"array","description":"Інформація про видалені відправлення","items":{"type":"object","properties":{"deletedAt":{"type":"string","format":"date-time","description":"Дата та час видалення відправлення."}}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}},"summary":"Видалити відправлення із заявки на забір"}}}}
```
---
# 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:
```
GET https://api-portal.novapost.com/metodi-1/metodi/readme/kuryerska-dostavka.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.