Order Import Configuration – API

Sales orders can be imported from applications that expose orders via an API, such as EvolutionX, our best-in-class e-commerce solution. APIs allow systems to communicate securely, reliably and efficiently.

Setting Up Sales Order Import from EvolutionX

1. On the Utilities menu, click Order and Receipts Import Config.
2. Click the Order Import Configuration tab, then the Settings tab.
3. Under the list of sources, click [+].
4. In the Source list, click EvolutionX.
5. Select the delivery method of imported orders that will be placed on Hold. Click:
   • None – no orders held
   • Normal delivery orders – Default (bulk) and Delivery to us (pick and wrap) orders held
   • Direct delivery orders – Customer delivery by supplier (pick and wrap) orders held
   • All orders – all orders held
   • On stop traders – orders for on stop traders are held.
6. The following options apply to all imported orders. When selected:
   • Use file price – the price from the file is used, not the price calculated by Horizon
     • Hold price difference – if there is a price difference (and you have Use file price selected) the order is placed on hold
   • Allocate stock – if the order hasn’t been put on hold and isn’t a direct order stock is allocated
   • Use additional/swaps – if an additional or swap item is available, it will be used
   • Use file price on swaps – if an item is replaced with swap, the price from the file is used, not the price calculated by Horizon
   • Lock prices – the price from the source is used. In Horizon the line price is shown in red to indicate that pricing routines have been overridden.
   • Take payment on order – changes behaviour if an order is marked as prepaid.
     • When selected, orders will be marked as paid, a payment line will be added to the order and no invoice or sales receipt will be created for prepaid orders.
     • When cleared, a separate invoice and payment will be created and the transaction allocated.
       • Place SREC on hold – when selected, the created sales receipt is placed on hold. This gives you the opportunity to adjust it if, for instance, your payment provider deducts a service charge.
7. From the Process type list, click the process type to be assigned to the orders' lines.
8. Click Populate header department to set the order's header department. EvolutionX orders do not have headers.
   When selected (default), if all line-level departments match, the department at the header level is set. When they don't match, the department on the first line with a department is used for the header department.
   When cleared, orders are imported with a blank header department. This is usually preferable as each order line can have its own department and setting the header department can be misleading.
   
9. The following options affect orders imported via an API:
   • Allow orders to create traders – if the trader and/or delivery trader doesn’t exist, one will be created, with the following New traders settings:
     • Group – trader user-defined group
     • Rep
     • Supplier –
     • Delivery method –

     Note: If a sales lead (type L trader) has been created in Horizon and Allow orders to create traders is selected, an order for that sales lead will be rejected. To allow orders to import, change the trader to a customer (type S trader).

   • Also search on trader name – search for delivery traders by name as well as line 1 of the trader address and postcodes.
   • Update addresses – will update the trader and delivery trader details with the trader's code, name, address lines, town, county and postcode from the file.
10. Click OK.

Setting Up Sales Order Import from an API

If you have purchased the Horizon API you can import orders with a defined source. The v2 Orders POST method can pass the value "source" as a string. Create a source, then create import settings for that source, and incoming orders through the Horizon API that match the source name will use those order import configuration settings.

Including Notes on Order Confirmations

When importing orders from the Horizon API v2, order header and line notes can be included when POSTing using the order method. In Horizon, the Print tickbox is selected if you want notes to be included on the form that's printed or emailed as an order confirmation (for example). Within the Order method, the Print tickbox is selected when an order is imported for those lines when:

• printNotes is true and there is a header or line note included;
• printNotes is not passed and there is a header or line note included.

If there is no header or line note, or printNotes is false, then Print is cleared.

 

See Also