For the complete documentation index, see llms.txt. This page is also available as Markdown.

Повторна доставка

Створити повторну доставку

post
/shipments/modification/repeat-delivery

Цей метод створює запит на повторну доставку для відправлення, яке наразі зберігається на складі довгострокового зберігання (LTS).

Основні правила:

  • Доступний лише для відправлень, які наразі перебувають на довгостроковому зберіганні (LTS).

  • Для одного відправлення дозволено не більше 4 завершених послуг повторної доставки.

  • Послугу повторної доставки не можна замовити, якщо для відправлення вже існує запит на переадресацію (Redirecting), повернення (Return) або повторну доставку (Repeat Delivery) зі статусом NeedProcessing або InProgress.

🔹Опис елементів керування:

SCHEMA Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.

  • Single line description Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.

  • Multiline description Розширений опис, який відображає більше одного рядка тексту.

EXAMPLE Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.

Authorizations
AuthorizationstringRequired

JWT-токен авторизації зі строком дії 1 годину у заголовку

Body
shipmentIdintegerRequired

Ідентифікатор відправлення на довгостроковому зберіганні.

🔻Це поле є обов'язковим.

payerTypestring · enum · nullableOptional

Визначає, хто відповідає за оплату послуги повторної доставки.

Допустимі значення:

  • Sender
  • Recipient
  • ThirdPerson

Якщо поле не передано, послугу оплачує користувач, який створює замовлення.

Possible values:
payerContractNumberstring · nullableOptional

Обов'язковий параметр для B2B-клієнтів (юридичних осіб з оплатою за договором).

notestringOptional

Будь-який коментар до замовлення.

Responses
200

Запит на повторну доставку успішно створено.

application/json
costnumberOptional

Вартість послуги повторної доставки.

currencystringOptional

Код валюти відповідно до стандарту ISO 4217.

currencySymbolstringOptional

Символ валюти.

scheduledDeliveryDatestring · date-timeOptional

Орієнтовна дата доставки у форматі ISO 8601.

post/shipments/modification/repeat-delivery

Скасувати повторну доставку

delete
/shipments/modification/repeat-delivery/delete/{shipmentID}

Цей метод скасовує поточний активний запит на повторну доставку, пов'язаний із зазначеним відправленням.

Використовуйте цей метод, якщо необхідно скасувати запит на повторну доставку, який ще не було оброблено. Скасування доступне лише доти, доки замовлення на повторну доставку ще перебуває в обробці.

Основні правила:

  • Скасування доступне лише доти, доки замовлення на повторну доставку ще перебуває в обробці.

  • Після завершення повторної доставки її неможливо скасувати.

🔹Опис елементів керування:

SCHEMA Відображає повну технічну структуру запиту або відповіді, включаючи назви полів, типи даних, обов’язкові поля, допустимі значення та правила валідації.

  • Single line description Опис, який вміщується в один рядок; текст, що не вміщується, залишається прихованим.

  • Multiline description Розширений опис, який відображає більше одного рядка тексту.

EXAMPLE Показує готовий приклад JSON з коректно заповненими значеннями, щоб продемонструвати, як має виглядати валідний запит або відповідь.

Authorizations
AuthorizationstringRequired

JWT-токен авторизації зі строком дії 1 годину у заголовку

Path parameters
shipmentIDintegerRequired

Ідентифікатор відправлення, для якого необхідно скасувати замовлення на повторну доставку.

Example: 440459
Responses
200

Замовлення на повторну доставку успішно скасовано. Повертає часову позначку скасування.

application/json
deletedAtstringRequired

Часова позначка, коли замовлення на повторну доставку було скасовано.

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$
delete/shipments/modification/repeat-delivery/delete/{shipmentID}

Останнє оновлення