Order search options
Last updated: 31-Aug-2021
Use the OrderSearchOptions object to configure your search order options via JSON-RPC API 6.0.
| Parameter name | Type | Required/Optional | Description |
|---|---|---|---|
|
ApproveStatus |
String |
Optional |
The desired approved status. Available values: WAITING, OK, FRAUD, INVALIDDATA. |
|
Newer |
String |
Optional |
Needed timestamp. If not provided, will return by default the data for the last 7 days. |
|
Status |
String |
Optional |
Order status. Some of the available options are COMPLETE, PENDING, CANCELED, REFUND. |
|
StartDate |
String |
Optional |
Start date in format Y-m-d. Will overwrite Newer if provided. |
|
EndDate |
String |
Optional |
End date in format Y-m-d. |
|
PartnerOrders |
Boolean |
Optional |
Decide if it will also include partner orders. |
|
ExternalRefNo |
String |
Optional |
The external reference number of the order. |
| IncludeTestOrders | String | Optional |
Should test orders be included in the result: Values:
|
| Pagination |
Object |
Optional |
Existing shipping class object with the structure detailed below. |
|
Limit |
Int | Optional | The number of results to be returned |
|
Page |
Int | Optional | The page number |
Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.
We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.