POST api/orders/lookup

Retrieves a filtered list of basic information for customers.

Request Information

URI Parameters

None.

Body Parameters

The parameters defining the requested items.

OrderLookupRequest
NameDescriptionTypeAdditional information
OrderNumbers

List of work order numbers to look up.

 Collection of integer

Maximum Count: 1500
StartingRowNumber

Starting row number

 integer

Default value is 0

Minimum value: 0
RowCount

Maximum number of rows to return.

 integer

Default value is 50

Minimum value: 1

Request Formats

application/json, text/json

Sample: 
{
  "OrderNumbers": [
    1,
    2
  ],
  "StartingRowNumber": 1,
  "RowCount": 2
}

application/xml, text/xml

Sample: 
<OrderLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <OrderNumbers>
    <int>1</int>
    <int>2</int>
  </OrderNumbers>
  <StartingRowNumber>1</StartingRowNumber>
  <RowCount>2</RowCount>
</OrderLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of basic customer information.

OrderLookupResponse
NameDescriptionTypeAdditional information
Orders

Information for the results of the current look up request

 Collection of OrderSummaryInformation

None.
RecordCount

Total count of records that match the criteria in the look up request.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "Orders": [
    {
      "OrderNumber": 1,
      "IsEstimate": true,
      "IsEstimateFinalized": true,
      "OrderStatus": 0,
      "ProductionStatus": 0,
      "CompanyName": "sample string 4",
      "BillToCompanyId": 5,
      "PricingSheetName": "sample string 6",
      "PricingSheetNumber": "sample string 7",
      "LocationName": "sample string 8",
      "AbcShopName": "sample string 9",
      "LastModifiedBy": "sample string 10",
      "LastModified": "2024-12-25T09:23:38.7164874-05:00",
      "PurchaseOrderNumber": "sample string 12",
      "ProjectNumber": "sample string 13",
      "ProjectName": "sample string 14",
      "OrderedBy": "sample string 15",
      "Taxes": 16.0,
      "Total": 17.0,
      "CurrencyDescriptor": "sample string 18"
    },
    {
      "OrderNumber": 1,
      "IsEstimate": true,
      "IsEstimateFinalized": true,
      "OrderStatus": 0,
      "ProductionStatus": 0,
      "CompanyName": "sample string 4",
      "BillToCompanyId": 5,
      "PricingSheetName": "sample string 6",
      "PricingSheetNumber": "sample string 7",
      "LocationName": "sample string 8",
      "AbcShopName": "sample string 9",
      "LastModifiedBy": "sample string 10",
      "LastModified": "2024-12-25T09:23:38.7164874-05:00",
      "PurchaseOrderNumber": "sample string 12",
      "ProjectNumber": "sample string 13",
      "ProjectName": "sample string 14",
      "OrderedBy": "sample string 15",
      "Taxes": 16.0,
      "Total": 17.0,
      "CurrencyDescriptor": "sample string 18"
    }
  ],
  "RecordCount": 1
}

application/xml, text/xml

Sample: 
<OrderLookupResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Orders>
    <OrderSummaryInformation>
      <OrderNumber>1</OrderNumber>
      <IsEstimate>true</IsEstimate>
      <IsEstimateFinalized>true</IsEstimateFinalized>
      <OrderStatus>Cancelled</OrderStatus>
      <ProductionStatus>Active</ProductionStatus>
      <CompanyName>sample string 4</CompanyName>
      <BillToCompanyId>5</BillToCompanyId>
      <PricingSheetName>sample string 6</PricingSheetName>
      <PricingSheetNumber>sample string 7</PricingSheetNumber>
      <LocationName>sample string 8</LocationName>
      <AbcShopName>sample string 9</AbcShopName>
      <LastModifiedBy>sample string 10</LastModifiedBy>
      <LastModified>2024-12-25T09:23:38.7164874-05:00</LastModified>
      <PurchaseOrderNumber>sample string 12</PurchaseOrderNumber>
      <ProjectNumber>sample string 13</ProjectNumber>
      <ProjectName>sample string 14</ProjectName>
      <OrderedBy>sample string 15</OrderedBy>
      <Taxes>16</Taxes>
      <Total>17</Total>
      <CurrencyDescriptor>sample string 18</CurrencyDescriptor>
    </OrderSummaryInformation>
    <OrderSummaryInformation>
      <OrderNumber>1</OrderNumber>
      <IsEstimate>true</IsEstimate>
      <IsEstimateFinalized>true</IsEstimateFinalized>
      <OrderStatus>Cancelled</OrderStatus>
      <ProductionStatus>Active</ProductionStatus>
      <CompanyName>sample string 4</CompanyName>
      <BillToCompanyId>5</BillToCompanyId>
      <PricingSheetName>sample string 6</PricingSheetName>
      <PricingSheetNumber>sample string 7</PricingSheetNumber>
      <LocationName>sample string 8</LocationName>
      <AbcShopName>sample string 9</AbcShopName>
      <LastModifiedBy>sample string 10</LastModifiedBy>
      <LastModified>2024-12-25T09:23:38.7164874-05:00</LastModified>
      <PurchaseOrderNumber>sample string 12</PurchaseOrderNumber>
      <ProjectNumber>sample string 13</ProjectNumber>
      <ProjectName>sample string 14</ProjectName>
      <OrderedBy>sample string 15</OrderedBy>
      <Taxes>16</Taxes>
      <Total>17</Total>
      <CurrencyDescriptor>sample string 18</CurrencyDescriptor>
    </OrderSummaryInformation>
  </Orders>
  <RecordCount>1</RecordCount>
</OrderLookupResponse>