Get order histories

Endpoint:

GET v1/OrderHistory?format={format}&searchTerm={searchTerm}&orderBy={orderBy}&startDate={startDate}&endDate={endDate}&orderStatus={orderStatus}&orderType={orderType}&SortDesc={SortDesc}&orderCount={orderCount}

URI Parameters

Name	Description	Type	Additional information
format		string	Default value is json
searchTerm	SearchTerm(Order Id, PO Number or PartId)	string	None.
orderBy	Order By (default Order Date)	string	Default value is OrderDate
startDate	Start Date	date	None.
endDate	End date	date	None.
orderStatus	Order Status	string	None.
orderType	Order Type	string	None.
SortDesc	Sort Order desc (default is true)	boolean	Default value is True
orderCount	Number of Orders to return(default is 100)	integer	Default value is 100

Body Parameters

None.

Response Information

Collection of OrderHistory

Name	Type	Additional information
OrderId	integer	None.
CustomerLevelId	string	None.
PoNumber	string	None.
WebConfirmation	string	None.
ShipToPoNumber	string	None.
ShipTo	string	None.
Notes	string	None.
OrderDate	string	None.
RequestedMinDate	date	None.
RequestedMaxDate	date	None.
OrderTotal	decimal number	None.
Lines	integer	None.
IsOpen	byte	None.
Status	string	None.

Response Examples

application/json, text/json :

[
  {
    "OrderId": 1,
    "CustomerLevelId": "sample string 2",
    "PoNumber": "sample string 3",
    "WebConfirmation": "sample string 4",
    "ShipToPoNumber": "sample string 5",
    "ShipTo": "sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13",
    "Notes": "sample string 16",
    "OrderDate": "9/7/2024",
    "RequestedMinDate": "2024-09-07T19:38:11.5771303-07:00",
    "RequestedMaxDate": "2024-09-07T19:38:11.5771303-07:00",
    "OrderTotal": 25.0,
    "Lines": 27,
    "IsOpen": 64,
    "Status": "sample string 29"
  },
  {
    "OrderId": 1,
    "CustomerLevelId": "sample string 2",
    "PoNumber": "sample string 3",
    "WebConfirmation": "sample string 4",
    "ShipToPoNumber": "sample string 5",
    "ShipTo": "sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13",
    "Notes": "sample string 16",
    "OrderDate": "9/7/2024",
    "RequestedMinDate": "2024-09-07T19:38:11.5771303-07:00",
    "RequestedMaxDate": "2024-09-07T19:38:11.5771303-07:00",
    "OrderTotal": 25.0,
    "Lines": 27,
    "IsOpen": 64,
    "Status": "sample string 29"
  }
]

text/javascript :

[{"OrderId":1,"CustomerLevelId":"sample string 2","PoNumber":"sample string 3","WebConfirmation":"sample string 4","ShipToPoNumber":"sample string 5","ShipTo":"sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13","Notes":"sample string 16","OrderDate":"9/7/2024","RequestedMinDate":"2024-09-07T19:38:11.5771303-07:00","RequestedMaxDate":"2024-09-07T19:38:11.5771303-07:00","OrderTotal":25.0,"Lines":27,"IsOpen":64,"Status":"sample string 29"},{"OrderId":1,"CustomerLevelId":"sample string 2","PoNumber":"sample string 3","WebConfirmation":"sample string 4","ShipToPoNumber":"sample string 5","ShipTo":"sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13","Notes":"sample string 16","OrderDate":"9/7/2024","RequestedMinDate":"2024-09-07T19:38:11.5771303-07:00","RequestedMaxDate":"2024-09-07T19:38:11.5771303-07:00","OrderTotal":25.0,"Lines":27,"IsOpen":64,"Status":"sample string 29"}]

application/xml, text/xml :

<ArrayOfOrderHistory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models.Orders">
  <OrderHistory>
    <CustomerLevelId>sample string 2</CustomerLevelId>
    <IsOpen>64</IsOpen>
    <Lines>27</Lines>
    <Notes>sample string 16</Notes>
    <OrderDate>9/7/2024</OrderDate>
    <OrderId>1</OrderId>
    <OrderTotal>25</OrderTotal>
    <PoNumber>sample string 3</PoNumber>
    <RequestedMaxDate>2024-09-07T19:38:11.5771303-07:00</RequestedMaxDate>
    <RequestedMinDate>2024-09-07T19:38:11.5771303-07:00</RequestedMinDate>
    <ShipTo>sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13</ShipTo>
    <ShipToPoNumber>sample string 5</ShipToPoNumber>
    <Status>sample string 29</Status>
    <WebConfirmation>sample string 4</WebConfirmation>
  </OrderHistory>
  <OrderHistory>
    <CustomerLevelId>sample string 2</CustomerLevelId>
    <IsOpen>64</IsOpen>
    <Lines>27</Lines>
    <Notes>sample string 16</Notes>
    <OrderDate>9/7/2024</OrderDate>
    <OrderId>1</OrderId>
    <OrderTotal>25</OrderTotal>
    <PoNumber>sample string 3</PoNumber>
    <RequestedMaxDate>2024-09-07T19:38:11.5771303-07:00</RequestedMaxDate>
    <RequestedMinDate>2024-09-07T19:38:11.5771303-07:00</RequestedMinDate>
    <ShipTo>sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13</ShipTo>
    <ShipToPoNumber>sample string 5</ShipToPoNumber>
    <Status>sample string 29</Status>
    <WebConfirmation>sample string 4</WebConfirmation>
  </OrderHistory>
</ArrayOfOrderHistory>

text/csv :

OrderId,CustomerLevelId,PoNumber,WebConfirmation,ShipToPoNumber,ShipTo,Notes,OrderDate,RequestedMinDate,RequestedMaxDate,OrderTotal,Lines,IsOpen,Status
1,sample string 2,sample string 3,sample string 4,sample string 5,"sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13",sample string 16,9/7/2024,9/7/2024 7:38:11 PM,9/7/2024 7:38:11 PM,25,27,64,sample string 29
1,sample string 2,sample string 3,sample string 4,sample string 5,"sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13",sample string 16,9/7/2024,9/7/2024 7:38:11 PM,9/7/2024 7:38:11 PM,25,27,64,sample string 29

text/tsv :

OrderId	CustomerLevelId	PoNumber	WebConfirmation	ShipToPoNumber	ShipTo	Notes	OrderDate	RequestedMinDate	RequestedMaxDate	OrderTotal	Lines	IsOpen	Status
1	sample string 2	sample string 3	sample string 4	sample string 5	"sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13"	sample string 16	9/7/2024	9/7/2024 7:38:11 PM	9/7/2024 7:38:11 PM	25	27	64	sample string 29
1	sample string 2	sample string 3	sample string 4	sample string 5	"sample string 6,sample string 7,sample string 8,sample string 9,sample string 10,sample string 11, sample string 12 sample string 13"	sample string 16	9/7/2024	9/7/2024 7:38:11 PM	9/7/2024 7:38:11 PM	25	27	64	sample string 29