Embed
White-label embed system for 3PL clients
All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.
List action requests (embed)
/api/v1/embed/action-requestsResponses
200 Action request list
/api/v1/embed/action-requestsList action requests (embed)
https://api-test.orderly-hub.com/api/v1/embed/action-requestsCreate an action request (embed)
/api/v1/embed/action-requestsRequest body
{}
Responses
201 Action request created
/api/v1/embed/action-requestsCreate an action request (embed)
https://api-test.orderly-hub.com/api/v1/embed/action-requestsList alert rules (embed)
/api/v1/embed/alerts/rulesResponses
200 Alert rule list
/api/v1/embed/alerts/rulesList alert rules (embed)
https://api-test.orderly-hub.com/api/v1/embed/alerts/rulesCreate an alert rule (embed)
/api/v1/embed/alerts/rulesRequest body
{}
Responses
201 Alert rule created
/api/v1/embed/alerts/rulesCreate an alert rule (embed)
https://api-test.orderly-hub.com/api/v1/embed/alerts/rulesList available bridge types (embed)
/api/v1/embed/bridge-typesResponses
200 Bridge type list
/api/v1/embed/bridge-typesList available bridge types (embed)
https://api-test.orderly-hub.com/api/v1/embed/bridge-typesList bridges (embed token auth)
/api/v1/embed/bridgesResponses
200 Bridge list
/api/v1/embed/bridgesList bridges (embed token auth)
https://api-test.orderly-hub.com/api/v1/embed/bridgesCreate a bridge (embed token auth)
/api/v1/embed/bridgesRequest body
{}
Responses
201 Bridge created
/api/v1/embed/bridgesCreate a bridge (embed token auth)
https://api-test.orderly-hub.com/api/v1/embed/bridgesGet embed config by slug (public, no auth)
/api/v1/embed/configParameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
slug | query | yes | string |
Responses
200 Embed configuration
/api/v1/embed/configGet embed config by slug (public, no auth)
https://api-test.orderly-hub.com/api/v1/embed/configUpdate embed configuration
/api/v1/embed/configRequest body
{}
Responses
200 Config updated
/api/v1/embed/configUpdate embed configuration
https://api-test.orderly-hub.com/api/v1/embed/configGet embed config for authenticated org
/api/v1/embed/config/meResponses
200 Embed configuration
/api/v1/embed/config/meGet embed config for authenticated org
https://api-test.orderly-hub.com/api/v1/embed/config/meList orders (embed token auth)
/api/v1/embed/ordersResponses
200 Order list
/api/v1/embed/ordersList orders (embed token auth)
https://api-test.orderly-hub.com/api/v1/embed/ordersGet the current embed session capabilities
/api/v1/embed/sessionResponses
200 Current embed session
EmbedSessionCapabilities object:
| Field | Type | Description |
|---|---|---|
expiresAt | string | |
scopes | array | |
enabledFeatures | array | |
allowedBridgeTypes | array |
{
"data": {
"expiresAt": "2026-07-23T12:00:00Z",
"scopes": [
"string"
],
"enabledFeatures": [
"string"
],
"allowedBridgeTypes": [
"string"
]
}
}
/api/v1/embed/sessionGet the current embed session capabilities
https://api-test.orderly-hub.com/api/v1/embed/sessionCreate a server-authorized embed session
/api/v1/embed/sessionsRequest body
| Field | Type | Description |
|---|---|---|
externalId | string | Stable end-user identifier from the caller's authenticated system |
name | string | |
email | string | |
metadata | object | |
scopes | array | Least-privilege scopes enabled for the organization |
allowedBridgeTypes | array | |
ttlSeconds | integer |
{
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Jane Doe",
"email": "jane@example.com",
"metadata": {},
"scopes": [
"bridges:read"
],
"allowedBridgeTypes": [
"string"
],
"ttlSeconds": 900
}
Responses
201 Session created
CreatedEmbedSession object:
| Field | Type | Description |
|---|---|---|
clientSecret | string | |
sessionId | string | |
expiresAt | string | |
scopes | array | |
enabledFeatures | array | |
endUser | object |
{
"data": {
"clientSecret": "string",
"sessionId": "550e8400-e29b-41d4-a716-446655440000",
"expiresAt": "2026-07-23T12:00:00Z",
"scopes": [
"string"
],
"enabledFeatures": [
"string"
],
"endUser": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"name": "Jane Doe",
"email": "jane@example.com"
}
}
}
/api/v1/embed/sessionsCreate a server-authorized embed session
https://api-test.orderly-hub.com/api/v1/embed/sessionsRevoke an embed session
/api/v1/embed/sessions/{id}Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses
200 Session revoked
/api/v1/embed/sessions/{id}Revoke an embed session
https://api-test.orderly-hub.com/api/v1/embed/sessions/List shipments (embed token auth)
/api/v1/embed/shipmentsResponses
200 Shipment list
/api/v1/embed/shipmentsList shipments (embed token auth)
https://api-test.orderly-hub.com/api/v1/embed/shipmentsList tracking pages (embed)
/api/v1/embed/tracking-pagesResponses
200 Tracking page list
/api/v1/embed/tracking-pagesList tracking pages (embed)
https://api-test.orderly-hub.com/api/v1/embed/tracking-pagesCreate a tracking page (embed)
/api/v1/embed/tracking-pagesRequest body
{}
Responses
201 Tracking page created
/api/v1/embed/tracking-pagesCreate a tracking page (embed)
https://api-test.orderly-hub.com/api/v1/embed/tracking-pagesList embed users
/api/v1/embed/usersResponses
200 User list
/api/v1/embed/usersList embed users
https://api-test.orderly-hub.com/api/v1/embed/usersList webhooks (embed)
/api/v1/embed/webhooksResponses
200 Webhook list
/api/v1/embed/webhooksList webhooks (embed)
https://api-test.orderly-hub.com/api/v1/embed/webhooksCreate a webhook (embed)
/api/v1/embed/webhooksRequest body
{}
Responses
201 Webhook created
/api/v1/embed/webhooksCreate a webhook (embed)
https://api-test.orderly-hub.com/api/v1/embed/webhooks