Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Orders »

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 (XML)

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.
Response Code Error Code Message Description
0 - Invalid Order Number The order number is invalid, or not entered.

Code Samples

Sample Order View Response XML

<?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>Sherry Sandwith</createdBy>
        <currency>CAD</currency>
        <status>PAID</status>
        <paymentTerms>30</paymentTerms>
        <customer>
            <customerCode>12A1169</customerCode>
            <businessName>ABC Fish Store</businessName>
            <contactName>Tegan Barry</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>Tegan Barry</contactName>
            <businessName>ABC Fish Store</businessName>
            <street1>123 Street</street1>
            <street2>Unit 2</street2>
            <city>Calgary</city>
            <province>Alberta</province>
            <country>Canada</country>
            <postalCode>T3H 5T6</postalCode>
            <phone>403-708-2976</phone>
            <fax></fax>
            <email>tbarry@crazy.fishlady</email>
        </billingAddress>
        <shippingAddress>
            <contactName>Tegan Barry</contactName>
            <businessName>ABC Fish Store</businessName>
            <street1>123 Street</street1>
            <street2>Unit 2</street2>
            <city>Calgary</city>
            <province>Alberta</province>
            <country>Canada</country>
            <postalCode>T3H 5T6</postalCode>
            <phone>403-708-2976</phone>
            <fax></fax>
            <email>tbarry@telus.net</email>
        </shippingAddress>
        <items>
            <item>
                <sku>369874</sku>
                <description>Cartoon Fish [369874]</description>
                <serialNumber></serialNumber>
                <quantity>5.00</quantity>
                <price>1.00</price>
                <total>5.00</total>
            </item>
            <item>
                <sku>985263</sku>
                <description>Orange and Blue Fish [985263]</description>
                <serialNumber></serialNumber>
                <quantity>5.00</quantity>
                <price>13.00</price>
                <total>65.00</total>
            </item>
        </items>
        <transactions>
		</transactions>
    </order>
</orders>

HTML Form Sample HTML

<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">