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

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

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.

Errors

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.
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
List Orders
Send an Order Receipt

Was this article helpful?

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