GetSalesOrder
Description
The GetSalesOrder method retrieves a SalesOrder object from the EBizCharge platform.
Syntax
SalesOrder GetSalesOrder(SecurityToken securityToken string customerId, string subCustomerId, string salesOrderNumber, string salesOrderInternalID)
Arguments
Type | Name | Description | |
|---|---|---|---|
securityToken | R | A unique token that is used to identify a merchant and authenticate the API request. | |
string | customerId | D | Filters sales orders by Customer. |
string | subCustomerId | D | Filters sales orders by SubCustomer.
|
string | salesOrderNumber | D | Identifies the SalesOrder to retrieve. |
string | salesOrderInternalId | D | Identifies the SalesOrder to retrieve. Note: Required if |
Return Value
| Type | Description |
|---|---|
| SalesOrder | On success, returns the requested SalesOrder object. Otherwise, a fault is returned. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
<soapenv:Header/>
<soapenv:Body>
<ebiz:GetSalesOrder>
<ebiz:securityToken>
<ebiz:SecurityId>*****************36c223-3498237489-***********</ebiz:SecurityId>
<ebiz:UserId/>
<ebiz:Password/>
</ebiz:securityToken>
<ebiz:customerId/>
<ebiz:subCustomerId/>
<ebiz:salesOrderNumber/>
<ebiz:salesOrderInternalId>********-c8f9-4bc0-9691-********</ebiz:salesOrderInternalId>
</ebiz:GetSalesOrder>
</soapenv:Body>
</soapenv:Envelope>public function GetSalesOrder()
{
$client = new SoapClient('End point URL');
$securityToken = array(
'SecurityId' => '******-454757-4567457-********',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
$response = $client->GetSalesOrder(array(
'securityToken' => $securityToken,
'customerId' => '123',
'salesOrderNumber' => '00102566',
'salesOrderInternalId' => '******35-543543-435******'
));
$result = $response->GetSalesOrderResult;
}public void GetSalesOrder()
{
eBizService apiClient = new eBizService();
SecurityToken securityToken = new SecurityToken
{
SecurityId = "*******-c870-41b8-aa5c-********",
UserId = "",
Password = ""
};
//Getting Salesorder
SalesOrder salesOrder = apiClient.GetSalesOrder(securityToken, "APIINVCust", "", "", "********-7dfd-4aad-ae21-********");
Console.WriteLine(salesOrder.SalesOrderNumber);
Console.ReadLine();
}Example 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>testing-1</CustomerId>
<SubCustomerId/>
<SalesOrderNumber>So107</SalesOrderNumber>
<SalesOrderInternalId>********-c8f9-4bc0-9691-********</SalesOrderInternalId>
<Date>2025-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>
<GrossPrice>0.0000</GrossPrice>
<WarrantyDiscount>0.0000</WarrantyDiscount>
<SalesDiscount>0.0000</SalesDiscount>
<ItemClass/>
<ItemCustomFields/>
</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>
<GrossPrice>0.0000</GrossPrice>
<WarrantyDiscount>0.0000</WarrantyDiscount>
<SalesDiscount>0.0000</SalesDiscount>
<ItemClass/>
<ItemCustomFields/>
</Item>
</Items>
<Software>qb</Software>
<NotifyCustomer xsi:nil="true"/>
<URL/>
<TotalTaxAmount>20.2500</TotalTaxAmount>
<UniqueId>Sr001</UniqueId>
<Description>Sales Order</Description>
<BillingAddress>
<FirstName>Rachel</FirstName>
<LastName>Bayswater</LastName>
<CompanyName>CBS</CompanyName>
<Address1>Golden</Address1>
<Address2/>
<Address3/>
<City>Abyss</City>
<State>CA</State>
<ZipCode>56789</ZipCode>
<Country/>
<IsDefault>false</IsDefault>
<AddressId/>
</BillingAddress>
<ShippingAddress>
<FirstName>Rachel</FirstName>
<LastName>Bayswater</LastName>
<CompanyName>CBS</CompanyName>
<Address1>Golden</Address1>
<Address2/>
<Address3/>
<City>Abyss</City>
<State>CA</State>
<ZipCode>56788</ZipCode>
<Country/>
<IsDefault>false</IsDefault>
<AddressId>?</AddressId>
</ShippingAddress>
<CustomerMessage>Hello</CustomerMessage>
<Memo>Hello</Memo>
<ShipDate>7/8/2019 12:00:00 AM</ShipDate>
<ShipVia>USPS</ShipVia>
<TermsId>Net30</TermsId>
<IsToBeEmailed>false</IsToBeEmailed>
<IsToBePrinted>false</IsToBePrinted>
<SalesOrderCustomFields/>
<LocationId/>
</GetSalesOrderResult>
</GetSalesOrderResponse>
</s:Body>
</s:Envelope><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>Updated 6 months ago