This API call lets you email the receipt for an order. The response is an XML of the email order receipt action.
Request Fields
Field Name |
Type |
Required |
Description |
action |
String |
Yes |
orderEmailReceipt |
accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
apiToken |
String |
Yes |
API token used for authentication and access control. |
emailAddress |
String |
Yes |
The recepients email address. |
orderNumber |
String |
Yes |
The order number. |
Response Fields
Field Name |
Type |
Description |
message |
- |
XML structure |
response |
Integer |
1 or 0. Whether the order receipt was sent or not. |
responseMessage |
String |
Confirmation of action taken. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
Response Code |
Error Code |
Message |
Description |
0 |
- |
Invalid Email Address |
The email address was not entered, or was invalid. |
0 |
- |
Order Not Found |
The order number entered was not found. |
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. |