Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Orders »

List Orders

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

Request Fields

Field Name Type Required Description
action String Yes orderSearch
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
customerCode String No The customer code.

Response Fields (XML)

Field Name Type Description
orders - XML structure
order - XML structure
orderNumber String The order number.
token String The order token.
amount Decimal The order amount.
currency String The currency the order amount is listed in.
customerCode String The customer code.
createdBy String The user that created this order.
status String The status of the order (paid/unpaid).
dateCreated String The date the order was created.
dateIssued String The date the order was issued.
datePaid String The date the order was paid.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Customer Code The customer code entered is invalid.
0 - No Results The search returned no results.

Code Samples

Sample Order Search Response XML

<?xml version="1.0"?>
<orders>
  <order>
        <orderNumber>ORDR11055</orderNumber>
        <token>1083fe3be32dd3acbd89c4</token>
        <amount>40.00</amount>
        <currency>CAD</currency>
        <customerCode></customerCode>
        <createdBy>Helcim System</createdBy>
        <status>PAID</status>
        <dateCreated>2017-05-29 09:54:33</dateCreated>
        <dateIssued>2017-05-29 09:54:29</dateIssued>
        <datePaid>0000-00-00 00:00:00</datePaid>
    </order>
    <order>
        <orderNumber>ORDR11054</orderNumber>
        <token>a789ffa0d007fe518dc0f3</token>
        <amount>52.50</amount>
        <currency>CAD</currency>
        <customerCode></customerCode>
        <createdBy>Helcim System</createdBy>
        <status>DUE</status>
        <dateCreated>2017-05-29 09:50:03</dateCreated>
        <dateIssued>2017-05-29 09:50:03</dateIssued>
        <datePaid>0000-00-00 00:00:00</datePaid>
    </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="orderSearch">
<input type="hidden" name="customerCode" value="12A1170">