Connecting to GoSweetSpot allows Consignly users to automatically export consignments to GoSweetSpot.
To establish a connection, add the app into Consignly.
Consignly requires a GoSweetSpot API key in order to connect. To find your API, login to GoSweetSpot, navigate to Preferences & Settings in the Administration menu. Open the Advanced Settings panel, scroll to the bottom and look for the API Key heading. Follow the instructions to generate an API Key.
After you have connected with GoSweetSpot, you will be able to configure your GoSweetSpot connection.
Enter your GoSweetSpot API key to connect Consignly to GoSweetSpot
Configuring GoSweetSpot
For a consignment to export to GoSweetSpot, it needs to meet 2 qualifying criteria:
- The Carrier Partner on the consignment needs to be added in the Carriers configuration and the supported consignment types selected; and
- The Client Partner on the consignment needs to be added in the Clients configuration, and the supported consignment types selected.
The information below explains how to add and configure each of the Consignly parties for export.
Export Triggers
The Export Triggers card allows you to define which statuses cause an export of consignment data from Consignly to GoSweetSpot.
Checking a box in this card will mean that qualifying consignments will export to GoSweetSpot when the consignment moves into this status. If you have checked Enable updates on a selected consignment status, then when a consignment is updated whilst in the selected status it will trigger an update message to be sent to GoSweetSpot.
In this example, Consignly will trigger a GoSweetSpot export when a consignment moves into a Ready to Dispatch status (providing the consignment qualifies to be exported)
Carrier Mapping
The Carrier Mapping card defines which carriers will form part of the qualifying test for a consignment.
To add a Carrier Partner qualifying record, choose the Add Carrier button at the bottom of this card. A new line will be created where you may choose the Consignly Carrier Partner that will qualify a consignment to exported to GoSweetSpot.
After selecting the Carrier Partner, you must also select which Consignment Types are supported for this Carrier Partner. Choices are Inwards and/or Outwards.
Choosing one of these values will only qualify a consignment if it matches this Carrier and the Consignment Type is in the selected options for that Carrier.
You may remove a qualifying Carrier by choosing the Remove icon at the end of the record.
An example of a Carrier that has been added in the GoSweetSpot configuration, supporting both Inwards and Outwards consignments
Client Mapping
The Client Mapping card defines which Clients will form part of the qualifying test for a consignment.
To add a Client Partner qualifying record, choose the Add Client button at the bottom of this card. A new line will be created where you may choose the Consignly Client Partner that will qualify a consignment to exported to GoSweetSpot.
After selecting the Client Partner, you must also select which Consignment Types are supported for this Client Partner. Choices are Inwards and/or Outwards.
Choosing one of these values will only qualify a consignment if it matches this Client and the Consignment Type is in the selected options for that Client.
You may remove a qualifying Client by choosing the Remove icon at the end of the record.
An example of some Clients that have been added in the GoSweetSpot configuration, supporting Outwards consignments only