For the complete documentation index, see llms.txt. This page is also available as Markdown.

Order search options

Use the orderSearchOptions object to configure your search order options via SOAP API 6.0.

Request parameters

Parameter
Type / Description

ApproveStatus

Optional (string) The desired approved status. Available values: WAITING, OK, FRAUD, INVALIDDATA.

Newer

Optional (string) Needed timestamp. If not provided, will return by default the data for the last 7 days.

Status

Optional (string) Order status. Some of the available options are COMPLETE, PENDING, CANCELED, REFUND.

StartDate

Optional (string) Start date in format Y-m-d. Will overwrite Newer if provided.

EndDate

Optional (string) End date in format Y-m-d.

PartnerOrders

Optional (boolean) Decide if it will also include partner orders.

ExternalRefNo

Optional (string) The external reference number of the order.

IncludeTestOrders

Optional (string)

Should test orders be included in the result:

Values:

  • YES - test orders are included

  • NO - test orders are not included

  • ONLY - only the test orders are included

Pagination

Optional (object) Existing shipping class object with the structure detailed below.

Limit

Optional (int) The number of results to be returned.

Page

Optional (int) The page number.

Last updated

Was this helpful?