StarshipIT integration overview

StarshipIT system

Obtain an account with StarshipIT
1. Configure the couriers you will work with and any rates you have agreed

Setup Couriers as Suppliers

Is Courier Flag

Setup the StarshipIT api reference - this is passed when using the API to book the correct courier

The API reference is the code used by StarshipIT to find the courier - refer to your account to check the courier codes

setup starshipit link with API reference.png

Setup the integration Credentials using the API key and password from your StarshipIT account

Setup Delivery Zones

Delivery zones can be used to limit the list of options returned for any postcode so a preferred list of couriers is used

Example limited to a list of postcodes in a city

Example limited to any postcodes in the listed range

If no postcodes are entered at all and ANY is set as the type then ANY postcode can be serviced.

Default Couriers on Debtor

Debtors may have a default delivery courier setup

Any default courier code should be the same as setup on the courier as the API reference on that courier

Default couriers based on recent orders

A customer may have the same courier over the last 4 or 5 orders.

That courier will continue to be the default for that customer when an order is entered.

Carton size

The person entering the order enters the size of the cartons that will be used (required by StarShipIT)

Setup Cartons to add to the list of choices

Preferred couriers when entering sales orders

The business may prefer cheaper, faster, more reliable couriers - so the system offers those by default using delivery zones as a filter

Couriers returned from StarShipIT will be filtered to show only those that have delivery zones setup in the system. Cheapest will default - user can select from other alternatives

This is how to default cheap couriers - setup a delivery zone for them that includes the related postcodes

Non-Default couriers

Entering a courier code (eg TNT below) will filter the StarshipIT results to that courier

StarshipIT list of possible couriers.png

Select a chosen option and that will update the estimated freight cost on the order

Any courier in your StarshipIT account CAN be used by entering the API code on the order

Must be setup as a courier in our system as above

Orders from external systems

Where an order has been accepted by an external system and a preferred courier is already on the order then booking the label after picking will use that courier code.