Support Centre

Hexicom Order API Integration 

Version: 4.0.0 

1. Introduction 

The Hexicom Order API uses the JSON message format and exposes a set of HTTP endpoints to manage orders within the ePrint system. The API supports the following core functionalities: 

All requests and responses are exchanged using JSON. 

2. Authentication 

All API requests must be made over HTTPS and are authenticated using Basic HTTP Authentication. 

Clients must include an Authorization header with each request: 

Authorization: Basic <credentials> 

Where <credentials> is the Base64-encoded value of: 

username:password 

For additional details, refer to: https://en.wikipedia.org/wiki/Basic_access_authentication 

3. Endpoints 

Customers must configure the following primary endpoints on their system. These endpoints are used to send and receive data through the API. 

3.1 Order Endpoint 

Used for all order-related operations. 

{hostname}/orderapi/api/order/ 

Example: 

https://demo.eprintsoftware.com/orderapi/api/order/ 

3.2 Product Endpoint 

Used for all product-related operations. 

{hostname}/orderapi/api/product/ 

Example: 

https://demo.eprintsoftware.com/orderapi/api/product/ 

4. Order API Calls 

All Order API calls use JSON as the standard request and response format. 

4.1 AddArtworkFile 

Method: POST 
URL: [baseURL]/AddArtworkFile 
Content-Type: application/json 

Parameters 

If OrderItemNo is provided, the artwork file is attached to the specified order item. If OrderItemNo is empty (""), the artwork file is attached to the order itself. 

Example Request 

https://demo.eprintsoftware.com/orderapi/api/Order/AddArtworkFile 

{ 
  "orderNo": "ORD-00012", 
  "fileLink": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", 
  "orderItemNo": "ORD-00012-0stt01" 
} 

4.2 UpdateOrderStatus 

Method: POST 
URL: [baseURL]/UpdateOrderStatus 
Content-Type: application/json 

Parameters 

Description 

This API updates the status of an order or an order item. 

If a job or invoice exists for the order, their statuses are also updated when applicable. Each module (estimate, job, invoice, etc.) maintains its own set of valid statuses. If the specified status does not exist for a module, that module is not updated. 

Example Request 

{ 
  "orderNo": "ORD-00012", 
  "orderStatus": "Printing", 
  "orderItemNo": "ORD-00012-001", 
  "orderItemStatus": "Printing", 
  "statusType": 1 
} 

4.3 AddOtherCost 

Method: POST 
URL: [baseURL]/AddOtherCost 
Content-Type: application/json 

Parameters 

Description 

Adds an additional (other) cost to an existing order or a specific order item. 

Example Request 

{ 
  "orderNo": "ORD-00012", 
  "orderItemNo": "ORD-00012-001", 
  "otherCostName": "Trim" 
} 

4.4 PostOrder 

Method: POST 
URL: [baseURL]/PostOrder 
Content-Type: application/json 

Description 

Creates a new order in the ePrint system. The request includes customer, order, destination, item, and payment details.  

Pricing Input Rules 

For each order item, pricing information can be supplied in one of the following ways only: - Retail Price (with or without Tax Price), or - Selling Price 

Retail Price and Selling Price must not be passed together for the same order item in a single API request. If both values are supplied, the request may be rejected or pricing calculations may produce unexpected results. 

Based on the pricing data provided, the system calculates the remaining values such as tax, subtotal, markup, and cost using product and system configuration. 

Pricing, Tax, and Cost Calculation Logic 

The PostOrder API supports multiple pricing input scenarios. Depending on the pricing information supplied in the API request, the system determines the final selling price, tax, subtotal, markup, and cost by applying predefined business rules. 

The following cases describe how pricing data is processed. 

Case 1: Selling Price Provided via API 

API Input 

Derived from Product / System 

Processing Logic 

Case 2: Retail Price and Tax Price Provided via API 

API Input 

Derived from Product / System 

Processing Logic 

Case 3: Retail Price Provided via API 

API Input 

Derived from Product / System 

Processing Logic 

Case 4: Product-Based Pricing Only 

API Input 

Derived from Product / System 

Processing Logic 

Processing Flow 

Mandatory Fields 

The following fields are required to successfully process a PostOrder request. If any of these fields are missing or invalid, the API will return a validation error. 

Optional Fields 

The following fields are optional but recommended to ensure a complete and detailed order record. 

Destination 

OrderItems 

Payment 

Example 1: Complete API Request 

This example demonstrates a full request payload including both mandatory and optional fields. 

