The procedures in this article are only applicable if you are using DEAR for packing and shipping. In case you are using Starshipit for packing and shipping, you will need to develop and integrate with Starshipit using a DEAR API key and follow a different workflow, including mapping your carrier values to the connected couriers in Starshipit. For more information, see Starshipit - DEAR Integration. You can only integrate between DEAR and Starshipit one direction at a time.
NOTE: Starshipit can only be used for shipping addresses within Australia and New Zealand.
NOTE: The Ship From location selected is taken from the Pickup Address specified in Starshipit, not the Ship From location specified in DEAR.
- Familiarity with Processing a Sale is required.
- Familiarity with Products and Product Management is required.
Starshipit account settings currency MUST match with DEAR base currency, set via Settings → General Settings.
Starshipit account settings units MUST match with DEAR default units, set via Settings → General Settings.
- Configure what courier services you would like to display in Settings → Checkout Rates within Starshipit. If the courier rate options are not enabled within this section, then the customer will not see courier rates within DEAR. See Rates at checkout setup for more information.
Table of Contents
- Starshipit Integration Setup
- Getting Shipping Rates
- Label Printing
Starshipit Integration Setup
First, you must connect DEAR to Starshipit.
To connect Starshipit to DEAR:
- Navigate to Integration → Starshipit.
- Enter your API Key and click Connect Starshipit. You should have previously generated your API key from your Starshipit account, specifically under Settings → API.
Connecting Starshipit will take you to the integration settings page. Some Starshipit Integration settings can be customised. If you make any changes to the default settings, make sure to click Save Changes upon completing them. If more than one shipping service is connected, you can click Set Default to set Starshipit as your default service.
Use Tax Rate From: This setting determines which tax rule will be applied to the shipping charge. Option 1 is to use the Default Tax Rule for all customers and select from the list of available tax rules under the Tax Rule for Shipping setting (see below). Option 2 is to use the Customer Tax Rule, which is determined at the customer level during setup.
Tax Rule for Shipping: If the Default Tax Rule is selected in the Use Tax Rate From setting, choose the default rule to be applied here. If the Customer tax rule is selected in the Use Tax Rate From setting, this setting will not be displayed at all.
Currency in Starshipit: This sets the currency to be used in Starshipit. This MUST match the currency value set under Settings → General Settings in DEAR.
Weight Units in Starshipit: This sets the Weight Units to be used in Starshipit. This MUST match the weight unit values set under Settings → General Settings in DEAR.
Additional Shipping Margin: This optional setting allows an additional margin to the shipping cost passed on from Starshipit to your customers.
Margin Value is Absolute/Relative: Set to an Absolute value by default, even if Additional Shipping Margin (see above) is NOT set. E.g. if Additional Shipping Margin=20, this will be 20 units of your DEAR base currency. Relative sets the margin value as a percentage, or 20% in this case.
Predefined Package Types: This section is where you set up predefined package types that will be used in DEAR Warehouse Management System (WMS) and shipping labels. To add a package type, click the +Package Type button, then enter the dimensions of the package type. Repeat the procedure for the rest of the package types you want defined.
Send a Notification on Shipping Label Generation: Enable to trigger an internal notification on the generation of a shipping label.
Set Default: Clicking this button sets Starshipit as your default shipping service. Label printing will be done through Starshipit. This option will only be displayed if you have multiple shipping services, for example, Shippit and ShipStation, and you have not set Starshipit as your default shipping service yet.
Disconnect from your Starshipit: Click this button to disconnect and stop using Starshipit.
The Starshipit API does not allow DEAR to import Carrier values from Starshipit. The value in the Carrier field of a DEAR order is passed to Starshipit. If you have more than one Carrier set up in Starshipit, you will need to set rules to correctly map Carrier values from DEAR to your Carriers in Starshipit. The Carrier field in DEAR is labelled Shipping Method in Starshipit and it can be seen at the top-right of the screen when selecting an order.
Set Carrier Rules in Starshipit:
- In your Starshipit account, go to Settings → Rules.
- Select Add a new rule.
- Select Shipping Method in the Conditions drop-down field and enter the DEAR carrier values. You can select more than one condition per rule.
- Select the Starshipit Carrier and Product Code.
- Save your rule.
If Shipping Method rules are not set in Starshipit, or a carrier value is passed to Starshipit that does not fit the rule conditions, shipping labels will be generated using the default Starshipit carrier.
Getting Shipping Rates
Starshipit allows you to estimate how much shipping charges will be based on the 'from shipping' location to customers 'shipping address'. This information can be used to set predetermined Shipping Rates in DEAR. Starshipit can only be used for addresses in Australia and New Zealand.
There are some steps to set up before you can start using Starshipit to calculate rates. These can be skipped if you have done them already.
It is essential to Configure what courier services you would like to display in Settings → Checkout Rates within Starshipit. If the courier rate options are not enabled within this section, then the customer will not see courier rates within DEAR. See Rates at checkout setup for more information.
Setting Up Addresses in DEAR
To correctly calculate shipping rates, you must first define where you are shipping from. Add addresses to all of your locations to make sure your shipping rates are accurate.
To set up addresses in DEAR:
- Go to Settings → Reference Books → Stock → Locations & Bins.
- You can add more locations with + or Add more items.
- Enter a name and address for each location.
- Save your changes.
Setting Up Product Dimensions
To correctly estimate shipping rates in Starshipit, the correct dimensions must be added to the product in DEAR. See Product and Service Management for more information about setting up products.
To set up dimensions in DEAR:
- Go to Inventory → View All → Products.
- Select the product in question and at the bottom of the page, select the Dimensions tab.
- Enter the dimensions and Save the product.
Once the setup steps are complete, you can begin to estimate shipping rates on sales orders.
Using Shipping Rate Estimates in DEAR
If DEAR receives an error during shipping rate estimate generation, an error message will appear with a downloadable .txt file with the error data. If the error is unexpected, the user will also see an email dialog box with attached error data log file which can be sent to the shipping service provider customer support.
To get shipping rate estimates in DEAR:
- Create a sales order using Simple Sale or Advanced Sale.
- Add products to the order. Shipping Rates can be estimated at the Quote or Order stage.
- Click Get Shipping Rates.
- Select Starshipit from the drop-down menu.
- A dialogue box will appear where you will need to select the CARRIER and SERVICE types and then click OK. The carriers and services are loaded from your connected carriers on your Starshipit account.
Using Shipping Rate Estimates in B2B Portal
To get shipping rate estimates in B2B Portal:
- Go to Integrations → DEAR B2B Portal.
- Under the Setup tab, scroll down to Shipping Service and select Starshipit from the list. Click Save.
- During Checkout, the shipping methods from Starshipit will be automatically shown for selection under Step 3: Shipping Method.
DEAR allows printing of Shipping Labels through the Starshipit integration (also supported by Shippit, ShipStation and Shiptheory). If more than one shipping service is connected, you must go to the Starshipit integration page and select Set Default to print labels through Starshipit.
If DEAR receives an error during shipping label generation, an error message will appear with a downloadable .txt file with the error data. If the error is unexpected, the user will also see an email dialog box with attached error data log file which can be sent to the shipping service provider customer support.
To print shipping labels:
- Use the normal sales process to create a sales order in either Simple Sale or Advanced Sale.
- On the document header, enter the shipping address.
NOTE: Make sure the shipping address field is correct as it will be used by external integration for address verification.
Under the Ship tab, click Shipping Label. Shipping Labels can also be generated from the DEAR Warehouse Management Solution (WMS) app.
- Enter all the required fields (marked with *) and click Generate Label. If you have defined package types, you can select one under the Package Details section prior to generating the label.
NOTE: You must select the Shipping Method that you have previously connected to Starshipit. The Carrier value from the document header will automatically be entered into this field.
- The carrier info, including the tracking number, will then be automatically entered into the Ship tab.
- The Shipping Label will be generated automatically via PDF. You can also print the label by clicking on Shipping Label, and selecting the shipment from the list.
NOTE: The most common source of errors when generating labels is invalid shipping addresses. Ensure the locality, postcode and street name are correct.
NOTE: The template used to print the shipping label is generated on Starshipit side. DEAR just downloads the PDF from their API, it is not possible to change the shipping label template through DEAR.