Split Rules

Automatic order splitting rules

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 split rules

GET/api/v1/split-rules

Parameters

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

Responses

200 Paginated split rule list

GET/api/v1/split-rules

List split rules

API key (Bearer token)

isActive (query)

bridgeId (query)

page (query)

limit (query)

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

Create a split rule

POST/api/v1/split-rules

Request body

Field	Type	Description
name	string
description	string
method	condition | field_group
conditionGroups	array
groupField	string
bridgeId	string
isActive	boolean
priority	integer

{
  "name": "Jane Doe",
  "description": "string",
  "method": "condition",
  "conditionGroups": [
    {}
  ],
  "groupField": "string",
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "isActive": true,
  "priority": 0
}

Responses

201 Split rule created

POST/api/v1/split-rules

Create a split rule

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "description": "string", "method": "condition", "conditionGroups": [ {} ], "groupField": "string", "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "isActive": true, "priority": 0 }

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

Get split rule details

GET/api/v1/split-rules/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Split rule details

GET/api/v1/split-rules/{id}

Get split rule details

API key (Bearer token)

id * (path)

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

Update a split rule

PATCH/api/v1/split-rules/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Split rule updated

PATCH/api/v1/split-rules/{id}

Update a split rule

API key (Bearer token)

id * (path)

Request body (JSON){}

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

Delete a split rule

DELETE/api/v1/split-rules/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Split rule deleted

DELETE/api/v1/split-rules/{id}

Delete a split rule

API key (Bearer token)

id * (path)

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

Test a split rule against an order (dry run)

POST/api/v1/split-rules/{id}/test

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
orderId	string

{
  "orderId": "550e8400-e29b-41d4-a716-446655440000"
}

Responses

200 Test result

POST/api/v1/split-rules/{id}/test

Test a split rule against an order (dry run)

API key (Bearer token)

id * (path)

Request body (JSON){ "orderId": "550e8400-e29b-41d4-a716-446655440000" }

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