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

Repeat Delivery

Create Repeat Delivery

post
/shipments/modification/repeat-delivery

This method creates a Repeat Delivery request for a shipment that is currently stored at a long-term storage warehouse (LTS).

Key rules:

  • Available only for shipments currently at long-term storage (LTS).

  • A maximum of 4 completed Repeat Delivery services is allowed per shipment.

  • A Repeat Delivery service cannot be ordered if the shipment already has a Redirecting, Return, or Repeat Delivery request in the NeedProcessing or InProgress status.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Body
shipmentIdintegerRequired

ID of the shipment at long-term storage.

🔻This field is required.

payerTypestring · enum · nullableOptional

Identifies who is responsible for payment of the repeat delivery service.

Allowed values:

  • Sender
  • Recipient
  • ThirdPerson

If the field is not provided, the order creator pays for the service.

Possible values:
payerContractNumberstring · nullableOptional

Required for B2B clients (legal entities with contract payment).

notestringOptional

Any comment to the order.

Responses
200

Repeat Delivery order successfully created.

application/json
costnumberOptional

Delivery cost for the repeat delivery service.

currencystringOptional

Currency code according to ISO 4217.

currencySymbolstringOptional

Currency symbol.

scheduledDeliveryDatestring · date-timeOptional

Estimated delivery date in ISO 8601 format.

post/shipments/modification/repeat-delivery

Cancel Repeat Delivery

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

The method cancels the current active Repeat Delivery request associated with the specified shipment.

Use this method when you need to cancel a repeat delivery request that has not yet been processed. Cancellation is available only while the repeat delivery order is still being processed.

Key rules:

  • Cancellation is available only while the repeat delivery order is still being processed.

  • Once a repeat delivery has been completed, it cannot be cancelled.

🔹Description of control elements:

SCHEMA

Displays the full technical structure of the request or response, including field names, data types, required fields, allowed values, and validation rules.

  • Single line description A description that fits into a single line; any text that does not fit remains hidden.

  • Multiline description An expanded description that displays more than one line of text.

EXAMPLE

Shows a ready-made sample JSON with correctly formatted values to demonstrate how a valid request or response should look.

Authorizations
AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Path parameters
shipmentIDintegerRequired

The ID of the shipment for which the Repeat Delivery order should be cancelled.

Example: 440459
Responses
200

Repeat Delivery order successfully cancelled. Returns the cancellation timestamp.

application/json
deletedAtstringRequired

Timestamp when the Repeat Delivery order was cancelled.

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}

Last updated