View an Order

This API call let's you retrieve the details of a specific order. The response is an XML of the available order information.

Request Fields

Field Name	Type	Required	Description
action	String	Yes	orderView
accountId	Integer	Yes	The Helcim Commerce account ID.
apiToken	String	Yes	API token used for authentication and access control.
orderNumber	String	Yes	The order number.

Response Fields

Field Name	Type	Description
orders	-	XML structure
order	-	XML structure
orderNumber	String	The order number.
token	String	The order token.
dateCreated	String	The date the order was created.
dateIssued	String	The date the order was issued.
datePaid	String	The dated the order was paid.
createdBy	String	The name of the employee who took the order.
currency	String	The currency used.
status	String	The status of the order (paid/unpaid).
paymentTerms	Integer	The number of days the customer has to pay for the order.
customer	-	XML structure
customerCode	String	The customer code.
businessName	String	The business name.
contactName	String	The contact name.
customer	-	XML structure
amount	Decimal	The order's price.
amountDue	Decimal	The remaining amount due for the order.
amountTip	Decimal	The tip.
discount	-	XML structure
amountDiscount	Decimal	The dollar amount of the discount for the order.
discountDetails	String	Description of discount .
discount	-	XML structure
tax	-	XML structure
amountTax	Decimal	The total amount of tax for the order.
taxDetails	String	The details of the taxes for the order.
tax	-	XML structure
shipping	-	XML structure
amountShipping	Decimal	The cost of shipping.
shippingMethod	String	The shipping method.
shipping	-	XML structure
subscriptionId	Integer	The subscription ID.
comments	String	The comments.
billingAddress	-	XML structure
contactName	String	The contact name.
businessName	String	The business name.
street1	String	The street address.
street2	String	The street address.
city	String	The city.
province	String	The province.
country	String	The country.
postalCode	String	The postal code.
phone	String	The phone number.
fax	String	The fax number.
email	String	The email address.
billingAddress	-	XML structure
shippingAddress	-	XML structure
contactName	String	The contact name.
businessName	String	The business name.
street1	String	The street address.
street2	String	The street address.
city	String	The city.
province	String	The province.
country	String	The country.
postalCode	String	The postal code.
phone	String	The phone number.
fax	String	The fax number.
email	String	The email address.
shippingAddress	-	XML structure
items	-	XML structure
item	-	XML structure
sku	Integer	The product sku.
description	String	The product description.
serialNumber	String	The product serial number.
quantity	Decimal	The product quantity.
price	Decimal	The price per unit.
total	Decimal	The total price.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.

Error Code	Message	Description
-	Invalid Order Number	The order number is invalid, or not entered.
-	Invalid API Token1	The API Token is invalid, or not entered.
-	Missing or Invalid Fields - Account ID	The Account ID is invalid, or not entered.

Add or Edit an Order

List Orders

Send an Order Receipt

Create an Order PDF

Was this article helpful?

Click here if you return to the content

Code Samples

[XML] Sample Response - View an Order

<?xml version="1.0"?>
<orders>
    <order>
        <orderNumber>ORDR11464</orderNumber>
        <token>ca62bfd62aeeba8d42fd42</token>
        <dateCreated>2017-06-16 14:47:43</dateCreated>
        <dateIssued>2017-06-16 00:00:00</dateIssued>
        <datePaid>2017-06-16 15:24:36</datePaid>
        <createdBy>Sample Name</createdBy>
        <currency>CAD</currency>
        <status>PAID</status>
        <paymentTerms>30</paymentTerms>
        <customer>
            <customerCode>12A1169</customerCode>
            <businessName>Sample Store</businessName>
            <contactName>Business Owner</contactName>
        </customer>
        <amount>73.50</amount>
        <amountDue>0.00</amountDue>
        <amountTip>73.50</amountTip>
        <discount>
            <amountDiscount>0.00</amountDiscount>
            <discountDetails></discountDetails>
        </discount>
        <tax>
            <amountTax>3.50</amountTax>
            <taxDetails>GST 5.00%</taxDetails>
        </tax>
        <shipping>
            <amountShipping>0.00</amountShipping>
            <shippingMethod></shippingMethod>
        </shipping>
        <subscriptionId>0</subscriptionId>
        <comments></comments>
        <billingAddress>
            <contactName>Business Owner</contactName>
            <businessName>Sample Store</businessName>
            <street1>123 Street</street1>
            <street2>Unit 2</street2>
            <city>Calgary</city>
            <province>Alberta</province>
            <country>Canada</country>
            <postalCode>T1T 1T1</postalCode>
            <phone>555-555-5555</phone>
            <fax></fax>
            <email>sample@example.com</email>
        </billingAddress>
        <shippingAddress>
            <contactName>Business Owner</contactName>
            <businessName>Sample Store</businessName>
            <street1>123 Street</street1>
            <street2>Unit 2</street2>
            <city>Calgary</city>
            <province>Alberta</province>
            <country>Canada</country>
            <postalCode>T1T 1T1</postalCode>
            <phone>555-555-5555</phone>
            <fax></fax>
            <email>sample@example.com</email>
        </shippingAddress>
        <items>
            <item>
                <sku>369874</sku>
                <description>Sample Product [369874]</description>
                <serialNumber></serialNumber>
                <quantity>5.00</quantity>
                <price>1.00</price>
                <total>5.00</total>
            </item>
            <item>
                <sku>985263</sku>
                <description>Product 1 [985263]</description>
                <serialNumber></serialNumber>
                <quantity>5.00</quantity>
                <price>13.00</price>
                <total>65.00</total>
            </item>
        </items>
        <transactions>
		</transactions>
    </order>
</orders>

[HTML] HTML Form Sample

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="orderView">
<input type="hidden" name="orderNumber" value="ORDR11464">

View an Order

Request Fields

Response Fields

Errors

Related Articles

Was this article helpful?