SearchSalesOrders

Description

This method allows you to search sales orders.

Syntax

SalesOrder[] SearchSalesOrders(SecurityToken](doc:securitytoken) securityToken , string customerId, string subCustomerId, string salesOrderNumber, string salesOrderInternalId, SearchFilter[] filters, int start, int limit, string sort, bool includeItems).

Arguments

Type

Name

Description

SecurityToken

securityToken

Merchant security token: used to identify merchant and validate transaction. (required)

String

customerId

Customer ID. (required)

String

subCustomerId

Sub-customer ID. (optional)

String

salesOrderNumber

Sales order number. (required)

String

salesOrderInternalId

Unique internal sales order ID assigned by EBizCharge. (required)

SearchFilter

filters

Search filters.

Int

start

Start position, defaults to 0 (first payment found). (required)

Int

limit

Maximum number of payments to return in result. Default Max 1000. (required)

String

sort

Field name to sort the results by. (optional)

Bool

includeItems

Include items

Return Value

Type

Description

SalesOrder[]

Returns an array of sales order matching the specified search parameters.

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:SearchSalesOrders>
         <ebiz:securityToken>
            <ebiz:SecurityId>w8d6105a-1906-4be3-b01d-e5d6cd68120c</ebiz:SecurityId>
            <ebiz:UserId>id1</ebiz:UserId>
            <ebiz:Password>pass1</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:customerId/>
         <ebiz:subCustomerId/>
         <ebiz:salesOrderNumber/>
         <ebiz:salesOrderInternalId/>
         <ebiz:filters>
            <ebiz:SearchFilter>
               <ebiz:FieldName>SoftwareId</ebiz:FieldName>
               <ebiz:ComparisonOperator>eq</ebiz:ComparisonOperator>
               <ebiz:FieldValue>qb</ebiz:FieldValue>
            </ebiz:SearchFilter>
         </ebiz:filters>
         <ebiz:start>1</ebiz:start>
         <ebiz:limit>200</ebiz:limit>
         <ebiz:sort/>
         <ebiz:includeItems>true</ebiz:includeItems>
      </ebiz:SearchSalesOrders>
   </soapenv:Body>
