Get Order Action Options
curl --request GET \
--url https://omnicommerce.sg/api/v1/orders/{orderId}/action-options \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/orders/{orderId}/action-options', 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}/action-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"action": "ship",
"choices": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"payload": {},
"requiresInput": true
}
]
},
"jobId": "<string>",
"productId": "<string>"
}Orders
Get Order Action Options
Ask the marketplace which choices an action needs, such as pickup or drop-off for ship. Requires orders:write.
Send the chosen choice’s payload with POST /api/v1/orders/{orderId}/actions.
GET
/
api
/
v1
/
orders
/
{orderId}
/
action-options
Get Order Action Options
curl --request GET \
--url https://omnicommerce.sg/api/v1/orders/{orderId}/action-options \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/orders/{orderId}/action-options', 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}/action-options"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "<string>",
"status": "accepted",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"action": "ship",
"choices": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"payload": {},
"requiresInput": 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
Query Parameters
Required for session auth. API keys already belong to one organization.
Maximum string length:
160Available options:
ship, cancel, labels, update_tracking Response
Choices for the action.
Allowed value:
"developer_v1"Available options:
accepted, completed, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes