uploadOrderDocument - Upload order document

Request

Description

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

Call Frequency

Recommended usage: On each new document on the order

Maximum usage: On each new document on the order

Security

Bearer(Required scopes: )

Path

channel_order_idstringrequired

Order identifier from the channel

Example:COMMERCIAL_ID-A

Bodymultipart/form-datarequired

filestring, (binary)required

The document file to upload.

Maximum file size: 10 MB.

Supported formats are :

PDF
JPEG
PNG
CSV

metadataobjectrequired

originobjectrequired

curl -i -X POST \
  https://miraklconnect.com/api/channel-platform/v1/orders/{channel_order_id}/documents \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@path/to/file' \
  -F 'origin="{\"channel_id\":\"string\",\"channel_store_id\":\"string\",\"sub_channel_code\":\"string\"}";type=application/json' \
  -F 'metadata="{\"channel_document_id\":\"string\",\"filename\":\"UPS_1Z999AA10123456784.pdf\",\"type\":\"RETURN_LABEL\",\"channel_type\":\"string\",\"entity\":{\"id\":\"caf30673-ea3d-4113-9a18-674850f6a290\",\"type\":\"RETURN\"}}";type=application/json'

Responses

No Content

Response

No content