Connect Integration Support

In this article, you will learn about the available integrations for Dispatch Connect and will be provided with links to technical development documentation.

Auto-Fill Integration

The Connect Auto-Fill integration is offered to streamline the process of getting data from an existing ERP system into Dispatch Connect using URL ParametersWith minimal development resources, you can use this simple integration to reduce delivery creation time in Dispatch Connect by 50% or more.

What are some of the key benefits to implementing the Auto-Fill Integration?

There are many benefits to implementing the Auto-Fill Integration, with the most important being time savings due to the decrease in manual data entry.  Having the ability to click one button to automatically fill in the Connect New Delivery form will save your users time and ensure data integrity as the delivery information is swiftly passed from one system to another.

 

What is a URL Parameter?

A URL Parameter is part of the URL for a web page that defines a variable the page uses upon page load. In this integration, we’ve created variables for all of the form fields on the New Delivery page within Connect so that an external system can efficiently fill in the form.

How does the Auto-Fill Integration work?

The Auto-Fill integration must be implemented by a software developer with access to the source code or a developer configuration console of a third-party application such as an ERP or point of sale system. Auto-fill integration allows developers to configure a button or hotkey within the application that will open the Connect New Delivery form pre-populated with relevant delivery information. The information is passed to the Connect New Delivery form using URL parameters. 

 

The user will then be able to review the New Delivery to confirm the accuracy of the information passed to Dispatch Connect.  Once reviewed, the user can simply save the delivery within Connect.

Do I need a software engineer to implement and use this auto-fill integration?

It is recommended that you work with an in-house software engineering resource to implement this integration. Your engineering resource can utilize the Connect Auto-Full Integration via URL Parameter Documentation found here, or accessible in the Dispatch WebApp by navigating to Settings > Developer Settings and then selecting API Documentation.

What are my next steps?

All customers have access to the Connect Auto-Fill integration. More information is available from the Settings Menu -> Developer Settings -> API Documentation link.  If you have additional questions about how to get started, please reach out to your assigned Dispatch team member or contact connectsupport@dispatchit.com for help.

Connect API

The Connect API streamlines the process of getting data from your existing business applications into Dispatch Connect via RESTful APIsWith development resources, you can use this integration to automate delivery creation in Dispatch Connect.

What are the key benefits of a Connect API integration?

The Connect API key benefits include

  • Eliminate the need for manual data entry and verification within the Connect application. All data flows seamlessly from your existing tools
  • Increase data accuracy and reduce data entry errors
  • Keep data in sync between existing tools and Dispatch Connect
  • Query for updated status and delivery information as a delivery progresses.

In the future, our APIs will also include webhooks to provide real-time updates, as well as editing, canceling and bulk query functionality. Are there other features you’re looking for? Let us know by contacting connectsupport@dispatchit.com.

What can the Connect API do?

The Connect API is available to customers who are interested in building a custom integration between Dispatch Connect and any third-party tool.  The current version of the API functionality includes:

  • CREATE deliveries in Dispatch Connect programmatically
  • GET information about a specific delivery by ID

Coming soon:

  • Multi level account management support
    • GET a list of all child locations (branches) beneath a parent organization
    • CREATE a Dispatch Connect delivery for a child branch using only the parent organization API key and the branch location ID
    • GET all Connect deliveries for a specific branch by location ID.
  • Webhooks to automatically update of delivery status changes
  • Edit a delivery
  • Cancel a delivery

Do I need a software engineer to use the Connect API?

It is recommended that you work with software engineering resources to implement this integration. Your engineering resources can utilize the Connect API documentation found here, or accessible in the Dispatch WebApp by navigating to Settings > Developer Settings and then selecting API Documentation. Our developer documentation includes instructions on how to access our robust sandbox environment that can be used for all testing required for the API implementation.

What technologies does the Connect API leverage?

The Connect APIs, like our Marketplace APIs, are RESTful APIs that return information as JSON. Authentication uses standard OAuth protocols with a base64-encoded API Key and API secret, which can be generated on a per-user basis from Settings -> Developer Settings. 

What are my next steps?

All customers have access to the Connect APIs. Complete documentation is available within the product from the Settings Menu -> Developer Settings -> API Documentation.  If you have additional questions, please reach out to your assigned Dispatch team member or contact connectsupport@dispatchit.com to get started.