GET api/order/SearchOrdersPaged?customerNo={customerNo}&searchPhrase={searchPhrase}&startDate={startDate}&endDate={endDate}&pageIndex={pageIndex}&pageSize={pageSize}&showOnlyBackorders={showOnlyBackorders}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
customerNo

string

Required

searchPhrase

string

Default value is

startDate

date

None.

endDate

date

None.

pageIndex

integer

Default value is 0

pageSize

integer

Default value is 20

showOnlyBackorders

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

OrderSearchResult
NameDescriptionTypeAdditional information
Orders

Collection of Order

None.

TotalHits

integer

None.

CurrentPageIndex

integer

None.

TotalPages

integer

None.

FromHitIndex

integer

None.

ToHitIndex

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Orders": null,
  "TotalHits": 1,
  "CurrentPageIndex": 2,
  "TotalPages": 3,
  "FromHitIndex": 4,
  "ToHitIndex": 5
}

application/xml, text/xml

Sample:
<OrderSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/KWParts.BlackBox.Models">
  <CurrentPageIndex>2</CurrentPageIndex>
  <FromHitIndex>4</FromHitIndex>
  <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/KWParts.Elastic.Document" i:nil="true" />
  <ToHitIndex>5</ToHitIndex>
  <TotalHits>1</TotalHits>
  <TotalPages>3</TotalPages>
</OrderSearchResult>