POST v1/Order/OrderList
Returns one or more orders and summary information associated with each order.
This is secure method and requires below attributes in header
Request Information
URI Parameters
None.
Body Parameters
OrderListInputName | Description | Type | Additional information |
---|---|---|---|
OrderNumber |
Provide the OrderNumber |
string |
None. |
CopyFromOrderNumber |
Provide the CopyFromOrderNumber |
string |
None. |
CustomerCode |
Provide the CustomerCode |
string |
None. |
CustomerID |
Provide the CustomerID |
integer |
None. |
OrderDateFrom |
Provide the OrderDateFrom |
string |
None. |
OrderDateTo |
Provide the OrderStatus |
string |
None. |
OrderStatus |
Provide the OrderStatus |
string |
None. |
OrderDueDateFrom |
Provide the OrderDueDateFrom |
string |
None. |
OrderDueDateTo |
Provide the OrderDueDateTo |
string |
None. |
OrderCloseDateFrom |
(optional) leave blank for all orders to be returned. When provided and OpenOrdersOnly is false or null, all orders with an order close date greater than or equal to the date are returned. |
string |
None. |
OrderCloseDateTo |
(optional) leave blank for all orders to be returned. When provided and OpenOrdersOnly is false or null, all orders with an order close date less than or equal to the date are returned. |
string |
None. |
OpenOrdersOnly |
(optional) if true, OrderCloseDateFrom and OrderCloseDateTo parameters are ignored and only open orders are returned. If false, only closed orders are returned. If null, result set includes both open and closed orders. |
boolean |
None. |
OrderModifiedDate |
Provide the OrderModifiedDate |
string |
None. |
UDF11 |
Provide UDF11 |
string |
None. |
UDF12 |
Provide UDF12 |
string |
None. |
UDF13 |
Provide UDF13 |
string |
None. |
UDF14 |
Provide UDF14 |
string |
None. |
UDF15 |
Provide UDF15 |
string |
None. |
UDF16 |
Provide UDF16 |
string |
None. |
UDF17 |
Provide UDF17 |
string |
None. |
UDF18 |
Provide UDF18 |
string |
None. |
UDF19 |
Provide UDF19 |
string |
None. |
UDF20 |
Provide UDF20 |
string |
None. |
UDF21 |
Provide UDF21 |
string |
None. |
UDF22 |
Provide UDF22 |
string |
None. |
UDF23 |
Provide UDF23 |
string |
None. |
UDF24 |
Provide UDF24 |
string |
None. |
UDF25 |
Provide UDF25 |
string |
None. |
UDF26 |
Provide UDF26 |
string |
None. |
UDF27 |
Provide UDF27 |
string |
None. |
UDF28 |
Provide UDF28 |
string |
None. |
UDF29 |
Provide UDF29 |
string |
None. |
UDF30 |
Provide UDF30 |
string |
None. |
UDF1 |
Provide UDF1 |
string |
None. |
UDF2 |
Provide UDF2 |
string |
None. |
UDF3 |
Provide UDF3 |
string |
None. |
UDF4 |
Provide UDF4 |
string |
None. |
UDF5 |
Provide UDF5 |
string |
None. |
UDF6 |
Provide UDF6 |
string |
None. |
UDF7 |
Provide UDF7 |
string |
None. |
UDF8 |
Provide UDF8 |
string |
None. |
UDF9 |
Provide UDF9 |
string |
None. |
UDF10 |
Provide UDF10 |
string |
None. |
Request Formats
application/json, text/json
{ "OrderNumber": "sample string 1", "CopyFromOrderNumber": "sample string 2", "CustomerCode": "sample string 3", "CustomerID": 1, "OrderDateFrom": "sample string 4", "OrderDateTo": "sample string 5", "OrderStatus": "sample string 6", "OrderDueDateFrom": "sample string 7", "OrderDueDateTo": "sample string 8", "OrderCloseDateFrom": "sample string 9", "OrderCloseDateTo": "sample string 10", "OpenOrdersOnly": true, "OrderModifiedDate": "sample string 11", "UDF1": "sample string 32", "UDF2": "sample string 33", "UDF3": "sample string 34", "UDF4": "sample string 35", "UDF5": "sample string 36", "UDF6": "sample string 37", "UDF7": "sample string 38", "UDF8": "sample string 39", "UDF9": "sample string 40", "UDF10": "sample string 41", "UDF11": "sample string 12", "UDF12": "sample string 13", "UDF13": "sample string 14", "UDF14": "sample string 15", "UDF15": "sample string 16", "UDF16": "sample string 17", "UDF17": "sample string 18", "UDF18": "sample string 19", "UDF19": "sample string 20", "UDF20": "sample string 21", "UDF21": "sample string 22", "UDF22": "sample string 23", "UDF23": "sample string 24", "UDF24": "sample string 25", "UDF25": "sample string 26", "UDF26": "sample string 27", "UDF27": "sample string 28", "UDF28": "sample string 29", "UDF29": "sample string 30", "UDF30": "sample string 31" }
application/xml, text/xml
<OrderListInput xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <UDF1>sample string 32</UDF1> <UDF2>sample string 33</UDF2> <UDF3>sample string 34</UDF3> <UDF4>sample string 35</UDF4> <UDF5>sample string 36</UDF5> <UDF6>sample string 37</UDF6> <UDF7>sample string 38</UDF7> <UDF8>sample string 39</UDF8> <UDF9>sample string 40</UDF9> <UDF10>sample string 41</UDF10> <UDF11>sample string 12</UDF11> <UDF12>sample string 13</UDF12> <UDF13>sample string 14</UDF13> <UDF14>sample string 15</UDF14> <UDF15>sample string 16</UDF15> <UDF16>sample string 17</UDF16> <UDF17>sample string 18</UDF17> <UDF18>sample string 19</UDF18> <UDF19>sample string 20</UDF19> <UDF20>sample string 21</UDF20> <UDF21>sample string 22</UDF21> <UDF22>sample string 23</UDF22> <UDF23>sample string 24</UDF23> <UDF24>sample string 25</UDF24> <UDF25>sample string 26</UDF25> <UDF26>sample string 27</UDF26> <UDF27>sample string 28</UDF27> <UDF28>sample string 29</UDF28> <UDF29>sample string 30</UDF29> <UDF30>sample string 31</UDF30> <OrderNumber>sample string 1</OrderNumber> <CopyFromOrderNumber>sample string 2</CopyFromOrderNumber> <CustomerCode>sample string 3</CustomerCode> <CustomerID>1</CustomerID> <OrderDateFrom>sample string 4</OrderDateFrom> <OrderDateTo>sample string 5</OrderDateTo> <OrderStatus>sample string 6</OrderStatus> <OrderDueDateFrom>sample string 7</OrderDueDateFrom> <OrderDueDateTo>sample string 8</OrderDueDateTo> <OrderCloseDateFrom>sample string 9</OrderCloseDateFrom> <OrderCloseDateTo>sample string 10</OrderCloseDateTo> <OpenOrdersOnly>true</OpenOrdersOnly> <OrderModifiedDate>sample string 11</OrderModifiedDate> </OrderListInput>
application/x-www-form-urlencoded
Response Information
Response Formats
application/json, text/json
[ { "OrderID": 1, "OrderNumber": "sample string 2", "CustomerID": 3, "CustomerName": "sample string 4", "ContactName": "sample string 5", "SalesRepName": "sample string 6", "CSRName": "sample string 7", "ProjectName": "sample string 8", "LicenseeName": "sample string 9", "PurchaseOrderNumber": "sample string 10", "Terms": "sample string 11", "Taxable": true, "OrderStatus": "sample string 13", "OrderDate": "sample string 14", "DataInDate": "sample string 15", "MaterialInDate": "sample string 16", "ArtworkInDate": "sample string 17", "DueDate": "sample string 18", "CloseDate": "sample string 19", "QuantityExpected": 20, "OrderProgressCode": "sample string 21", "OrderProgressText": "sample string 22", "OrderTax": 23.0, "OrderTotal": 24.0, "ShipDate": "sample string 25", "JobType": "sample string 26", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" } }, { "OrderID": 1, "OrderNumber": "sample string 2", "CustomerID": 3, "CustomerName": "sample string 4", "ContactName": "sample string 5", "SalesRepName": "sample string 6", "CSRName": "sample string 7", "ProjectName": "sample string 8", "LicenseeName": "sample string 9", "PurchaseOrderNumber": "sample string 10", "Terms": "sample string 11", "Taxable": true, "OrderStatus": "sample string 13", "OrderDate": "sample string 14", "DataInDate": "sample string 15", "MaterialInDate": "sample string 16", "ArtworkInDate": "sample string 17", "DueDate": "sample string 18", "CloseDate": "sample string 19", "QuantityExpected": 20, "OrderProgressCode": "sample string 21", "OrderProgressText": "sample string 22", "OrderTax": 23.0, "OrderTotal": 24.0, "ShipDate": "sample string 25", "JobType": "sample string 26", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" } } ]
application/xml, text/xml
<ArrayOfOrderListOutput xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <OrderListOutput> <OrderID>1</OrderID> <OrderNumber>sample string 2</OrderNumber> <CustomerID>3</CustomerID> <CustomerName>sample string 4</CustomerName> <ContactName>sample string 5</ContactName> <SalesRepName>sample string 6</SalesRepName> <CSRName>sample string 7</CSRName> <ProjectName>sample string 8</ProjectName> <LicenseeName>sample string 9</LicenseeName> <PurchaseOrderNumber>sample string 10</PurchaseOrderNumber> <Terms>sample string 11</Terms> <Taxable>true</Taxable> <OrderStatus>sample string 13</OrderStatus> <OrderDate>sample string 14</OrderDate> <DataInDate>sample string 15</DataInDate> <MaterialInDate>sample string 16</MaterialInDate> <ArtworkInDate>sample string 17</ArtworkInDate> <DueDate>sample string 18</DueDate> <CloseDate>sample string 19</CloseDate> <QuantityExpected>20</QuantityExpected> <OrderProgressCode>sample string 21</OrderProgressCode> <OrderProgressText>sample string 22</OrderProgressText> <OrderTax>23</OrderTax> <OrderTotal>24</OrderTotal> <ShipDate>sample string 25</ShipDate> <JobType>sample string 26</JobType> <UDFList> <UDF1>sample string 21</UDF1> <UDF2>sample string 22</UDF2> <UDF3>sample string 23</UDF3> <UDF4>sample string 24</UDF4> <UDF5>sample string 25</UDF5> <UDF6>sample string 26</UDF6> <UDF7>sample string 27</UDF7> <UDF8>sample string 28</UDF8> <UDF9>sample string 29</UDF9> <UDF10>sample string 30</UDF10> <UDF11>sample string 1</UDF11> <UDF12>sample string 2</UDF12> <UDF13>sample string 3</UDF13> <UDF14>sample string 4</UDF14> <UDF15>sample string 5</UDF15> <UDF16>sample string 6</UDF16> <UDF17>sample string 7</UDF17> <UDF18>sample string 8</UDF18> <UDF19>sample string 9</UDF19> <UDF20>sample string 10</UDF20> <UDF21>sample string 11</UDF21> <UDF22>sample string 12</UDF22> <UDF23>sample string 13</UDF23> <UDF24>sample string 14</UDF24> <UDF25>sample string 15</UDF25> <UDF26>sample string 16</UDF26> <UDF27>sample string 17</UDF27> <UDF28>sample string 18</UDF28> <UDF29>sample string 19</UDF29> <UDF30>sample string 20</UDF30> </UDFList> </OrderListOutput> <OrderListOutput> <OrderID>1</OrderID> <OrderNumber>sample string 2</OrderNumber> <CustomerID>3</CustomerID> <CustomerName>sample string 4</CustomerName> <ContactName>sample string 5</ContactName> <SalesRepName>sample string 6</SalesRepName> <CSRName>sample string 7</CSRName> <ProjectName>sample string 8</ProjectName> <LicenseeName>sample string 9</LicenseeName> <PurchaseOrderNumber>sample string 10</PurchaseOrderNumber> <Terms>sample string 11</Terms> <Taxable>true</Taxable> <OrderStatus>sample string 13</OrderStatus> <OrderDate>sample string 14</OrderDate> <DataInDate>sample string 15</DataInDate> <MaterialInDate>sample string 16</MaterialInDate> <ArtworkInDate>sample string 17</ArtworkInDate> <DueDate>sample string 18</DueDate> <CloseDate>sample string 19</CloseDate> <QuantityExpected>20</QuantityExpected> <OrderProgressCode>sample string 21</OrderProgressCode> <OrderProgressText>sample string 22</OrderProgressText> <OrderTax>23</OrderTax> <OrderTotal>24</OrderTotal> <ShipDate>sample string 25</ShipDate> <JobType>sample string 26</JobType> <UDFList> <UDF1>sample string 21</UDF1> <UDF2>sample string 22</UDF2> <UDF3>sample string 23</UDF3> <UDF4>sample string 24</UDF4> <UDF5>sample string 25</UDF5> <UDF6>sample string 26</UDF6> <UDF7>sample string 27</UDF7> <UDF8>sample string 28</UDF8> <UDF9>sample string 29</UDF9> <UDF10>sample string 30</UDF10> <UDF11>sample string 1</UDF11> <UDF12>sample string 2</UDF12> <UDF13>sample string 3</UDF13> <UDF14>sample string 4</UDF14> <UDF15>sample string 5</UDF15> <UDF16>sample string 6</UDF16> <UDF17>sample string 7</UDF17> <UDF18>sample string 8</UDF18> <UDF19>sample string 9</UDF19> <UDF20>sample string 10</UDF20> <UDF21>sample string 11</UDF21> <UDF22>sample string 12</UDF22> <UDF23>sample string 13</UDF23> <UDF24>sample string 14</UDF24> <UDF25>sample string 15</UDF25> <UDF26>sample string 16</UDF26> <UDF27>sample string 17</UDF27> <UDF28>sample string 18</UDF28> <UDF29>sample string 19</UDF29> <UDF30>sample string 20</UDF30> </UDFList> </OrderListOutput> </ArrayOfOrderListOutput>