GET salesorder/summary/{customerNumber}?page={page}&pageSize={pageSize}&salesOrderNumber={salesOrderNumber}&poNumber={poNumber}&referenceNumber={referenceNumber}&status={status}&docType={docType}&fromDate={fromDate}&toDate={toDate}&fromLastChangeDate={fromLastChangeDate}&toLastChangeDate={toLastChangeDate}&serialNumbers={serialNumbers}&macAddresses={macAddresses}
Get Order Summary allows customers to get a paged list of sales orders. Search parameters can be specified to search by serial numbers and mac addresses within a given date range
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerNumber |
Your Customer Number |
string |
Required |
page |
Page Number |
integer |
Default value is 1 |
pageSize |
Number of results per page |
integer |
Default value is 100 |
salesOrderNumber |
Sales Order Number |
string |
None. |
poNumber |
Purchase Order Number |
string |
None. |
referenceNumber | string |
None. |
|
status |
Order status: Cancelled, Completely Shipped, On Hold, Open, Partially Shipped, Quotation/Sales |
string |
None. |
docType | string |
None. |
|
fromDate |
Start date range Format: YYYY-MM-DD |
string |
None. |
toDate |
End date range Format: YYYY-MM-DD |
string |
None. |
fromLastChangeDate |
Start last changed date range Format: YYYY-MM-DD |
string |
None. |
toLastChangeDate |
End last changed date range Format: YYYY-MM-DD |
string |
None. |
serialNumbers |
Comma seperated list of serial numbers to search by |
string |
None. |
macAddresses |
Comma seperated list of mac addresses to search by |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of OrderSummaryName | Description | Type | Additional information |
---|---|---|---|
OrderNumber |
Sales Order Number |
string |
None. |
PONumber |
Your Purchase Order Number |
string |
None. |
DocType |
Document Type |
string |
None. |
Status |
Order Status |
string |
None. |
Total |
Total order amount |
decimal number |
None. |
DateEntered |
Date stamp when order was created |
string |
None. |
LastChanged |
Date stamp for when order was last updated |
string |
None. |
Response Formats
application/json, text/json
[ { "OrderNumber": "sample string 1", "PONumber": "sample string 2", "DocType": "sample string 3", "Status": "sample string 4", "Total": 5.0, "DateEntered": "sample string 6", "LastChanged": "sample string 7" }, { "OrderNumber": "sample string 1", "PONumber": "sample string 2", "DocType": "sample string 3", "Status": "sample string 4", "Total": 5.0, "DateEntered": "sample string 6", "LastChanged": "sample string 7" } ]
application/xml, text/xml
<ArrayOfOrderSummary xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <OrderSummary> <OrderNumber>sample string 1</OrderNumber> <PONumber>sample string 2</PONumber> <DocType>sample string 3</DocType> <Status>sample string 4</Status> <Total>5</Total> <DateEntered>sample string 6</DateEntered> <LastChanged>sample string 7</LastChanged> </OrderSummary> <OrderSummary> <OrderNumber>sample string 1</OrderNumber> <PONumber>sample string 2</PONumber> <DocType>sample string 3</DocType> <Status>sample string 4</Status> <Total>5</Total> <DateEntered>sample string 6</DateEntered> <LastChanged>sample string 7</LastChanged> </OrderSummary> </ArrayOfOrderSummary>