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)

GET/api/v1/embed/action-requests

Responses

200 Action request list

GET/api/v1/embed/action-requests

List action requests (embed)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/action-requests

Create an action request (embed)

POST/api/v1/embed/action-requests

Request body

{}

Responses

201 Action request created

POST/api/v1/embed/action-requests

Create an action request (embed)

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/action-requests

List alert rules (embed)

GET/api/v1/embed/alerts/rules

Responses

200 Alert rule list

GET/api/v1/embed/alerts/rules

List alert rules (embed)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/alerts/rules

Create an alert rule (embed)

POST/api/v1/embed/alerts/rules

Request body

{}

Responses

201 Alert rule created

POST/api/v1/embed/alerts/rules

Create an alert rule (embed)

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/alerts/rules

List available bridge types (embed)

GET/api/v1/embed/bridge-types

Responses

200 Bridge type list

GET/api/v1/embed/bridge-types

List available bridge types (embed)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/bridge-types

List bridges (embed token auth)

GET/api/v1/embed/bridges

Responses

200 Bridge list

GET/api/v1/embed/bridges

List bridges (embed token auth)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/bridges

Create a bridge (embed token auth)

POST/api/v1/embed/bridges

Request body

{}

Responses

201 Bridge created

POST/api/v1/embed/bridges

Create a bridge (embed token auth)

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/bridges

Get embed config by slug (public, no auth)

GET/api/v1/embed/config

Parameters

Name	In	Required	Type	Description
slug	query	yes	string

Responses

200 Embed configuration

GET/api/v1/embed/config

Get embed config by slug (public, no auth)

API key (Bearer token)

slug (query)

https://api-test.orderly-hub.com/api/v1/embed/config

Get embed config for authenticated org

GET/api/v1/embed/config/me

Responses

200 Embed configuration

GET/api/v1/embed/config/me

Get embed config for authenticated org

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/config/me

Update embed configuration

PATCH/api/v1/embed/config/update

Request body

{}

Responses

200 Config updated

PATCH/api/v1/embed/config/update

Update embed configuration

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/config/update

List orders (embed token auth)

GET/api/v1/embed/orders

Responses

200 Order list

GET/api/v1/embed/orders

List orders (embed token auth)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/orders

Create embed session (dashboard)

POST/api/v1/embed/sessions

Request body

{}

Responses

201 Session created

POST/api/v1/embed/sessions

Create embed session (dashboard)

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/sessions

Create embed session via publishable key

POST/api/v1/embed/sessions/auto

Request body

Field	Type	Description
publishableKey	string
externalUserId	string
userName	string
userEmail	string
metadata	object

{
  "publishableKey": "string",
  "externalUserId": "550e8400-e29b-41d4-a716-446655440000",
  "userName": "string",
  "userEmail": "jane@example.com",
  "metadata": {}
}

Responses

200 Session token

POST/api/v1/embed/sessions/auto

Create embed session via publishable key

API key (Bearer token)

Request body (JSON){ "publishableKey": "string", "externalUserId": "550e8400-e29b-41d4-a716-446655440000", "userName": "string", "userEmail": "jane@example.com", "metadata": {} }

https://api-test.orderly-hub.com/api/v1/embed/sessions/auto

Revoke an embed session

DELETE/api/v1/embed/sessions/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Session revoked

DELETE/api/v1/embed/sessions/{id}

Revoke an embed session

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/embed/sessions/

List shipments (embed token auth)

GET/api/v1/embed/shipments

Responses

200 Shipment list

GET/api/v1/embed/shipments

List shipments (embed token auth)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/shipments

List tracking pages (embed)

GET/api/v1/embed/tracking-pages

Responses

200 Tracking page list

GET/api/v1/embed/tracking-pages

List tracking pages (embed)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/tracking-pages

Create a tracking page (embed)

POST/api/v1/embed/tracking-pages

Request body

{}

Responses

201 Tracking page created

POST/api/v1/embed/tracking-pages

Create a tracking page (embed)

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/tracking-pages

List embed users

GET/api/v1/embed/users

Responses

200 User list

GET/api/v1/embed/users

List embed users

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/users

List webhooks (embed)

GET/api/v1/embed/webhooks

Responses

200 Webhook list

GET/api/v1/embed/webhooks

List webhooks (embed)

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/embed/webhooks

Create a webhook (embed)

POST/api/v1/embed/webhooks

Request body

{}

Responses

201 Webhook created

POST/api/v1/embed/webhooks

Create a webhook (embed)

API key (Bearer token)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/embed/webhooks