{ 
  "CompanyInfo": { 
    "CompanyName": "Skywalker", 
    "Division": "abc", 
    "AccountNo": "" 
  }, 
  "ExternalOrderID": "POSTMAN-78", 
  "OrderNotes": "Test Notes", 
  "CustomerOrderID": "10", 
  "OrderDate": "2020-07-17T07:55:21+11:00", 
  "DueDate": "2020-10-17T06:00:00+11:00", 
  "Currency": "AUD", 
  "Destination": { 
    "DestinationID": "Dest1", 
    "ShipMethod": "Despatch_Economy", 
    "ShipTo": { 
      "Name": "Nicola Smith", 
      "Address1": "42 Sunpeaks Court", 
      "Address2": [], 
      "Address3": [], 
      "City": "Upper Coomera", 
      "State": "QLD", 
      "Postal": "4209", 
      "Country": "AUS", 
      "Phone": [], 
      "Email": "nicola@testcustomer.com" 
    } 
  }, 
  "OrderItems": [ 
    { 
      "DestinationRef": "Dest1", 
      "Sku": "P0000170", 
      "Quantity": "50", 
      "otherCostNames": [{ "otherCostName": "Testing" }], 
      "fileLink": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", 
      "RetailPrice": "200", 
      "TaxPrice": "20", 
      "ItemTitle": "Test Title", 
      "Description": "Test Description", 
      "Artwork": "Test Artwork", 
      "Colour": "Test Colour", 
      "Size": "Test Size", 
      "Material": "Test Material", 
      "Delivery": "Test Delivery", 
      "Finishing": "Test Finishing", 
      "Proofs": "Test Proof", 
      "Packing": "Test Packing", 
      "Notes": "Test Notes", 
      "Instructions": "Test Instructions" 
    } 
  ], 
  "Payment": { 
    "AmountPaid": "150.00000", 
    "Description": "Paypal ref 521a", 
    "Date": "2023-05-12T07:55:21+11:00" 
  } 
} 

Example 2: Mandatory Fields Only 

This example demonstrates the minimum payload required for a successful request. 

{ 
  "CompanyInfo": { 
    "CompanyName": "Skywalker" 
  }, 
  "ExternalOrderID": "4175dca1193", 
  "Destination": { 
    "ShipTo": { 
      "Name": "Test Name", 
      "Address1": "42 Test Street" 
    } 
  }, 
  "OrderItems": [ 
    { 
      "Sku": "P0000170", 
      "Quantity": 50 
    } 
  ], 
  "Payment": {} 
} 

This section serves as a reference for integrating with the PostOrder API and ensures that requests are properly structured and validated. 

Response 

On successful execution, the API response includes: - The generated Order Number - The generated Order Item Numbers for each created order item 

5. Product API 

Product Base URL 

[ProductBaseURL] 

Example: 

https://demo.eprintsoftware.com/orderapi/api/Product/ 

5.1 GetAllProducts 

Method: GET 
URL: [ProductBaseURL]/GetAllProducts 

Parameters 

Description 

Retrieves all products allocated to a specific customer. If CustomerName is empty or not provided, all available products are returned. 

Example Requests 

https://demo.eprintsoftware.com/orderapi/api/Product/GetAllProducts?ProductDetail={"CustomerName":"Care Homes Inc"} 

https://demo.eprintsoftware.com/orderapi/api/Product/GetAllProducts?ProductDetail={"CustomerName":""} 

5.2 GetProductByProductCode 

Method: GET 
URL: [ProductBaseURL]/GetProductByProductCode 

Parameters 

Description 

Retrieves detailed information for a specific product identified by ProductCode. 

Example Request 

https://demo.eprintsoftware.com/orderapi/api/Product/GetProductByProductCode?ProductDetail={"ProductCode":"1031939"} 

5.3 GetProductStock 

Method: GET 
URL: [ProductBaseURL]/GetProductStock 

Parameters 

Description 

Retrieves current stock information for a specific product. 

Example Request 

https://demo.eprintsoftware.com/orderapi/api/Product/GetProductStock?ProductDetail={"ProductCode":"100109"} 

5.4 GetFile 

Method: GET 
URL: [ProductBaseURL]/GetFile 

Parameters 

Description 

Retrieves the associated image file for a specific product. 

Example Request 

https://demo.eprintsoftware.com/orderapi/api/Product/GetFile?ProductDetail={"ProductCode":"P0001537"} 

5.5 CreateThumbNailUrl 

Method: GET 
URL: [ProductBaseURL]/CreateThumbNailUrl 

Parameters 

Description 

Generates and returns a thumbnail URL for the specified product catalogue entry. 

Example Request 

https://demo.eprintsoftware.com/orderapi/api/Product/CreateThumbNailUrl?ProductCatalogue={"ProductCatalogueID":"3174"}