MImirakl
Orders

uploadOrderDocument - Upload order document

<div class="extension-title">Description</div>

Use this API to upload a document for an order or its related entities (e.g. returns).

<div class="api-description-extension"> <div class="extension-title">Call Frequency</div> <div class="recommended-call-frequency">Recommended usage: On each new document on the order</div> <div class="max-call-frequency">Maximum usage: On each new document on the order</div> </div>
post/v1/orders/{channel_order_id}/documents

Request

Path parameters

channel_order_idstring required

Order identifier from the channel

Request body multipart/form-data

filestring binary required

The document file to upload.

Maximum file size: <code>10 MB</code>.

Supported formats are : - <code>PDF</code> - <code>JPEG</code> - <code>PNG</code> - <code>CSV</code>

Example request

{
  "metadata": {
    "entity": {
      "id": "caf30673-ea3d-4113-9a18-674850f6a290"
    },
    "filename": "UPS_1Z999AA10123456784.pdf"
  }
}

Response

No Content

Changes

No recorded changes to this operation across all 9 revisions of this API.