Operations

Bulk order operations and execution

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 the operations terminal action catalog

GET/api/v1/operations/actions

Responses

200 Action catalog

GET/api/v1/operations/actions

List the operations terminal action catalog

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/operations/actions

Preflight an action pipeline against orders

POST/api/v1/operations/preflight

Request body

Field	Type	Description
order_ids	array
actions	array

{
  "order_ids": [
    "string"
  ],
  "actions": [
    {
      "type": "string",
      "params": {}
    }
  ]
}

Responses

200 Preflight report

POST/api/v1/operations/preflight

Preflight an action pipeline against orders

API key (Bearer token)

Request body (JSON){ "order_ids": [ "string" ], "actions": [ { "type": "string", "params": {} } ] }

https://api-test.orderly-hub.com/api/v1/operations/preflight

Run an action pipeline against orders and log the run

POST/api/v1/operations/run

Request body

Field	Type	Description
order_ids	array
actions	array

{
  "order_ids": [
    "string"
  ],
  "actions": [
    {
      "type": "string",
      "params": {}
    }
  ]
}

Responses

201 Run executed

POST/api/v1/operations/run

Run an action pipeline against orders and log the run

API key (Bearer token)

Request body (JSON){ "order_ids": [ "string" ], "actions": [ { "type": "string", "params": {} } ] }

https://api-test.orderly-hub.com/api/v1/operations/run

List operation runs (history)

GET/api/v1/operations/runs

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer

Responses

200 Paginated run list

GET/api/v1/operations/runs

List operation runs (history)

API key (Bearer token)

page (query)

limit (query)

https://api-test.orderly-hub.com/api/v1/operations/runs

Get an operation run

GET/api/v1/operations/runs/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Run detail

404 Run not found

GET/api/v1/operations/runs/{id}

Get an operation run

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/operations/runs/

Re-run only the failed orders of a run

POST/api/v1/operations/runs/{id}/retry

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

201 Retry run executed

400 No failed orders to retry

404 Run not found

POST/api/v1/operations/runs/{id}/retry

Re-run only the failed orders of a run

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/operations/runs//retry