Setting up your ShipEngine Courier

Setting up your ShipEngine Courier

It is possible for you to setup your ShipEngine courier.  Please read the instructions and notes before you begin.

Notes/caveats:
The Carrier ID and the Service Code can be left blank in the configuration settings. However, depending on the following scenarios, different outcomes will occur:
  1. Both Carrier ID and Service Code are left blank:
    1. The cheapest rate will be returned from all the Carriers / Service codes received in the rate response.
  2. Only Carrier ID is left blank:
    1. This will return an error when assigning a shipment to the ShipEngine courier informing the user that a Service code cannot be specified without a Carrier ID.
  3. Only the Service Code is left blank:
    1. The user is given the ability to select a service at the time of the shipment request, based on a real-time list of available services from ShipEngine, for the specified carrier. Only Service Codes relevant to the Carrier ID will be returned.
  4. A Service Code and a Carrier ID are supplied:
    1. This specific Service will be used if it belongs to the same Carrier ID that is set in the Carrier ID field.
  5. Note: The Carrier ID is specific to the service code; if a Carrier ID requested does not exist for the selected Service code, order assignment will fail.

Step One - Create the Courier

  1. Open System Setup.
  2. Click on System Data.
  3. Double click on Couriers.
  4. In the courier screen, click on the Edit button.
  5. Click on the +New button to add a new courier.
  6. Enter the courier Code.
  7. In the export type select ShipEngine.
  8. Click Save screen.

Step Two - Configure the Courier

  1. Click on the ShipEngine courier.
  2. Click on the Actions button.
  3. Select Courier Config, see the table below for the options:

Option
Description
Example
API Key
The API Key for the ship engine account. This will be provided by ShipEngine/ShipEngine.
TEST_jshduyt87r5eh4j5g7364
Carrier ID
The carrier id to be used. This field can be left blank, please see notes/caveats for more on this. 

Service Code

In order to utilise the dynamic shipping rates functionality with ShipEngine, this field should be left blank. This will result in Khaos Control Cloud giving the user the option to select a service at the time of shipment request, based on a real-time list of available services from ShipEngine, for the specified carrier.

 If you specifically want to use the same service, all the time, this can be populated with the relevant service code, to prevent the dynamic shipping rates.


Weight Unit
The weight unit that shipments will be exported as.
kilogram
Dimension Unit
The dimension unit that shipments will be exported as.
centimetre
Shipper Contact


Shipper Company


Shipper Line 1
Your company address line 1
1-3 Priest Court
Shipper Line 2
Your company address line 2
Caunt Road
Shipper Line 3
Your company address line 3

Shipper Town
Your company address Town
Grantham
Shipper Country
Your company address Country
United Kingdom
Shipper Postcode
our company address postcode
NG31 7FZ
Shipper Country Code
Your company address line Country code, expects a 2-letter country code i.e. GB
GB
Shipper Tel
Your company address phone number
0123456789
Label Path
The path where labels will be stored
C:\KeystoneSoftware\CourierLabels\
Non-Delivery Behaviour
Behaviour if the package is unable to be delivered, options are:
- Treat as Abandoned
- Return to Sender
Return to Sender
Weight Scale
The weight against your shipment will be multiplied by this scaling factor when being sent to Ship Engine.
0.001
Nominal Weight
If set, when a shipment has no weight against it, then this nominal value will be used instead.
Note: can only be used with shipments where items have been packed into boxes.
1
Dimension Scale
The dimensions against your shipment will be multiplied by this scaling factor when being sent to Ship Engine.
100
Requires Consignment Ref
When ticked, sales invoices cannot be moved past the shipping stage unless a consignment ref has been associated with the shipment100 1
Ticked
Printer Name
The printer name to use for courier labels.
Microsoft Print to PDF

Usage

To use ShipEngine once it has been setup:

  1. With the order in the Released or Staging.
  2. Open Despatch and then Quick Despatch.
  3. Green select the order you wish to ship.
  4. Click on the Actions button and then select Pick/Pack Verification.
  5. Pick and pack the items.
  6. Set the courier to your ShipEngine courier.
  7. Set the weight and number of boxes.
  8. Press Shipping Rate to get the latest shipping rates.
  9. On a successful rate request it will return a list of services.
  10. Choose the service from the list.
  11. Press PROCESS to process the order.