Sign in
ShipmentApi

Create Shipment

Initiates the creation of a new shipment with the provided details, including sender and recipient information. This is the primary method for registering shipments into the system.

post/createshipment

Request body

senderIDinteger nullable

Registered sender account ID. Can't be used with Sender field. If null Sender is not given, the authenticated customer's default sender is used.

cosigneeNotifyType'NoNotifications' | 'Email' | 'SMS' | 'Both'

0 = NoNotifications, 1 = Email, 2 = SMS, 3 = Both

isSenderNonCustomerboolean nullable

Set to true when the shipment is remote pickup

deliveryParcelLockerstring nullable

Target parcel locker code for last-mile delivery. Mutually exclusive with DeliveryParcelShop.

dropOffParcelLockerstring nullable

Parcel locker code where the sender will drop off the shipment. Mutually exclusive with DropOffParcelShop.

numberOfColliesinteger nullable

Number of packages (collies) in the shipment (max 999). Can't be used with Collies field

unitType'Weight' | 'Pallet' | 'Value' | 'Quantity' | 'PalletWeight' | 'Letter' | 'BoxA' | 'BoxB' | 'BoxC' | 'XLBox' | 'WeightPerUnit' | 'None' | 'All'

0 = Weight, 4 = Pallet, 5 = Value, 7 = Quantity, 11 = PalletWeight, 12 = Letter, 13 = BoxA, 14 = BoxB, 15 = BoxC, 16 = XLBox, 17 = WeightPerUnit, -999 = None, -1 = All

unitAmountnumber double nullable

Unit amount for shipment-level pricing. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).

ref1string nullable

Reference 1 value for the shipment (max 35 characters).

ref2string nullable

Reference 2 value for the shipment (max 35 characters).

ref3string nullable

Reference 3 value for the shipment (max 35 characters).

refIntstring nullable

International reference for the shipment (max 35 characters).

exWorksTypeinteger nullable

Ex-works collection type identifier. Must be 4 (PaidByReceiver)

codValuenumber double nullable

Cash-on-delivery amount to collect from the consignee. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).

codCurrencyinteger nullable

Currency code for the cash-on-delivery amount. Required when CODValue is set.

codIbanstring nullable

IBAN of the bank account to which COD funds will be transferred.

codBicSwiftstring nullable

BIC/SWIFT code for the COD bank transfer. Required for international IBAN accounts.

dopServiceboolean

Package Opening Allowed service

cargoboolean

Marks the shipment as cargo type, applying cargo-specific handling and routing rules.

returnDocumentboolean

Attaches a return document to the shipment. The consignee must sign it upon delivery and it is returned to sender.

remarkstring nullable

Shipment contents description or general remark (max 150 characters).

pickupRemarkstring nullable

Remark for the courier regarding shipment pickup (max 255 characters).

deliveryRemarkstring nullable

Remark for the courier regarding shipment delivery (max 255 characters).

prefferedPickupTimestring date-time nullable

Preferred pickup date and time. The system assigns the nearest available slot if the requested time is unavailable.

dropOffParcelShopstring nullable

Parcel shop code where the sender will drop off the shipment. Mutually exclusive with DropOffParcelLocker.

deliveryParcelShopstring nullable

Target parcel shop code for last-mile delivery. Mutually exclusive with DeliveryParcelLocker.

pdfAttachmentBase64string nullable

Base64-encoded PDF document to attach to the shipment. It is only used for commissioning shipments.

commissionType'None' | 'Document' | 'Item' | 'DocumentAndItem'

0 = None, 1 = Document, 2 = Item, 3 = DocumentAndItem

noStickerboolean nullable

When true, suppresses label/sticker generation for this shipment.

insuranceValuenumber double nullable

Declared monetary value of the shipment for insurance purposes. Decimal numbers must use a dot (.) as the separator (e.g., 1234.56).

insuranceCurrency'National' | 'Euro' | 'CurrencyOfDestinationCountry' | 'MobilePaymentService' | 'CreditCard' | 'ReturnCashCRC'

0 = National, 1 = Euro, 2 = CurrencyOfDestinationCountry, 3 = MobilePaymentService, 4 = CreditCard, 5 = ReturnCashCRC

returnDeliveredboolean

When true, the shipment is returned to sender automatically after a successful delivery confirmation.

deliveryUntil12boolean

When true, Requests delivery before 12:00 noon. Subject to service availability in the delivery area.

documentCollectionboolean

Set true for Document collection service.

eDocumentCollectionboolean

Set true for Electronic document collection service.

personalDeliveryboolean

Set true for Personal delivery Service

saturdayDeliveryboolean

Set true for Saturday delivery service

flexServiceboolean

Set true for Flex Service

guaranteedDeliveryboolean

Set true for Guaranteed delivery service

virtualShipmentboolean

Set true for Virtual shipment service

isAutoRedirectRequestedboolean

When true, the system automatically redirects the shipment to an parcelshop/parcellocker location within an available distance. Customer should be allowed to use this action

Response

OK

status'OK' | 'Error' | 'ValidationFailed'

0 = OK, 1 = Error, 2 = ValidationFailed

shipmentidinteger

ID of the created shipment. Use this value with ShipmentsById to retrieve full shipment details.

pickuptimestring nullable

Assigned pickup start time. May change if the shipment is committed or pickup is requested at a later date.

pickupendtimestring date-time nullable

Assigned pickup end time. May change if the shipment is committed or pickup is requested at a later date.

deliverytimestring nullable

Expected delivery start time, calculated based on the assigned pickup window.

deliveryendtimestring nullable

Expected delivery end time, calculated based on the assigned pickup window.

cargoIDsstring[] nullable

List of cargo IDs assigned to this shipment. Populated only for cargo-type shipments.

traceIDstring nullable

Correlation trace ID for this API call. Include this value when reporting issues for faster diagnosis.

Changes