HomeSupport
API Reference

This API uses the new search engine to obtain orders.

post
https://example.com/integration-tenants/api/v1/search/orders

SearchTerm will using the following fields to evaluate a free text query:

OrderId, Account Name, Account Number, Driver Name, Driver Number, Recurrence Name, Template Name, Reference Number 1, Reference Number 2, Reference Number 3, Pickup Address, Pickup Company, Delivery Address, Delivery Company, Barcodes

You can enter several filters in the filters array. The filters will be combined by the engine with an 'and' instruction.

SecondaryFilter is an optional second filter to cover some more complex filter scenario like, for instance adding a second field with an 'or' instruction by using the logic field and using either '1' or 'or'.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
1 to 1000
int32
1 to 500
string | null

The Query to use as a free text search. This is the equivalent to the search text field on the Orders Page.

filters
array of objects | null
filters
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

403

Not authorized to use this Endpoint

500

An error occurred when trying to search for the orders

Updated 3 months ago

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
text/json

Updated 3 months ago