curl --request POST \
--url https://omnicommerce.sg/api/v1/orders/{orderId}/actions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://omnicommerce.sg/api/v1/orders/{orderId}/actions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/orders/{orderId}/actions"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"jobId": "<string>",
"jobStatus": "<string>",
"duplicate": true
},
"jobId": "<string>",
"productId": "<string>"
}{
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"jobId": "<string>",
"jobStatus": "<string>",
"duplicate": true
},
"jobId": "<string>",
"productId": "<string>"
}Queue Order Action
Ship, cancel, generate shipping labels for, or update tracking on a marketplace order. Requires orders:write.
The marketplace call runs in the background: the response is 202 with jobId; poll GET /api/v1/orders/{orderId}/actions. A repeated idempotencyKey returns 200 with the original job.
curl --request POST \
--url https://omnicommerce.sg/api/v1/orders/{orderId}/actions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://omnicommerce.sg/api/v1/orders/{orderId}/actions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://omnicommerce.sg/api/v1/orders/{orderId}/actions"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"jobId": "<string>",
"jobStatus": "<string>",
"duplicate": true
},
"jobId": "<string>",
"productId": "<string>"
}{
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"jobId": "<string>",
"jobStatus": "<string>",
"duplicate": true
},
"jobId": "<string>",
"productId": "<string>"
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Path Parameters
Body
ship arranges shipment, labels generates shipping labels, update_tracking sends a tracking number, and cancel cancels the order.
ship, cancel, labels, update_tracking Required for session auth. API keys already belong to one organization.
1 - 120Marketplace inputs for the action. Send the payload of the choice returned by GET /api/v1/orders/{orderId}/action-options, plus fields such as trackingNumber or cancelReason when a choice requires input.
Show child attributes
Show child attributes
Repeat a request with the same key to get the original job instead of a second marketplace call.
1 - 160Response
The idempotency key matched an existing job.
"developer_v1"accepted, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes