Dispatchers

Order routing and dispatch

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 dispatchers

GET/api/v1/dispatchers

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
sourceBridgeId	query	no	string
destinationBridgeId	query	no	string
isActive	query	no	string

Responses

200 Paginated dispatcher list

GET/api/v1/dispatchers

List dispatchers

API key (Bearer token)

page (query)

limit (query)

sourceBridgeId (query)

destinationBridgeId (query)

isActive (query)

https://api-test.orderly-hub.com/api/v1/dispatchers

Create a dispatcher

POST/api/v1/dispatchers

Request body

Field	Type	Description
name	string
description	string
sourceBridgeIds	array
destinationBridgeId	string
destinationConfig	object
conditions	array
matchMode	all | any
triggerOn	array
isActive	boolean
priority	integer

{
  "name": "Jane Doe",
  "description": "string",
  "sourceBridgeIds": [
    "string"
  ],
  "destinationBridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "destinationConfig": {},
  "conditions": [
    {}
  ],
  "matchMode": "all",
  "triggerOn": [
    "string"
  ],
  "isActive": true,
  "priority": 0
}

Responses

201 Dispatcher created

POST/api/v1/dispatchers

Create a dispatcher

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "description": "string", "sourceBridgeIds": [ "string" ], "destinationBridgeId": "550e8400-e29b-41d4-a716-446655440000", "destinationConfig": {}, "conditions": [ {} ], "matchMode": "all", "triggerOn": [ "string" ], "isActive": true, "priority": 0 }

https://api-test.orderly-hub.com/api/v1/dispatchers

Process pending dispatch assignments

POST/api/v1/dispatchers/assignments/process

Request body

Field	Type	Description
bridgeId	string
limit	integer

{
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "limit": 0
}

Responses

200 Processing result

POST/api/v1/dispatchers/assignments/process

Process pending dispatch assignments

API key (Bearer token)

Request body (JSON){ "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "limit": 0 }

https://api-test.orderly-hub.com/api/v1/dispatchers/assignments/process

Retry failed dispatch assignments

POST/api/v1/dispatchers/assignments/retry

Request body

Field	Type	Description
assignmentIds	array

{
  "assignmentIds": [
    "string"
  ]
}

Responses

200 Retry result

POST/api/v1/dispatchers/assignments/retry

Retry failed dispatch assignments

API key (Bearer token)

Request body (JSON){ "assignmentIds": [ "string" ] }

https://api-test.orderly-hub.com/api/v1/dispatchers/assignments/retry

Manually trigger dispatch evaluation for an order

POST/api/v1/dispatchers/evaluate/{orderId}

Parameters

Name	In	Required	Type	Description
orderId	path	yes	string

Responses

200 Evaluation result with assignments created

POST/api/v1/dispatchers/evaluate/{orderId}

Manually trigger dispatch evaluation for an order

API key (Bearer token)

orderId * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/dispatchers/evaluate/

Get dispatcher details

GET/api/v1/dispatchers/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Dispatcher details

GET/api/v1/dispatchers/{id}

Get dispatcher details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/dispatchers/

Update a dispatcher

PATCH/api/v1/dispatchers/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Dispatcher updated

PATCH/api/v1/dispatchers/{id}

Update a dispatcher

API key (Bearer token)

id * (path)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/dispatchers/

Delete a dispatcher

DELETE/api/v1/dispatchers/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Dispatcher deleted

DELETE/api/v1/dispatchers/{id}

Delete a dispatcher

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/dispatchers/

Bulk assign orders to a dispatcher

POST/api/v1/dispatchers/{id}/assign

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
orderIds	array

{
  "orderIds": [
    "string"
  ]
}

Responses

200 Assignment result

POST/api/v1/dispatchers/{id}/assign

Bulk assign orders to a dispatcher

API key (Bearer token)

id * (path)

Request body (JSON){ "orderIds": [ "string" ] }

https://api-test.orderly-hub.com/api/v1/dispatchers//assign

Get dispatcher assignments

GET/api/v1/dispatchers/{id}/assignments

Parameters

Name	In	Required	Type	Description
id	path	yes	string
status	query	no	string
page	query	no	integer
limit	query	no	integer

Responses

200 Paginated assignment list

GET/api/v1/dispatchers/{id}/assignments

Get dispatcher assignments

API key (Bearer token)

id * (path)

status (query)

page (query)

limit (query)

https://api-test.orderly-hub.com/api/v1/dispatchers//assignments