Search Orders

POST 
/orders/search

Retrieve a list of orders by using the search fields below

Name	Type	Required
status	string	no
exported	boolean	no
externalOrderNumber	string	no
dateCreated	DateFilter	no
dateStatusModified	DateFilter	no

status: the value of the status in Propeller. By default the available statuses are:

• NEW
• VALIDATED
• CONFIRMED
• ARCHIVED

It is possible to create custom statuses in Propeller, please consult the Propeller backoffice for custom status values.

exported: Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Once an order has been exported it is good practice to mark the order as exported using the order update api. Searching for orders using the exported field will return a list of orders which are (or not) exported to an external system.

externalOrderNumber: Propeller has functionality to export orders to e.g. other ERP and/or financial systems. Depending on the type of system / techniques used for exporting, Propeller gets back an identifier from these systems (e.g an order id / invoice id). This id is stored in Propellor and can be used for searching using the order search api.

Date filter

A date filter is a special date search object that can search through a range:

{
    "from": "2020-12-12T00:00:00",
    "to": "2022-12-12T00:00:00"
}

Request

Responses

200

Search Orders - 200 (with results) / Search Orders - 200 (no results)

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id

400

Search Orders - 400 (invalid fieldname)

Response Headers

Alt-Svc
Via
alt-svc
content-length
date
return-format
server
x-request-id