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 operations

GET/api/v1/operations

Parameters

Name	In	Required	Type	Description
page	query	no	integer
limit	query	no	integer
status	query	no	string
typeId	query	no	string

Responses

200 Paginated operation list

GET/api/v1/operations

List operations

API key (Bearer token)

page (query)

limit (query)

status (query)

typeId (query)

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

Create an operation

POST/api/v1/operations

Request body

Field	Type	Description
name	string
typeId	string
description	string
metadata	object

{
  "name": "Jane Doe",
  "typeId": "550e8400-e29b-41d4-a716-446655440000",
  "description": "string",
  "metadata": {}
}

Responses

201 Operation created

POST/api/v1/operations

Create an operation

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "typeId": "550e8400-e29b-41d4-a716-446655440000", "description": "string", "metadata": {} }

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

Evaluate AI rules for operations

POST/api/v1/operations/evaluate-rules

Request body

{}

Responses

200 Rule evaluation result

POST/api/v1/operations/evaluate-rules

Evaluate AI rules for operations

API key (Bearer token)

Request body (JSON){}

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

List operation types

GET/api/v1/operations/types

Responses

200 Operation type list

GET/api/v1/operations/types

List operation types

API key (Bearer token)

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

Get operation type details

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

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Operation type details

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

Get operation type details

API key (Bearer token)

id * (path)

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

Get operation details

GET/api/v1/operations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Operation details

GET/api/v1/operations/{id}

Get operation details

API key (Bearer token)

id * (path)

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

Update an operation

PATCH/api/v1/operations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Operation updated

PATCH/api/v1/operations/{id}

Update an operation

API key (Bearer token)

id * (path)

Request body (JSON){}

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

Delete an operation

DELETE/api/v1/operations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Operation deleted

DELETE/api/v1/operations/{id}

Delete an operation

API key (Bearer token)

id * (path)

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

Apply an action to operation items

POST/api/v1/operations/{id}/actions/apply

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Action applied

POST/api/v1/operations/{id}/actions/apply

Apply an action to operation items

API key (Bearer token)

id * (path)

Request body (JSON){}

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

Execute an operation

POST/api/v1/operations/{id}/execute

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Execution started

POST/api/v1/operations/{id}/execute

Execute an operation

API key (Bearer token)

id * (path)

Request body (JSON){}

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

Get operation action history

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

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Action history

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

Get operation action history

API key (Bearer token)

id * (path)

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

Get insights for an operation

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

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Operation insights

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

Get insights for an operation

API key (Bearer token)

id * (path)

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

Apply an insight recommendation

POST/api/v1/operations/{id}/insights/{insightId}/apply

Parameters

Name	In	Required	Type	Description
id	path	yes	string
insightId	path	yes	string

Responses

200 Insight applied

POST/api/v1/operations/{id}/insights/{insightId}/apply

Apply an insight recommendation

API key (Bearer token)

id * (path)

insightId * (path)

Request body (JSON)

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

List operation items

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

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Operation items

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

List operation items

API key (Bearer token)

id * (path)

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

Add items to an operation

POST/api/v1/operations/{id}/items

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
orderIds	array

{
  "orderIds": [
    "string"
  ]
}

Responses

201 Items added

POST/api/v1/operations/{id}/items

Add items to an operation

API key (Bearer token)

id * (path)

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

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

Bulk remove items from an operation

POST/api/v1/operations/{id}/items/bulk-remove

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
itemIds	array

{
  "itemIds": [
    "string"
  ]
}

Responses

200 Items removed

POST/api/v1/operations/{id}/items/bulk-remove

Bulk remove items from an operation

API key (Bearer token)

id * (path)

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

https://api-test.orderly-hub.com/api/v1/operations//items/bulk-remove

Update an operation item

PATCH/api/v1/operations/{id}/items/{itemId}

Parameters

Name	In	Required	Type	Description
id	path	yes	string
itemId	path	yes	string

Request body

{}

Responses

200 Item updated

PATCH/api/v1/operations/{id}/items/{itemId}

Update an operation item

API key (Bearer token)

id * (path)

itemId * (path)

Request body (JSON){}

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

Remove an item from an operation

DELETE/api/v1/operations/{id}/items/{itemId}

Parameters

Name	In	Required	Type	Description
id	path	yes	string
itemId	path	yes	string

Responses

200 Item removed

DELETE/api/v1/operations/{id}/items/{itemId}

Remove an item from an operation

API key (Bearer token)

id * (path)

itemId * (path)

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

Get operation execution progress

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

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Progress details

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

Get operation execution progress

API key (Bearer token)

id * (path)

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

Rate shop for an operation

POST/api/v1/operations/{id}/rate-shop

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Rate shopping result

POST/api/v1/operations/{id}/rate-shop

Rate shop for an operation

API key (Bearer token)

id * (path)

Request body (JSON){}

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

Undo an operation action

POST/api/v1/operations/{id}/undo/{historyId}

Parameters

Name	In	Required	Type	Description
id	path	yes	string
historyId	path	yes	string

Responses

200 Action undone

POST/api/v1/operations/{id}/undo/{historyId}

Undo an operation action

API key (Bearer token)

id * (path)

historyId * (path)

Request body (JSON)

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