| Table of Contents | ||
|---|---|---|
|
StarshipIT integration overviewStarshipIT integration overview
StarshipIT is an aggregator allowing you to setup multiple possible couriers and rates that our system can call with an address and package sizes to:
Order Capture
Find possible couriers
Calculate expected freight costs
End of picking process - confirm done to:
Book courier
Update tracking details onto the order
Attach PDF of label to the order for future reference
Print label
StarshipIT system
Obtain an account with StarshipIT
Configure the couriers you will work with and any rates you have agreed
Setup
...
Couriers as Suppliers
Any changes to courier details like this needs the supplier cache updated - Supplier > Maintenance > clear supplier cache
Is Courier Flag
...
and 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 codesFinding the courier in StarshipIT uses the Supplier Name when entering orders - this must be the same as in your StarshipIT account
Filtering the list of service results uses the API reference as each courier will typically return multiple possible services
...
Setup the integration Credentials using the API key and password from your StarshipIT account
...
Delivery zones can be used to limit the list of options returned for any postcode This is so a preferred list of couriers is used
Example limited to a list of postcodes in a city
...
Limited Example limited to any postcodes in the listed range
...
if If no postcodes are entered at all and ANY is set as the type then any ANY postcode can be serviced.
...
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
...
That courier will continue to be the default for that customer when an order is entered.
...
The business may prefer cheaper, faster, more reliable couriers - so the system offers those by default using delivery zones as a filter.
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
...
Non-Default couriers
Entering a courier code NAME (eg TNT below) will filter the StarshipIT results to that courier
Delivery Method must be the Supplier Company Name in order to filter the results to any results that have the API code from the supplier as the carrier
...
Select a chosen option and that will update the estimated freight cost on the order
...
Must be setup as a courier in our system as above
Orders from external systems that already have a Courier Code
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.
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
StarShipIT for Foneking Marketplace Orders
Host Company Configure API
Host Company Configure API
...
Creditor StarShipIT
Parcel Broker StarShipIT
Daemon Configuration
RunCourierBookingDaemon set to 1 to be active