Get Order
curl --request GET \
--url https://omnicommerce.sg/api/v1/orders/{orderId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/orders/{orderId}', 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}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "completed",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalOrderId": "<string>",
"externalOrderNumber": "<string>",
"marketplace": "<string>",
"status": "<string>",
"statusGroup": "to_ship",
"country": "<string>",
"storeId": "<string>",
"currency": "<string>",
"totalAmount": 123,
"shippingFee": 123,
"discountAmount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "<string>",
"externalOrderItemId": "<string>",
"name": "<string>",
"quantity": 1,
"status": "<string>",
"currency": "<string>",
"unitPrice": 123,
"paidPrice": 123,
"lineTotal": 123,
"costPrice": 123,
"costPriceCurrency": "<string>",
"productId": "<string>",
"variantId": "<string>",
"imageUrl": "<string>",
"statusLabel": "<string>",
"sku": "<string>",
"sellerSku": "<string>",
"shopSku": "<string>",
"variation": "<string>",
"productVersionId": "<string>",
"productVersionNumber": 123,
"bundle": {
"type": "virtual",
"compositionSource": "order_snapshot",
"capturedAt": "2023-11-07T05:31:56Z",
"components": [
{
"productId": "<string>",
"sku": "<string>",
"name": "<string>",
"quantityPerBundle": 2,
"quantityRequired": 1
}
]
}
}
],
"marketplaceOrderUrl": "<string>",
"marketplaceLabel": "<string>",
"statusLabel": "<string>",
"storeLabel": "<string>",
"buyerName": "<string>",
"buyerUserId": "<string>",
"buyerUsername": "<string>",
"buyerPhone": "<string>",
"shippingAddress": {},
"billingAddress": {},
"sellerNote": {},
"cancellationDetails": {},
"returnCompletion": {},
"statusHistory": [
{}
],
"financeBreakdown": {},
"settlementProjection": {}
}
}
}Orders
Get Order
Get one order by its OmniCommerce UUID for the authenticated organization.
Authentication
Requires orders:read.
Response
The organization-scoped detail includes:
- Line items and normalized status
- Buyer and contact fields
- Shipping and billing addresses
- Return context
- Finance breakdown
- Settlement projection, when available
Orders outside the authenticated organization are not exposed and return 404 Not Found.
GET
/
api
/
v1
/
orders
/
{orderId}
Get Order
curl --request GET \
--url https://omnicommerce.sg/api/v1/orders/{orderId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://omnicommerce.sg/api/v1/orders/{orderId}', 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}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"apiVersion": "developer_v1",
"operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "completed",
"warnings": [
"<string>"
],
"recommendations": [
"<string>"
],
"links": {},
"data": {
"order": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalOrderId": "<string>",
"externalOrderNumber": "<string>",
"marketplace": "<string>",
"status": "<string>",
"statusGroup": "to_ship",
"country": "<string>",
"storeId": "<string>",
"currency": "<string>",
"totalAmount": 123,
"shippingFee": 123,
"discountAmount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"lines": [
{
"id": "<string>",
"externalOrderItemId": "<string>",
"name": "<string>",
"quantity": 1,
"status": "<string>",
"currency": "<string>",
"unitPrice": 123,
"paidPrice": 123,
"lineTotal": 123,
"costPrice": 123,
"costPriceCurrency": "<string>",
"productId": "<string>",
"variantId": "<string>",
"imageUrl": "<string>",
"statusLabel": "<string>",
"sku": "<string>",
"sellerSku": "<string>",
"shopSku": "<string>",
"variation": "<string>",
"productVersionId": "<string>",
"productVersionNumber": 123,
"bundle": {
"type": "virtual",
"compositionSource": "order_snapshot",
"capturedAt": "2023-11-07T05:31:56Z",
"components": [
{
"productId": "<string>",
"sku": "<string>",
"name": "<string>",
"quantityPerBundle": 2,
"quantityRequired": 1
}
]
}
}
],
"marketplaceOrderUrl": "<string>",
"marketplaceLabel": "<string>",
"statusLabel": "<string>",
"storeLabel": "<string>",
"buyerName": "<string>",
"buyerUserId": "<string>",
"buyerUsername": "<string>",
"buyerPhone": "<string>",
"shippingAddress": {},
"billingAddress": {},
"sellerNote": {},
"cancellationDetails": {},
"returnCompletion": {},
"statusHistory": [
{}
],
"financeBreakdown": {},
"settlementProjection": {}
}
}
}Authorizations
Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.
Path Parameters
OmniCommerce order UUID returned from create or list.
Query Parameters
Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.
Maximum string length:
120Response
Order detail returned.