GetSalesOrder

Description

This method allows you to view the stored data for a particular sales order.
This method requires the use of the customerlId, salesOrderNumber and salesOrderInternalId.

Syntax

SalesOrder GetSalesOrder(SecurityToken securityToken string customerId, string subCustomerId, string salesOrderNumber, string salesOrderInternalID).

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)

Return Value

Type

Description

SalesOrder

Returns result of GetSalesOrder request.

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetSalesOrder>
         <!--Optional:-->
         <ebiz:securityToken>
            <ebiz:SecurityId>we8d6105a-1906-4be3-b01d-e5d6cd68120c</ebiz:SecurityId>
            <ebiz:UserId>uid01</ebiz:UserId>
            <ebiz:Password>ps123</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:customerId>AIM</ebiz:customerId>
         <ebiz:subCustomerId/>
         <ebiz:salesOrderNumber>SO0005</ebiz:salesOrderNumber>
      </ebiz:GetSalesOrder>
   </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">
      <GetSalesOrderResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetSalesOrderResult>
            <CustomerId>AIM</CustomerId>
            <SubCustomerId/>
            <SalesOrderNumber>SO0005</SalesOrderNumber>
            <SalesOrderInternalId>d71ab488-c8f9-4bc0-9691-aca5e115be0f</SalesOrderInternalId>
            <Date>2019-01-01</Date>
            <Currency>USD</Currency>
            <Amount>120.2500</Amount>
            <DueDate>2019-02-05</DueDate>
            <AmountDue>115.2500</AmountDue>
            <PoNum>po0001</PoNum>
            <DivisionId>01</DivisionId>
            <Software>?</Software>
            <NotifyCustomer xsi:nil="true"/>
            <URL>?</URL>
            <TotalTaxAmount>20.0000</TotalTaxAmount>
            <UniqueId>0001x</UniqueId>
            <Description>?</Description>
            <BillingAddress>
               <FirstName>?</FirstName>
               <LastName>?</LastName>
               <CompanyName>?</CompanyName>
               <Address1>?</Address1>
               <Address2>?</Address2>
               <Address3>?</Address3>
               <City>?</City>
               <State>?</State>
               <ZipCode>?</ZipCode>
               <Country>?</Country>
               <IsDefault>false</IsDefault>
               <AddressId>?</AddressId>
            </BillingAddress>
            <ShippingAddress>
               <FirstName>?</FirstName>
               <LastName>?</LastName>
               <CompanyName>?</CompanyName>
               <Address1>?</Address1>
               <Address2>?</Address2>
               <Address3>?</Address3>
               <City>?</City>
               <State>?</State>
               <ZipCode>?</ZipCode>
               <Country>?</Country>
               <IsDefault>false</IsDefault>
               <AddressId>?</AddressId>
            </ShippingAddress>
            <CustomerMessage>?</CustomerMessage>
            <Memo>?</Memo>
            <ShipDate>1/8/2020 12:00:00 AM</ShipDate>
            <ShipVia>?</ShipVia>
            <IsToBeEmailed>false</IsToBeEmailed>
            <IsToBePrinted>false</IsToBePrinted>
         </GetSalesOrderResult>
      </GetSalesOrderResponse>
   </s:Body>
</s:Envelope>


Response if Sales Order not found:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:NotFound</faultcode>
         <faultstring xml:lang="en-US">Not Found</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>