Additional API topics
How To Question Ids on API requests for Residential, Tailgate and other surcharges
When creating consignments, pending consignments, or generating prices using the routes endpoint you can use the questionIds field to flag in and out surcharges across all of your carriers. List of common flags and the Ids: 7 - Hydraulic Tailgate ...
Setting ATL (Authority To Leave) Via the API
By default, majority of carriers assume there is no authority to leave the goods without a signature across majority of services. If you wish to instruct the carrier that they do have authority to leave when creating a consignment via the API, you ...
Creating Benign or Existing Consignments Via The API
Benign or existing consignments are consignments created in Machship purely for the purpose of tracking and reporting - they cannot be manifested and no data is sent to the carriers. Endpoint: POST ...
How to Edit Consignments Via The API
The following article will cover how to edit a consignment via the API. The main use cases for an edit workflow include: Adjusting item weights/dimensions Adding new items Removing items Note: This article will not cover the basics of creating ...
How to Create Consignments Via The API With Your Own Consignment Ids and Item References
The following article will cover how to create a consignment via the API when you are delegating your own carrier consignment numbers and item references/barcodes. This is an advanced topic, and requires the generation of fully compliant carrier ...
A guide to editing Complex Consignments Via The API when setting Item References
The following article will cover how to edit a consignment via the API when you are delegating your own carrier consignment numbers and item references/barcodes. The main use cases for an edit workflow include: Adjusting item weights/dimensions ...
Auto-Consolidation Via The MachShip API
What is auto-consolidation? Auto-consolidation is a feature of Machship that is enabled on a per carrier basis, where we combine newly created consignments into existing consignments at the point they are created, rather than making a new ...
Creating Items when only cubic cm/m and total weight is available
In order to accurately price a movement with carriers, MachShip requires: Length Height Width Weight Quantity ItemType The reason that we need these dimensions over a pure cubic number is because various carriers have surcharges that can be impacted ...
Linking Identities Across Different Organisations
Users from one organisation can be invited into another organisation so that they are granted access to certain companies in the other organisation. In order to connect organisations, there are 2 basic steps that need to be completed: The inviter ...
Browser Support and Discontinuing Support for Internet Explorer and other Older Browsers
As we continue to enhance MachShip and provide improved features and security, we want to make sure that you are experiencing MachShip in its complete capacity. As browsers continue to improve, we are able provide enhanced features by using the new ...
How to get the Tracking Page Access Link via the API
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 ...
Working with despatch dates when routing and creating Consignments
This guide outlines how to use Despatch date/times effectively when generating routes and creating consignments. Despatch DateTimes are optional and if none are provided, NOW will be used. MachShip allows you to specify the despatch date and time of ...
Working with locations when routing and creating Consignments
When routing or creating consignments, you must provide to MachShip both the pickup and delivery suburbs/locations. This is a guide on the multiple ways that these locations can be provided to MachShip. Pickup and Delivery Locations MachShip offers ...
Working with items when routing and creating Consignments
When routing or creating consignments, MachShip requires the details of the items that are being sent. MachShip offers multiple ways to specify the items for the consignment/route request. To return prices, at least 1 item must be supplied. Multiple ...