Skip to main content
POST
/
orders
/
{orderId}
/
attachments
Upload file
curl --request POST \
  --url https://api.quivo.co/orders/{orderId}/attachments \
  --header 'Content-Type: application/json' \
  --data '
{
  "printerType": "LABEL_PRINTER",
  "attachmentPlacement": "INSIDE_PACKAGE",
  "copyCount": 2,
  "filename": "<string>",
  "printingType": "ORDER",
  "fileKey": "<string>",
  "mimeType": "<string>"
}
'
{
  "printerType": "LABEL_PRINTER",
  "attachmentPlacement": "INSIDE_PACKAGE",
  "copyCount": 2,
  "filename": "<string>",
  "printingType": "ORDER",
  "fileKey": "<string>",
  "mimeType": "<string>",
  "id": 123,
  "url": {
    "link": "<string>"
  }
}

Path Parameters

​
orderId
integer<int64>
required

The unique identifier for an order.

Body

application/json

Request body data for Upload file

Request payload for attaching a file to an order. Contains file reference and optional metadata for associating documents with an order.

​
printerType
enum<string>
required

Printer type, which should be used for printing the document in the warehouse

Available options:
LABEL_PRINTER,
DOCUMENT_PRINTER,
DOCUMENT_PRINTER_2_A6,
DOCUMENT_PRINTER_2_FOLIO
​
attachmentPlacement
enum<string>
required

Where the attached document should be placed in regard to the parcel

Available options:
INSIDE_PACKAGE,
OUTSIDE_PACKAGE
​
copyCount
integer<int32>
required

Number of times the attachment should be printed per shipment

Required range: x >= 1
​
filename
string

Name for the attachment. This name will be displayed in the attachments section for the given order

​
printingType
enum<string>

If the attached document should be printed per order or per shipment

Available options:
ORDER,
SHIPMENT
​
fileKey
string

Identifier of the file to be attached.

​
mimeType
string

Mime type of the file

Response

Returns the attached file information with assigned identifier and file details for the order.

Order attachment information. Contains attachment metadata and file references associated with an order.

​
printerType
enum<string>
required

Printer type, which should be used for printing the document in the warehouse

Available options:
LABEL_PRINTER,
DOCUMENT_PRINTER,
DOCUMENT_PRINTER_2_A6,
DOCUMENT_PRINTER_2_FOLIO
​
attachmentPlacement
enum<string>
required

Where the attached document should be placed in regard to the parcel

Available options:
INSIDE_PACKAGE,
OUTSIDE_PACKAGE
​
copyCount
integer<int32>
required

Number of times the attachment should be printed per shipment

Required range: x >= 1
​
filename
string

Name for the attachment. This name will be displayed in the attachments section for the given order

​
printingType
enum<string>

If the attached document should be printed per order or per shipment

Available options:
ORDER,
SHIPMENT
​
fileKey
string

Key or identifier

​
mimeType
string

The type or category of the mime

​
id
integer<int64>

The unique identifier for the id

​
url
object

URL link reference. Contains link URL and optional metadata.