Skip to main content

Integrations Guide

This guide covers how to set up and manage integrations in Dispatch, connecting your e-commerce platforms and other business systems.

Overview​

Dispatch integrations allow you to:

  • Automatically import orders from e-commerce platforms
  • Sync product catalogs between systems
  • Push tracking updates to external platforms
  • Automate workflows based on events

Integration Types​

E-commerce Platforms​

Connect your online stores to automatically receive orders:

  • Orders flow directly into Dispatch
  • Customer information syncs automatically
  • Inventory and product data can be synchronized
  • Tracking numbers push back to the platform

Carrier Integrations​

Connect with shipping carriers for:

  • Real-time rate shopping
  • Label generation
  • Tracking updates
  • Delivery confirmation

Notification Services​

Enable customer communications:

  • Push notifications
  • Email updates
  • SMS alerts (where available)

Setting Up E-commerce Integration​

Step 1: Navigate to Integrations​

  1. Go to Settings > Integrations
  2. View available integration providers
  3. Select the platform you want to connect

Step 2: Configure the Connection​

Each platform requires specific credentials:

Common Configuration Fields​

  • API Key/Secret - Authentication credentials from your platform
  • Store URL - Your store's web address
  • Store ID - Identifier for multi-store setups

Step 3: Configure Sync Settings​

Define how data flows between systems:

Order Sync​

  • Which order statuses to import
  • How often to check for new orders
  • Whether to mark orders as processed

Product Sync​

  • Enable/disable product synchronization
  • Map product fields between systems
  • Handle product variations

Step 4: Test the Connection​

Before going live:

  1. Click "Test Connection"
  2. Verify credentials are valid
  3. Check that data flows correctly
  4. Create a test order to confirm

Step 5: Enable the Integration​

Once tested:

  1. Toggle the integration to "Active"
  2. Orders will begin syncing
  3. Monitor the integration dashboard for status

Managing Integrations​

Integration Dashboard​

View all configured integrations:

  • Connection status (active, paused, error)
  • Last sync time
  • Recent activity and errors

Pausing an Integration​

To temporarily stop syncing:

  1. Find the integration
  2. Click "Pause"
  3. Orders will not sync until resumed

Use this for:

  • Maintenance windows
  • Testing changes
  • Investigating issues

Disabling/Removing​

To permanently remove an integration:

  1. Click "Disable" or "Remove"
  2. Confirm the action
  3. Historical data remains, but syncing stops

Integration Provider Configuration​

Credentials Management​

Store your platform credentials securely:

  • Credentials are encrypted at rest
  • Update credentials when they change
  • Test after updating to verify

Webhook Configuration​

Some integrations use webhooks for real-time updates:

  1. Copy the webhook URL from Dispatch
  2. Configure in your platform's settings
  3. Dispatch receives events immediately

Sync Frequency​

Configure how often data syncs:

  • Real-time - Instant via webhooks
  • Frequent - Every few minutes
  • Periodic - Hourly or less frequent

Workflow Automation​

What Are Workflows?​

Workflows automate actions based on events:

  • When an order is created, notify the warehouse
  • When a shipment is delivered, update the e-commerce platform
  • When a customer is created, send a welcome message

Creating Workflows​

  1. Navigate to Settings > Workflows
  2. Select the entity type (Order, Shipment, Customer)
  3. Choose a trigger event
  4. Configure the action to take
  5. Enable the workflow

Workflow Triggers​

Common trigger events:

  • Order Created - New order received
  • Order Status Changed - Order moves to new status
  • Shipment Created - Shipment generated from order
  • Shipment Delivered - Delivery completed
  • Shipment Exception - Issue with delivery

Workflow Actions​

Actions you can automate:

  • Send notifications
  • Update external systems
  • Trigger carrier actions
  • Create follow-up tasks

Managing Workflows​

  • View all configured workflows
  • Enable/disable individual workflows
  • Monitor workflow execution history
  • Debug failed workflow runs

Push Notifications​

Browser Notifications​

Enable real-time alerts in the browser:

  1. Allow notifications when prompted
  2. Configure which events trigger notifications
  3. Receive alerts even when not on the Dispatch tab

VAPID Subscription​

For mobile and progressive web app notifications:

  1. Subscribe to push notifications
  2. System generates a subscription
  3. Notifications delivered to your device

Troubleshooting Integrations​

Common Issues​

Connection Failed​

  • Verify API credentials are correct
  • Check that the platform is accessible
  • Ensure your account has API access enabled
  • Review any IP restrictions

Orders Not Syncing​

  • Check integration status is "Active"
  • Verify order status filters
  • Review sync logs for errors
  • Test with a new order

Duplicate Orders​

  • Check if orders are being processed twice
  • Verify import filters are correct
  • Review sync timing settings

Missing Product Data​

  • Enable product sync if needed
  • Verify product mapping configuration
  • Check that products exist in both systems

Viewing Sync Logs​

Monitor integration activity:

  1. Go to the integration details
  2. View the sync log
  3. Check for errors or warnings
  4. Use timestamps to identify issues

Error Resolution​

When errors occur:

  1. Read the error message carefully
  2. Check if credentials are valid
  3. Verify the remote system is operational
  4. Contact support if issues persist

Best Practices​

Before Going Live​

  1. Test thoroughly - Use test orders before production
  2. Monitor closely - Watch the first few syncs carefully
  3. Have a backup - Know how to process orders manually
  4. Document setup - Record your configuration

Ongoing Management​

  1. Regular monitoring - Check integration status daily
  2. Credential rotation - Update API keys periodically
  3. Review logs - Look for patterns in errors
  4. Stay updated - Apply platform updates as needed

Security​

  1. Secure credentials - Don't share API keys
  2. Limit access - Only authorized users manage integrations
  3. Monitor activity - Watch for unusual patterns
  4. Quick response - Disable compromised integrations immediately