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