Integration Methods


Overview

When integrating with MachShip, you have several options available to connect your systems with our platform. Each method is designed to accommodate different technical capabilities, business needs, and operational requirements.

Let's explore each option in detail to help you understand which approach best suits your needs.

MachShip API

Our API is the most powerful and flexible way to integrate with MachShip. It's a fully featured, RESTful API layer that communicates via HTTPS using well-defined JSON objects. When you integrate via our API, you get direct programmatic access to all MachShip functionality, allowing you to build a completely customized solution.

The API is particularly valuable when you need real-time processing or have complex business logic to implement. For example, if you need to create consignments instantly when orders are placed, or if you want to automatically select carriers based on sophisticated business rules, the API gives you the control to build exactly what you need.

Key Features

  • Full platform functionality
  • Real-time consignment creation
  • Custom business logic
  • Advanced error handling
  • Dangerous goods support
  • In-built test mode for sandbox

Best Suited For

  • Custom software platforms
  • Real-time consignment creation and pricing
  • Complex business logic
  • Dangerous goods handling

Technical Requirements

  • Development resources with API experience
  • Understanding of RESTful APIs and JSON

Read our guide on API integration here.

Flat File Import

The flat file integration method provides a simpler approach to integration, perfect for businesses that can easily export shipping data but don't have a platform that supports API integration.

This method offers two ways to get your data into MachShip:

  1. Automated folder monitoring through our Printer Application
  2. Manual upload through the MachShip interface.

The automated approach works by monitoring specified folders on your computer. When you export files to these folders, our printer app automatically processes them and creates consignments in MachShip. This creates a seamless, automated workflow without the complexity of API integration.

For more occasional needs, you can manually upload files directly through MachShip's web interface. This gives you a simple way to process shipping data when you need it, without requiring any special setup.

Key Features

  • Simple implementation process
  • Automated file processing via folder monitoring
  • Manual upload option through MachShip UI
  • Basic data mapping capabilities
  • No additional fees for self-setup

Workflow Options

You can use flat file integration with either pending or unmanifested consignments:

  • Create pending consignments when you want users to add package details or select carriers
  • Create unmanifested consignments when you have all shipping details and want automatic processing

Limitations to Consider

  • No dangerous goods support
  • Limited error handling capabilities
  • Basic field mapping only
  • Less flexible than API integration

If you need dangerous goods support or advanced data mapping with flat files, consider our custom integration service - we can build a solution that handles these requirements while maintaining the simplicity of file-based integration.

Read our guide on flat file integration here.

Supported Integrations

For businesses using common platforms like popular eCommerce systems or ERPs, we offer pre-built integrations that provide a quick path to implementation. These integrations are fully maintained by MachShip and designed to work with standard workflows, taking the complexity out of connecting your systems.

Our supported integrations handle all the technical details of connecting with MachShip, including:

  • Automatic consignment creation when orders are placed
  • Real-time status updates back to your platform
  • Carrier selection based on your rules

Key Features

  • Quick setup process
  • Standard workflows built-in
  • Platform-specific optimizations
  • Regular updates and maintenance
  • Full support from our team

Supported integrations include both setup and monthly support fees to cover the ongoing maintenance and updates. This investment is typically offset by the reduced implementation effort and the peace of mind that comes with a fully supported solution.

Platform Coverage

We support major platforms across various industries:

  • eCommerce platforms
  • ERP systems
  • Warehouse management systems
  • Order management platforms

View our list of supported platforms here.

Custom Integration

Sometimes standard solutions don't quite fit your needs. That's where our custom integration service comes in. We combine the flexibility of our API with our development expertise to build a solution that exactly matches your requirements.

Custom integrations are particularly valuable when you have:

  • Complex business rules that need to be implemented
  • Specific data transformation requirements
  • Multiple systems that need to be connected
  • Unique workflow requirements
  • Enterprise-level needs

What We Deliver

  • Tailored solution built to your specifications
  • Complex workflow support
  • Enterprise features as needed
  • Regular maintenance and updates
  • Full ongoing support

While custom integrations involve higher setup costs and monthly support fees, they provide the most comprehensive solution for businesses with specific needs that aren't met by our other integration methods.

Method Comparison

To help you evaluate which method best suits your needs, here's how each option compares across key factors:

Factor API Flat File Supported Custom
Implementation effort High Medium Low High
Technical expertise needed High Medium Low Medium
Flexibility High Medium Medium High
Setup cost Free Free Paid Paid
Monthly fees None None Yes Yes
Maintenance effort Medium Low Low Medium
Dangerous goods support Yes No Varies Yes
Error handling Advanced Basic Moderate Advanced
Development time Long Short Short Long
Integration support Self Basic Full Full