Sign in
latestOpenAPI 3.0.02026-08-10234193.3 KB

60e380005037

Shipments

Shipments uploads file

Uploads supporting documents to a specific shipment by its ID. This method is used for attaching invoices, product specifications, customs declarations, or other shipment-related documents required for processing and clearance. Files are stored and linked to the shipment, ensuring better traceability and compliance.

⚠️ Region restriction:</br> This method is available only for European shipments (EU/EU and EU/UA directions).</br> It is not available for shipments originating from Ukraine.

File naming: • If the "fileName" parameter is provided, the uploaded file will be stored with that name. • If "fileName" is not provided, the default file name will be set to "invoice".

Use cases:

  1. "I want to upload a client invoice in PDF to shipment 980911" - send the base64-encoded content in "file", set "fileName": "invoice.pdf".
  2. "I want to attach a product photo in JPEG" - encode the photo in base64, set "fileName": "product-photo.jpeg".
post/shipments/attachments/uploads/{id}

Path parameters

idinteger required

Unique identifier of the shipment to which the files are attached.</br> This value represents the shipmentId of the European system.</br> Using a Ukrainian shipment number will result in a validation error.

Request body

filestring

Base64-encoded document file (PDF, JPEG, or other supported formats).

fileNamestring

Optional file name. Defaults to "invoice" if not provided.

Response

File upload result

successboolean

Indicates whether the file upload was successful.