Setting ATL (Authority To Leave) Via the API

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 would need to make the following changes to your API request.

1. Add "Authority To Leave" to the start of your special instructions
  1.  {
    //create consignment payload here
    "specialInstructions": " Authority To Leave. (rest of notes go here)"
2. Set QuestionId 14 - which flags relevant surcharges
  1.  {
    //create consignment payload here
    "questionIds": [
                "14"
            ]
3. Set CustomValue for ATL
  1. {
    //create consignment payload here 
    "customValues": [
       {
          "propertyName": "Atl",
          "value": true
        },
        {
          "propertyName": "IsAtl",
          "value": true
        },
        {
          "propertyName": "IsAuthorisedToLeave",
          "value": true
        }
      ]
    }
3.a (Optional) Set SafeDrop for AustraliaPost
For AusPost, they also have an additional option for SafeDrop - to utilise that you can set as follows:
  1. {
    //create consignment payload here 
    "customValues": [
       {
          "propertyName": "SafeDropEnabled",
          "value": true
        },
       {
          "propertyName": "Atl",
          "value": true
        },
        {
          "propertyName": "IsAtl",
          "value": true
        },
        {
          "propertyName": "IsAuthorisedToLeave",
          "value": true
        }
      ]
    }


    • Related Articles

    • 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 ...

    • 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 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 ...

    • 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 ...

    • 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 ...