POST api/OmsOrderHistory

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerID	string	None.
OrderNumber	string	None.
CustomField1	string	None.
CustomField2	string	None.
CustomField3	string	None.
CustomField4	string	None.
CustomField5	string	None.
QueryOperator	string	None.
SiteCode	string	None.
VerificationKey	string	None.
TimestampUTC	string	None.
APIUsername	string	None.
PageSize	integer	None.
PageNumber	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerID": "sample string 1",
  "OrderNumber": "sample string 2",
  "CustomField1": "sample string 3",
  "CustomField2": "sample string 4",
  "CustomField3": "sample string 5",
  "CustomField4": "sample string 6",
  "CustomField5": "sample string 7",
  "QueryOperator": "sample string 8",
  "SiteCode": "sample string 9",
  "VerificationKey": "sample string 10",
  "TimestampUTC": "sample string 11",
  "APIUsername": "sample string 12",
  "PageSize": 13,
  "PageNumber": 14
}

application/xml, text/xml

Sample:

<HistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Common.Contracts.API">
  <APIUsername>sample string 12</APIUsername>
  <CustomField1>sample string 3</CustomField1>
  <CustomField2>sample string 4</CustomField2>
  <CustomField3>sample string 5</CustomField3>
  <CustomField4>sample string 6</CustomField4>
  <CustomField5>sample string 7</CustomField5>
  <CustomerID>sample string 1</CustomerID>
  <OrderNumber>sample string 2</OrderNumber>
  <PageNumber>14</PageNumber>
  <PageSize>13</PageSize>
  <QueryOperator>sample string 8</QueryOperator>
  <SiteCode>sample string 9</SiteCode>
  <TimestampUTC>sample string 11</TimestampUTC>
  <VerificationKey>sample string 10</VerificationKey>
</HistoryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderHistoryResponse

Name	Type	Additional information
OrderDetails	Collection of OrderHistoryOrderDetail	None.
ResponseCode	APIResponseCodes	None.
Message	string	None.
TotalRecordsAvailable	integer	None.
CurrentPageNumber	integer	None.
TotalPages	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderDetails": null,
  "ResponseCode": 0,
  "Message": "sample string 1",
  "TotalRecordsAvailable": 2,
  "CurrentPageNumber": 3,
  "TotalPages": 4
}

application/xml, text/xml

Sample:

<OrderHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CurrentPageNumber>3</CurrentPageNumber>
  <Message>sample string 1</Message>
  <OrderDetails i:nil="true" />
  <ResponseCode>Success</ResponseCode>
  <TotalPages>4</TotalPages>
  <TotalRecordsAvailable>2</TotalRecordsAvailable>
</OrderHistoryResponse>