v60

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01361201.5 MB
Feed v3

Test JSONata expression

This endpoint allows you to test a JSON document with a JSONata expression, returning true if the document meets the criteria posed in the expression, or false if it does not.

Since JSONata expressions can be used to filter order updates in the Orders API feed and hook, this endpoint can be used to test an expression's results before configuring the feed or hook.

Learn more about how to use JSONata expressions, in the JSONata documentation.

post/api/orders/expressions/jsonata

Headers

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Content-Typestring required

Type of the content being sent.

Request body

Expressionstring required

JSONata expression to be tested.

Documentstring required

JSON document to be evaluated by the expression.

Response

OK

boolean required

Successful requests return the message true.