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:
By setting these questions in your API request, MachShip will automatically include the linked surcharges in the prices returned.
To set the field on the API, you need to add the questionIds field as documented on the various endpoints.
You can set multiple surcharges on the same request, as the questionIds field accepts an array (list) of values.
The below example would trigger all residential delivery surcharges, and all tailgate surcharges (the various ids are listed below).
{
...
"questionIds": [
13,
7
]
...
}
7 - Hydraulic Tailgate required
8 - Crane Truck required
13 - Is residential delivery
14 - Authorised to leave - note, additional options required for ATL documented below.
36 - Hand unload required
{
...
"questionIds": [13]
...
}{
...
"questionIds": [7]
...
}{
...
"questionIds": [36]
...
}Example: Authority To Leave (ATL)
Setting an ATL flag differs between carriers, so how you set this is a little more complex and requires changes to multiple fields.
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 would need to make the following changes to your API request:
{
...
"specialInstructions": " Authority To Leave. (rest of notes go here)",
"questionIds": [14],
"customValues": [
{
"propertyName": "SafeDropEnabled", //For auspost & startrack only
"value": true
},
{
"propertyName": "Atl",
"value": true
},
{
"propertyName": "IsAtl",
"value": true
},
{
"propertyName": "IsAuthorisedToLeave",
"value": true
}
]
...
}Commonly question ids are used to restrict a given shipment to a group of carriers and services.
For examples, you may request a flag to be added for "requires next day", then link that to 2-3 overnight services.
In these instances you would be provided with the question id for your question to use in your requests.