How To Question Ids on API requests for Residential, Tailgate and other surcharges

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 required
8 - Crane Truck required
13 - Is residential delivery
14 - Authorised to leave - note, additional options required for ATL documented here.
36 - Hand unload required

How to set these on the API
To set the field on the API, you need to add the questionIds field as documented on the various endpoints.

Example flagging residential
  1. "questionIds": [
                "13"
            ]
Example flagging residential AND tailgate
  1. "questionIds": [
                "13",
                "7",
            ]

    • Related Articles

    • Machship API Integration Workflow Guide

      The objective of this article is to give you a quick-start guide in working with our API to achieve common integration workflows, and how that affects which API endpoints you wish to use. API Authentication & Documentation Our API accepts and returns ...

    • A guide to creating Consignments via the API

      Creating consignments is at the core of MachShip's functionality. Consignments describe everything related to a job that needs to travel including the pick-up location, delivery location and the individual items themselves. On top of this, a ...

    • A guide to creating Dangerous Goods Consignments via the API

      Creating consignments is at the core of MachShip's functionality. Consignments describe everything related to a job that needs to travel including the pick-up location, delivery location and the individual items themselves. On top of this, a ...

    • 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 generating prices and routes via the API

      One of MachShip's primary functions is to dynamically generate prices and routes based on the items that are being sent. When pricing, MachShip will describe every despatch option and price that is available for a given combination of: Pickup suburb ...