curl --request POST \
--url https://omnicommerce.sg/api/v1/orders/picking-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orderIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({orderIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};
fetch('https://omnicommerce.sg/api/v1/orders/picking-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/orders/picking-list"
payload = { "orderIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "completed",
"data": {
"success": true,
"orderIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"succeededCount": 4503599627370495,
"failedCount": 4503599627370495,
"documentIds": [
"<string>"
],
"documentId": "<string>",
"fileName": "<string>",
"mimeType": "application/pdf",
"downloadUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"results": [
{
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success": true
}
],
"list": {
"storeLabel": "<string>",
"userLabel": "<string>",
"printedAtLabel": "<string>",
"orderQuantity": 123,
"productQuantity": 123,
"itemQuantity": 123,
"rows": [
{
"productName": "<string>",
"imageUrl": "<string>",
"sku": "<string>",
"variation": "<string>",
"priceLabel": "<string>",
"quantity": 123,
"orderIds": [
"<string>"
]
}
]
}
},
"links": {},
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
]
}Create Picking List
Authorization
Requires orders:read. API keys resolve organization scope from their credential; session callers include organizationId.
PDF output
Create a private PDF picking list for 1–500 order UUIDs, trimmed and deduplicated in first-requested order. Missing or inaccessible orders fail the complete selection without creating a partial document. The same grouping, product quantities, SKU/variation and currency-labeled prices as the workspace Orders page are used. timeZone accepts an IANA time zone; omitted API requests use UTC. This does not arrange shipment or change orders.
The result contains structured list data, every orderId, a saved documentId and a signed HTTPS downloadUrl valid until expiresAt (five minutes). Generate a fresh list for a new download URL. Download the PDF and send it to your own printer; the API does not control local printers. PDF rendering may take up to 120 seconds.
curl --request POST \
--url https://omnicommerce.sg/api/v1/orders/picking-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"orderIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({orderIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']})
};
fetch('https://omnicommerce.sg/api/v1/orders/picking-list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/orders/picking-list"
payload = { "orderIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "<string>",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "completed",
"data": {
"success": true,
"orderIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"succeededCount": 4503599627370495,
"failedCount": 4503599627370495,
"documentIds": [
"<string>"
],
"documentId": "<string>",
"fileName": "<string>",
"mimeType": "application/pdf",
"downloadUrl": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"results": [
{
"orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"success": true
}
],
"list": {
"storeLabel": "<string>",
"userLabel": "<string>",
"printedAtLabel": "<string>",
"orderQuantity": 123,
"productQuantity": 123,
"itemQuantity": 123,
"rows": [
{
"productName": "<string>",
"imageUrl": "<string>",
"sku": "<string>",
"variation": "<string>",
"priceLabel": "<string>",
"quantity": 123,
"orderIds": [
"<string>"
]
}
]
}
},
"links": {},
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
]
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Body
1 - 500 elements^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$100Session callers only. API keys resolve organization scope from the credential.
1 - 120Response
Request completed. Inspect data.success, per-target results and pendingCount for processing progress.