This article describes how customers can submit job bookings to the GoDesta system in an automated fashion. Normally these bookings may be automatically generated from the customer’s freight management software, accounts software or shopping cart.
There are three main options:
- sending a file via email or FTP;
- using an integration partner (eg Machship) as an intermediary; or
- directly integrating with the GoDesta platform via our API.
Each of these approaches should be considered, depending upon the customer’s needs and likely scale.
| Method | Booking Submission | Status Updates | POD Documents | Development Required |
|---|---|---|---|---|
| Customer Portal | ✓ Manual | ✓ | ✓ | None |
| Integration Partner | ✓ | Depends on partner | Depends on partner | Low |
| File Transfer | ✓ | Optional | Optional | Low-Medium |
| API Integration | ✓ | ✓ | ✓ | Medium-High |
Using the client portal
The simplest approach for job bookings which are initiated manually or for low volume bookings is for the customer to be provided with access to the GoDesta customer portal.
This permits the customer’s representatives to login, book a job, check the status of work and review invoices.
Integrating through an intermediary
A number of established freight management integrators and freight management software systems have existing integrations with the GoDesta system.
These include:
- Machship (a freight system integrator)
- Consignmate (a freight software solution provider)
If the customer has the ability to connect their system to one of these services, the integration can be readily enabled. This is the fastest and one of the most cost-effective approaches, particularly where the volume and value of a customer’s freight bookings is not yet known.
In order to achieve an integration with one of these services:
1. An admin user from the transport operator can enable permission for the integration partner to transact on the customer’s account using the ‘Electronic Data Interchange’ option from within the customer’s account profile
2. The transport operator should provide the customer with:
(i) their account number; and
(ii) the transport operator’s ‘company’ and ‘division’ codes.
3. The customer should then pass this information along to the integration partner.
Because these integrations are already in place, GoDesta does not need to furnish any passwords or credentials to the integration partner.
If the customer uses an alternative solution provider, GoDesta is happy to discuss an integration with that provider. See ‘API integration’ below for further details on how to initiate an integration with a new intermediary.
File Transfer
This is probably the most flexible approach from a customer’s perspective to extend an existing system and may be suitable for customers whose system can output job bookings in an exportable format, such as XML, JSON, CSV etc.
Whilst this is simple and flexible for the customer, receiving this file requires GoDesta to develop and incorporate into the system a process to interpret the data format chosen by the customer.
The file can then be transmitted via FTP or a related file transfer protocol. There is also the option for GoDesta operations users to manually upload a file via the ‘Point Manager’ tool, which enables a transport operator to receive such files via email and potentially review the file before uploading it to the system.
To integrate in this fashion, please obtain sample(s) of the customer’s proposed data export format and provide them, along with the customer’s account details as part of the Feature Request Form to the GoDesta team so that GoDesta can assess the likely scope of work required to receive and process such data.
Data Exchange Capabilities
Depending on the integration method selected, GoDesta can exchange a range of operational, tracking and pricing information with customer systems.
Data GoDesta Can Receive
GoDesta can receive information from customer systems, including:
- Job Estimate Requests
- Job Booking Requests, including:
- Pickup and delivery details
- Consignment and reference information
- Special instructions and service requirements
- Additional equipment requirements
Data GoDesta Can Send
GoDesta can provide information back to customer systems, including:
- Estimated pricing based on job details
- Booking confirmations
- Job reference and consignment numbers
- Job status updates
- Pickup and delivery completion events
- Proof of Delivery photos and signatures
- Job pricing information
Typical Integration Flow
A common integration workflow is:
- Customer requests an estimate (optional)
- GoDesta returns pricing information (optional)
- Customer system submits a booking to GoDesta.
- GoDesta validates and creates the job.
- GoDesta returns a booking confirmation.
- GoDesta sends job status updates as work progresses.
- GoDesta sends Proof of Delivery documentation once the job has been reviewed and completed.
Custom API integration
An API integration involves the customer’s software developers integrating with the GoDesta system using its existing, industry standard, API. This is sometimes referred to as an “OpenAPI”.
In technical terms this involves the customer’s system making a series of REST based HTTP requests to exchange data with the GoDesta system.
Standard API Integration:
GoDesta has a standard integration available for Transport Operator's customers to easily integrate according to our detailed specifications. If one of your customers would like to integrate with GoDesta, please complete the Feature Request Form and our integration team can help your customer to get set up.
Custom API Integration:
Whilst the ability for customers to connect this way already exists on the GoDesta side, some customers may require the ability to receive system updates back into their system, which may require custom development work and configuration to be performed by GoDesta.
Depending on the integration design, GoDesta can provide real-time or near real-time booking acknowledgements, job progress updates and Proof of Delivery information back to the customer's system.
Because of the relative complexity of this approach, to achieve such an integration the following steps are recommended:
Step1
The Transport Operator should notify GoDesta that one of their customers would like to develop a custom integration in line with the above requirements using the Feature Request Form. The form should include identifying who wishes to integrate.
Step 2
GoDesta's integration team will then be able to attend a discovery meeting with the transport operators customer to understand any special requirements and provide a quote for any customisations.
Step 3
GoDesta developers will work with your customer's software / service provider to achieve the integration.