Transformations

Data transformation 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 transformations

GET/api/v1/transformations

Responses

200 Transformation list

GET/api/v1/transformations

List transformations

API key (Bearer token)

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

Create a transformation

POST/api/v1/transformations

Request body

Field	Type	Description
name	string
bridgeId	string
taskName	string
direction	inbound | outbound
mappings	array
isActive	boolean

{
  "name": "Jane Doe",
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "taskName": "string",
  "direction": "inbound",
  "mappings": [
    {}
  ],
  "isActive": true
}

Responses

201 Transformation created

POST/api/v1/transformations

Create a transformation

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "taskName": "string", "direction": "inbound", "mappings": [ {} ], "isActive": true }

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

Test an unsaved transformation

POST/api/v1/transformations/test

Request body

Field	Type	Description
mappings	array
sampleData	object

{
  "mappings": [
    {}
  ],
  "sampleData": {}
}

Responses

200 Transformation test result

POST/api/v1/transformations/test

Test an unsaved transformation

API key (Bearer token)

Request body (JSON){ "mappings": [ {} ], "sampleData": {} }

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

Get transformation details

GET/api/v1/transformations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Transformation details

GET/api/v1/transformations/{id}

Get transformation details

API key (Bearer token)

id * (path)

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

Update a transformation

PATCH/api/v1/transformations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Transformation updated

PATCH/api/v1/transformations/{id}

Update a transformation

API key (Bearer token)

id * (path)

Request body (JSON){}

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

Delete a transformation

DELETE/api/v1/transformations/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Transformation deleted

DELETE/api/v1/transformations/{id}

Delete a transformation

API key (Bearer token)

id * (path)

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

Test a saved transformation with sample data

POST/api/v1/transformations/{id}/test

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

Field	Type	Description
sampleData	object

{
  "sampleData": {}
}

Responses

200 Transformation test result

POST/api/v1/transformations/{id}/test

Test a saved transformation with sample data

API key (Bearer token)

id * (path)

Request body (JSON){ "sampleData": {} }

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