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'import requests
url = "https://api.retailreadyai.com/api/documents/{order_id}"
files = {
"carton_labels": ("example-file", open("example-file", "rb")),
"pallet_labels": ("example-file", open("example-file", "rb")),
"packing_list": ("example-file", open("example-file", "rb")),
"bill_of_lading": ("example-file", open("example-file", "rb")),
"other": ("example-file", open("example-file", "rb"))
}
payload = { "metadata": "[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('metadata', '[{"type":"carton_labels","file_format":"PDF"},{"type":"pallet_labels","file_format":"PDF"}]');
form.append('carton_labels', '@/path/to/carton_labels.pdf');
form.append('pallet_labels', '@/path/to/pallet_labels.pdf');
form.append('packing_list', '{
"fileName": "example-file"
}');
form.append('bill_of_lading', '{
"fileName": "example-file"
}');
form.append('other', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.retailreadyai.com/api/documents/{order_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.retailreadyai.com/api/documents/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.retailreadyai.com/api/documents/{order_id}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.retailreadyai.com/api/documents/{order_id}")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.retailreadyai.com/api/documents/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"message": "Documents uploaded successfully"
}{
"message": "Invalid Request - Missing required fields",
"error": {
"code": "INVALID_REQUEST"
}
}{
"message": "Failed to upload documents",
"error": {
"code": "INTERNAL_SERVER_ERROR"
}
}Attach documents to an order
Attach carton and pallet label PDFs to an existing order using multipart/form-data. The metadata field should be a stringified JSON array describing the files.
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'import requests
url = "https://api.retailreadyai.com/api/documents/{order_id}"
files = {
"carton_labels": ("example-file", open("example-file", "rb")),
"pallet_labels": ("example-file", open("example-file", "rb")),
"packing_list": ("example-file", open("example-file", "rb")),
"bill_of_lading": ("example-file", open("example-file", "rb")),
"other": ("example-file", open("example-file", "rb"))
}
payload = { "metadata": "[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('metadata', '[{"type":"carton_labels","file_format":"PDF"},{"type":"pallet_labels","file_format":"PDF"}]');
form.append('carton_labels', '@/path/to/carton_labels.pdf');
form.append('pallet_labels', '@/path/to/pallet_labels.pdf');
form.append('packing_list', '{
"fileName": "example-file"
}');
form.append('bill_of_lading', '{
"fileName": "example-file"
}');
form.append('other', '{
"fileName": "example-file"
}');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.retailreadyai.com/api/documents/{order_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.retailreadyai.com/api/documents/{order_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.retailreadyai.com/api/documents/{order_id}"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.retailreadyai.com/api/documents/{order_id}")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.retailreadyai.com/api/documents/{order_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"metadata\"\r\n\r\n[{\"type\":\"carton_labels\",\"file_format\":\"PDF\"},{\"type\":\"pallet_labels\",\"file_format\":\"PDF\"}]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"carton_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/carton_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"pallet_labels\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n@/path/to/pallet_labels.pdf\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"packing_list\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bill_of_lading\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"other\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"message": "Documents uploaded successfully"
}{
"message": "Invalid Request - Missing required fields",
"error": {
"code": "INVALID_REQUEST"
}
}{
"message": "Failed to upload documents",
"error": {
"code": "INTERNAL_SERVER_ERROR"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The ID of the order to attach the documents to
Body
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"}]
PDF file for carton labels. Only required if referenced in metadata.
PDF file for pallet labels. Only required if referenced in metadata.
PDF file for packing list. Only required if referenced in metadata.
PDF file for bill of lading. Only required if referenced in metadata.
PDF file for other document type. Only required if referenced in metadata.
Response
Successfully uploaded documents
Success message

