GET api/communicationupdatesorders/search?page={page}&itemPerPage={itemPerPage}&orderExternalID={orderExternalID}&alreadySent={alreadySent}&method={method}

Returns a list of orders changed through communications.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
page

Page number requested (search results are paginated).

 integer

Default value is 1
itemPerPage

Items to return on each page. See page parameter above.

 integer

Default value is 10
orderExternalID

Communications order's unique ID on integrating system.

 string

Default value is empty string ("")
alreadySent

Filters the list of order update based on whether they have been sent to the integrating system or not.

 boolean

Default value is False
method

Filters the list of order update based on communication method.

 string

Default value is empty string ("")

Body Parameters

None.

Response Information

Resource Description

ListModelOfOrderUpdateModel
NameDescriptionTypeAdditional information
TotalItems

integer

None.
ItemsPerPage

integer

None.
CurrentPage

integer

None.
TotalPages

integer

None.
FirstRowOnPage

integer

None.
LastRowOnPage

integer

None.
Rows

Collection of OrderUpdateModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "totalItems": 1,
  "itemsPerPage": 2,
  "currentPage": 3,
  "totalPages": 4,
  "firstRowOnPage": 5,
  "lastRowOnPage": 6,
  "rows": [
    {
      "orderUpdateID": "fd05b53b-e66a-43f7-bb5c-72d7f2948eed",
      "orderExternalID": "sample string 1",
      "updateStatusTo": "sample string 2",
      "method": "sample string 3"
    },
    {
      "orderUpdateID": "fd05b53b-e66a-43f7-bb5c-72d7f2948eed",
      "orderExternalID": "sample string 1",
      "updateStatusTo": "sample string 2",
      "method": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<ListModelOfOrderUpdateModel8ZWmGvti xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">
  <CurrentPage>3</CurrentPage>
  <FirstRowOnPage>5</FirstRowOnPage>
  <ItemsPerPage>2</ItemsPerPage>
  <LastRowOnPage>6</LastRowOnPage>
  <Rows xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.OrderUpdates">
    <d2p1:OrderUpdateModel>
      <d2p1:Method>sample string 3</d2p1:Method>
      <d2p1:OrderExternalID>sample string 1</d2p1:OrderExternalID>
      <d2p1:OrderUpdateID>fd05b53b-e66a-43f7-bb5c-72d7f2948eed</d2p1:OrderUpdateID>
      <d2p1:UpdateStatusTo>sample string 2</d2p1:UpdateStatusTo>
    </d2p1:OrderUpdateModel>
    <d2p1:OrderUpdateModel>
      <d2p1:Method>sample string 3</d2p1:Method>
      <d2p1:OrderExternalID>sample string 1</d2p1:OrderExternalID>
      <d2p1:OrderUpdateID>fd05b53b-e66a-43f7-bb5c-72d7f2948eed</d2p1:OrderUpdateID>
      <d2p1:UpdateStatusTo>sample string 2</d2p1:UpdateStatusTo>
    </d2p1:OrderUpdateModel>
  </Rows>
  <TotalItems>1</TotalItems>
  <TotalPages>4</TotalPages>
</ListModelOfOrderUpdateModel8ZWmGvti>