Skip to main content

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​

NameInRequiredTypeDescription
pagequerynointeger
limitquerynointeger
sourceBridgeIdquerynostring
destinationBridgeIdquerynostring
isActivequerynostring

Responses​

200 Paginated dispatcher list

GET/api/v1/dispatchers

List dispatchers

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

Create a dispatcher​

POST/api/v1/dispatchers

Request body​

FieldTypeDescription
namestring
descriptionstring
sourceBridgeIdsarray
destinationBridgeIdstring
destinationConfigobject
conditionsarray
matchModeall | any
triggerOnarray
isActiveboolean
priorityinteger
{
"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

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

Process pending dispatch assignments​

POST/api/v1/dispatchers/assignments/process

Request body​

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

Responses​

200 Processing result

POST/api/v1/dispatchers/assignments/process

Process pending dispatch assignments

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

Retry failed dispatch assignments​

POST/api/v1/dispatchers/assignments/retry

Request body​

FieldTypeDescription
assignmentIdsarray
{
"assignmentIds": [
"string"
]
}

Responses​

200 Retry result

POST/api/v1/dispatchers/assignments/retry

Retry failed dispatch assignments

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​

NameInRequiredTypeDescription
orderIdpathyesstring

Responses​

200 Evaluation result with assignments created

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

Manually trigger dispatch evaluation for an order

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

Get dispatcher details​

GET/api/v1/dispatchers/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Dispatcher details

GET/api/v1/dispatchers/{id}

Get dispatcher details

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

Update a dispatcher​

PATCH/api/v1/dispatchers/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Request body​

{}

Responses​

200 Dispatcher updated

PATCH/api/v1/dispatchers/{id}

Update a dispatcher

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

Delete a dispatcher​

DELETE/api/v1/dispatchers/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Dispatcher deleted

DELETE/api/v1/dispatchers/{id}

Delete a dispatcher

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

Bulk assign orders to a dispatcher​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Request body​

FieldTypeDescription
orderIdsarray
{
"orderIds": [
"string"
]
}

Responses​

200 Assignment result

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

Bulk assign orders to a dispatcher

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

Get dispatcher assignments​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring
statusquerynostring
pagequerynointeger
limitquerynointeger

Responses​

200 Paginated assignment list

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

Get dispatcher assignments

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