Enable Multi-Priority Courier Selection on the Quote API

Available from 01 April 2019

This user guide is intended for customers who ship parcels with Bonds making use of the Shippit Quote API.  Shippit now offers more than one priority courier option. Shippit now offers Bonds as well as Allied Express same-day for priority deliveries.  As such, the Shippit Quote API (v3) will change on 01 April 2019 to support multiple priority carriers, when enabled.

 

Why are we introducing this?

This change is introduced to ensure sure that Shippit allocates the correct priority courier when returning the array of priority timeslots when multiple couriers are enabled.

 

What is changing?

From  01 April 2019 the Quote API `courier type` field will return the allocated priority courier name in the array of priority timeslots when multiple couriers are enabled.  Shippit will allocate to the cheapest priority carrier per each priority timeslots. This could result in Shippit recommending a different courier for each timeslot.

If only one priority courier is enabled only this courier’s availability and pricing will be returned.  There are no changes to the standard or express service responses.

  • Quote API response before change:

 

{
   "response": [
       {
           "courier_type": "Bonds",
           "error": null,
           "quotes": [
               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "07:00-10:00",
                   "delivery_window_desc": "7AM-10AM",
                   "price": 24.24
               },
               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "10:00-13:00",
                   "delivery_window_desc": "10AM-1PM",
                   "price": 24.2"
               },

               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "13:00-16:00",
                   "delivery_window_desc": "1PM-4PM",
                   "price": 24.2"
               },

               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "16:00-19:00",
                   "delivery_window_desc": "4PM-7PM",
                   "price": 24.2"
               },
               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "19:00-22:00",
                   "delivery_window_desc": "7PM-10PM",
                   "price": 24.2"
               }
           ],
           "service_level": "priority",
           "success": true
       }
   ],
   "count": 3,
}

 

  • Quote API response after change:

 

{
   "response": [
       {
           "courier_type": "Priority",
           "error": null,
           "quotes": [
               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "07:00-10:00",
                   "delivery_window_desc": "7AM-10AM",
                   "price": 24.24,
                   "courier_type": "AlliedExpressP2P"
               },
               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "10:00-13:00",
                   "delivery_window_desc": "10AM-1PM",
                   "price": 24.2",
                   "courier_type": "Bonds"
               },

               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "13:00-16:00",
                   "delivery_window_desc": "1PM-4PM",
                   "price": 24.2",
                   "courier_type": "AlliedExpressP2P"
               },

               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "16:00-19:00",
                   "delivery_window_desc": "4PM-7PM",
                   "price": 24.2",
                   "courier_type": "Bonds"
               },
               {
                   "delivery_date": "2014-09-18",
                   "delivery_window": "19:00-22:00",
                   "delivery_window_desc": "7PM-10PM",
                   "price": 24.2",
                   "courier_type": "AlliedExpressP2P"
               }
           ],
           "service_level": "priority",
           "success": true
       }
   ],
   "count": 3,
}

 

How do I enable multiple priority couriers?

  • You can enable and disable couriers on your Shippit account by selecting the ON/OFF toggle in the Settings → Carriers → Priority & 3-Hour Delivery Services.  
  • Remember to save your selection by clicking on the `UPDATE` button at the bottom of the page.



Next Steps

You need to confirm with your IT team if these API changes will impact your current integration with Shippit.  If so, you need to update your integration to accommodate for the aforementioned changes. If not, then these API changes should not impact you.

You will need to enable Allied Express Same Day on your SettingsCarriers to make use of the multi-priority carrier services.

 

Does this change impact how I place priority orders on Shippit?

There are two ways you can submit orders to Shippit using the Order API.  You can either specify the service level with the `courier type` or specify the courier with the `courier allocation` field.

To ensure that Shippit allocates to the correct courier when you have multiple priority couriers enabled it is highly recommended to always submit your priority orders by specifying the service level with the `courier type` field.

If you submit orders and specify the `courier allocation` all orders will be submitted to the courier specified in this field, i.e. “Bonds” or “AlliedExpressSameday”.

 

Example of a priority request.

 

{
   "order": {
       "courier_type": "priority",
       "delivery_address": "1 Union Street",
       "delivery_postcode": "2009",
       "delivery_state": "NSW",
       "delivery_suburb": "Pyrmont",
       "authority_to_leave": "Yes",
       "delivery_date": "2016-07-26",
       "delivery_window": "16:00-19:00",
       "parcel_attributes": [
           {
               "qty": 1,
               "weight": 2.1
           }
       ],
       "user_attributes": {
           "email": "test@shippit.com",
           "first_name": "John",
           "last_name": "Smith"
       }
   }
}

 

Require more detail?

Please refer to the Shippit API specifications for more detail, or alternatively, you can contact Shippit directly with more questions.

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.