Skip to main content
POST
/
api
/
documents
/
{order_id}
Attach documents to an order
curl --request POST \
  --url https://api.retailreadyai.com/api/documents/{order_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'metadata=[{"type":"carton_labels","file_format":"PDF"},{"type":"pallet_labels","file_format":"PDF"}]' \
  --form carton_labels='@example-file' \
  --form pallet_labels='@example-file' \
  --form packing_list='@example-file' \
  --form bill_of_lading='@example-file' \
  --form other='@example-file'
{
  "message": "Documents uploaded successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
order_id
string
required

The ID of the order to attach the documents to

Body

​
metadata
string
required

Stringified JSON array describing the files to be uploaded. Allowed types: packing_list, bill_of_lading, carton_labels, pallet_labels, other. Only the files referenced in this array are required in the form-data. Example: [{"type":"packing_list","file_format":"PDF"},{"type":"carton_labels","file_format":"PDF"}]

​
carton_labels
file

PDF file for carton labels. Only required if referenced in metadata.

​
pallet_labels
file

PDF file for pallet labels. Only required if referenced in metadata.

​
packing_list
file

PDF file for packing list. Only required if referenced in metadata.

​
bill_of_lading
file

PDF file for bill of lading. Only required if referenced in metadata.

​
other
file

PDF file for other document type. Only required if referenced in metadata.

Response

Successfully uploaded documents

​
message
string

Success message