</soapenv:Envelope>


Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <SearchSalesOrdersResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <SearchSalesOrdersResult>
            <SalesOrder>
               <CustomerId>AIM</CustomerId>
               <SubCustomerId/>
               <SalesOrderNumber>729-1</SalesOrderNumber>
               <SalesOrderInternalId>4b112740-9b7f-445d-9078-5719f1971c9c</SalesOrderInternalId>
               <Date>2019-07-01</Date>
               <Currency></Currency>
               <Amount>125.4500</Amount>
               <DueDate>2019-07-20</DueDate>
               <AmountDue>100.2500</AmountDue>
               <PoNum>po001</PoNum>
               <DivisionId>01</DivisionId>
               <Items>
                  <Item>
                     <ItemId>01-00097</ItemId>
                     <Name>01-00097</Name>
                     <Description>Wall Mounted Vent-free Gas Fireplace</Description>
                     <UnitPrice>20.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>200.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
               </Items>
               <Software>qb</Software>
               <NotifyCustomer xsi:nil="true"/>
               <URL/>
               <TotalTaxAmount>20.2500</TotalTaxAmount>
               <UniqueId>Sr001</UniqueId>
               <SalesRepId>Jef04</SalesRepId>
               <TermsId>Net30</TermsId>
               <IsToBeEmailed>true</IsToBeEmailed>
               <IsToBePrinted>false</IsToBePrinted>
            </SalesOrder>
            <SalesOrder>
               <CustomerId>AIM</CustomerId>
               <SubCustomerId/>
               <SalesOrderNumber>SO0009</SalesOrderNumber>
               <SalesOrderInternalId>b10ed775-1151-4979-822b-13aa62a23d69</SalesOrderInternalId>
               <Date>2019-07-01</Date>
               <Currency></Currency>
               <Amount>125.4500</Amount>
               <DueDate>2019-07-20</DueDate>
               <AmountDue>100.2500</AmountDue>
               <PoNum>po001</PoNum>
               <DivisionId>01</DivisionId>
               <Items>
                  <Item>
                     <ItemId>01-00097</ItemId>
                     <Name>01-00097</Name>
                     <Description>Wall Mounted Vent-free Gas Fireplace</Description>
                     <UnitPrice>20.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>200.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
               </Items>
               <Software>qb</Software>
               <NotifyCustomer xsi:nil="true"/>
               <URL/>
               <TotalTaxAmount>20.2500</TotalTaxAmount>
               <UniqueId>Sr001</UniqueId>
               <SalesRepId>Jef04</SalesRepId>
               <TermsId>Net30</TermsId>
               <IsToBeEmailed>false</IsToBeEmailed>
               <IsToBePrinted>true</IsToBePrinted>
               <SalesOrderLastSyncDateTime>2019-08-30 16:41:00</SalesOrderLastSyncDateTime>
            </SalesOrder>
            <SalesOrder>
               <CustomerId>AIM</CustomerId>
               <SubCustomerId/>
               <SalesOrderNumber>So101</SalesOrderNumber>
               <SalesOrderInternalId>bfa9e5ff-f418-4ccf-bd26-bba26aba405c</SalesOrderInternalId>
               <Date>2019-07-01</Date>
               <Currency></Currency>
               <Amount>125.4500</Amount>
               <DueDate>2019-07-20</DueDate>
               <AmountDue>100.2500</AmountDue>
               <PoNum>po001</PoNum>
               <DivisionId>01</DivisionId>
               <Items>
                  <Item>
                     <ItemId>01-00097</ItemId>
                     <Name>01-00097</Name>
                     <Description>Wall Mounted Vent-free Gas Fireplace</Description>
                     <UnitPrice>20.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>200.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
               </Items>
               <Software>qb</Software>
               <NotifyCustomer xsi:nil="true"/>
               <URL/>
               <TotalTaxAmount>20.2500</TotalTaxAmount>
               <UniqueId>Sr001</UniqueId>
               <SalesRepId>Jef04</SalesRepId>
               <TermsId>Net30</TermsId>
               <IsToBeEmailed>true</IsToBeEmailed>
               <IsToBePrinted>false</IsToBePrinted>
               <SalesOrderLastSyncDateTime>2019-08-23 22:59:34</SalesOrderLastSyncDateTime>
            </SalesOrder>
            <SalesOrder>
               <CustomerId>AIM</CustomerId>
               <SubCustomerId/>
               <SalesOrderNumber>So106</SalesOrderNumber>
               <SalesOrderInternalId>08bdc645-1aa2-4e1e-b02f-85e58314872f</SalesOrderInternalId>
               <Date>2019-07-01</Date>
               <Currency></Currency>
               <Amount>125.4500</Amount>
               <DueDate>2019-07-20</DueDate>
               <AmountDue>100.2500</AmountDue>
               <PoNum>po001</PoNum>
               <DivisionId>01</DivisionId>
               <Items>
                  <Item>
                     <ItemId>01-00097</ItemId>
                     <Name>01-00097</Name>
                     <Description>Wall Mounted Vent-free Gas Fireplace</Description>
                     <UnitPrice>20.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>200.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
               </Items>
               <Software>qb</Software>
               <NotifyCustomer xsi:nil="true"/>
               <URL/>
               <TotalTaxAmount>20.2500</TotalTaxAmount>
               <UniqueId>Sr001</UniqueId>
               <SalesRepId>Jef04</SalesRepId>
               <TermsId>Net30</TermsId>
               <IsToBeEmailed>true</IsToBeEmailed>
               <IsToBePrinted>false</IsToBePrinted>
               <SalesOrderLastSyncDateTime>2019-09-20 16:53:32</SalesOrderLastSyncDateTime>
            </SalesOrder>
            <SalesOrder>
               <CustomerId>AIM</CustomerId>
               <SubCustomerId/>
               <SalesOrderNumber>So107</SalesOrderNumber>
               <SalesOrderInternalId>5301b691-56d6-45e3-a7e1-21217917666a</SalesOrderInternalId>
               <Date>2019-07-01</Date>
               <Currency></Currency>
               <Amount>125.4500</Amount>
               <DueDate>2019-07-20</DueDate>
               <AmountDue>100.2500</AmountDue>
               <PoNum>po001</PoNum>
               <DivisionId></DivisionId>
               <Items>
                  <Item>
                     <ItemId>01-00098</ItemId>
                     <Name>01-00099</Name>
                     <Description>TV</Description>
                     <UnitPrice>2000.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>2000.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
                  <Item>
                     <ItemId>01-00097</ItemId>
                     <Name>01-00097</Name>
                     <Description>Wall Mounted Vent-free Gas Fireplace</Description>
                     <UnitPrice>20.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>200.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
               </Items>
               <Software>qb</Software>
               <NotifyCustomer xsi:nil="true"/>
               <URL/>
               <TotalTaxAmount>20.2500</TotalTaxAmount>
               <UniqueId>Sr001</UniqueId>
               <SalesRepId>Jef04</SalesRepId>
               <TermsId>Net30</TermsId>
               <IsToBeEmailed>false</IsToBeEmailed>
               <IsToBePrinted>false</IsToBePrinted>
            </SalesOrder>
            <SalesOrder>
               <CustomerId>AIM</CustomerId>
               <SubCustomerId/>
               <SalesOrderNumber>ss123</SalesOrderNumber>
               <SalesOrderInternalId>d33f5f1b-fa52-41fb-938f-8b7df4276ba3</SalesOrderInternalId>
               <Date>2019-07-01</Date>
               <Currency></Currency>
               <Amount>125.4500</Amount>
               <DueDate>2019-07-20</DueDate>
               <AmountDue>100.2500</AmountDue>
               <PoNum>po001</PoNum>
               <DivisionId>01</DivisionId>
               <Items>
                  <Item>
                     <ItemId>01-00097</ItemId>
                     <Name>01-00097</Name>
                     <Description>Wall Mounted Vent-free Gas Fireplace</Description>
                     <UnitPrice>20.2500</UnitPrice>
                     <Qty>10.0000</Qty>
                     <Taxable>true</Taxable>
                     <TaxRate>0.0000</TaxRate>
                     <UnitOfMeasure>EA</UnitOfMeasure>
                     <TotalLineAmount>200.2500</TotalLineAmount>
                     <TotalLineTax>10.0000</TotalLineTax>
                     <ItemLineNumber>1</ItemLineNumber>
                  </Item>
               </Items>
               <Software>qb</Software>
               <NotifyCustomer xsi:nil="true"/>
               <URL/>
               <TotalTaxAmount>20.2500</TotalTaxAmount>
               <UniqueId>Sr001</UniqueId>
               <SalesRepId>Jef04</SalesRepId>
               <TermsId>Net30</TermsId>
               <IsToBeEmailed>true</IsToBeEmailed>
               <IsToBePrinted>true</IsToBePrinted>
            </SalesOrder>
         </SearchSalesOrdersResult>
      </SearchSalesOrdersResponse>
   </s:Body>
</s:Envelope>