Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

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

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.
0 - Invalid API Token1 The API Token is invalid, or not entered.
0 - Missing or Invalid Fields - Account ID The Account ID is invalid, or not entered.

Related Articles

View an Order
Add or Edit an Order
Send an Order Receipt
Create an Order PDF

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content