Tracking Links Via API Overview All consignments that have been created in MachShip will have a linked MachShip tracking page that can be accessed publicly. This link sends the user to a branded webpage that shows all of the details of the consignment as well as live tracking updates. The consignment tracking link is made up of two parts: […] Read more »
Tracking & PODs Overview MachShip provides comprehensive tracking capabilities through our RESTful API, allowing you to: Query consignment status and tracking information Generate public tracking page links Retrieve proof of delivery (POD) documents This guide explains how to effectively use these features in your integration. Tracking Consignments Available Endpoints MachShip offers several endpoints for retrieving consignment information, each […] Read more »
Manifesting Consignments via the API Overview Manifesting is a crucial step in the shipping process that finalises a consignment in MachShip and transmits the consignment data to the transport provider. This guide explains how to manifest consignments programmatically using the MachShip API. Understanding the Process Manifesting in MachShip is a two-step process: Group Consignments: First, you group consignments that share […] Read more »
Creating International Consignments via the MachShip API Overview Welcome to the guide on international consignments using the MachShip API. This document serves as a companion to our main guide on Creating Consignments and focuses specifically on the additional considerations and steps required when shipping dangerous goods. Understanding International Consignments International consignments are consignments where either the from OR to location is a […] Read more »
Flags & Surcharges Overview When creating consignments, pending consignments, or generating prices using the routes endpoint you can use the questionIds field to flag in and out manual surcharges across all of your carriers. The “questions” appear as checkboxes in the MachShip UI and are linked to similar surcharges across carriers. Common surcharges & flags include: Residential Pick […] Read more »
Creating Pending Consignments Via The MachShip API What is a Pending Consignment? A pending consignment is a draft shipping job that that can be completed and converted into a consignment by warehouse staff using the MachShip interface: A typical pending consignment will contain Pick-up location Delivery location Optional carrier selection Optional service selection Optional package details What a pending consignment is not: […] Read more »
Getting Prices, Routes & Service Availability Using MachShip API Overview One of MachShip’s primary functions is to dynamically generate prices, routes and service availability based on the items that are being sent. When pricing, MachShip will describe every carrier, service and price that is available based on: Pickup suburb and postcode Delivery suburb and postcode Items being sent Desired dispatch date and time Included […] Read more »
How to Create API Users and Tokens Overview API tokens in MachShip are created in MachShip on specific users and inherit all of that user’s permissions, company access, and test mode settings. When setting up integrations, it’s best practice to create a new user for that integration so any actions taken by that API key are easily trackable back to that user […] Read more »
Webhooks Getting Started with Webhooks MachShip supports outbound webhooks to notify your systems in real-time when a consignment is created, updated, or completed. This guide explains how to get set up and what to expect. To request a webhook setup, please email our integrations team: clientintegrations@machship.com Include the following details in your request: Webhook URL The […] Read more »
Supported Platform List Definitions Platform List Integration Types Supported – Setup and maintained by MachShip Custom – Can be setup and maintained by MachShip, but requires custom work Inbuilt/Native – the platform has a native integration with MachShip built into the platform that’s supported by the software provider Third-Party Extension – a third-party company (not the software creator) […] Read more »
