Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Orders »

Create an Order PDF

This API call let's you create a pdf file from an order receipt. The response is an XML of the order PDF receipt action.

Request Fields

Field Name Type Required Description
action String Yes orderPDFReceipt
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
message - XML structure
response Integer 1 or 0. Whether the order pdf was created or not.
responseMessage String Confirmation of action taken.
pdf - XML Structure
name String The pdf file name.
content String BASE-64 ENCODED
height Decimal The height of the PDF in millimitres. 


For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Order Not Found The order number entered was not found.
0 - Invalid Order Number The order number is invalid, or not entered.

Code Samples

Sample Order PDF Receipt Response XML

<?xml version="1.0"?>
        <content>BASE-64 ENCODED</content>

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