Below you'll find tutorials and reference documentation that will teach you how to use the Delivery Choices API suite.
What is the Delivery Choices?
Delivery Choices is an API suite offering services that allow your customers the ability to select when and where their parcels are delivered to provide them maximum convenience. Delivery choices are available for parcels lodged with Australia Post via the eParcel lodgement system.
Delivery choices offers the following parcel delivery options:
- Speed of delivery
- Standard delivery 2- 5 working days or express delivery overnight within the specified network.
- Location of delivery
- Recipients can select one of Australia Post’s Customer Collection Locations
- Day and Date of Delivery
- Recipients can elect to specify the day/s of the week or a specific date they wish to receive deliveries
- Conversely recipients can elect days of the week they would prefer not to receive deliveries
- In addition, merchants can specify an embargo on delivery whereby an item is not to be delivered prior to a specific date or provide a postal address
- Time
- Recipients can elect to request an AM or PM delivery window or a 2 hour delivery window; 9am -11am, 11am – 1pm, 1pm – 3pm, 3pm -5pm, 5pm – 7pm.
Delivery Choice API Overview
- Name
- Description
- Customer Collection Points
- Searches for available collection points and associated data relevant to the customers query. Postcode search returns locations that border the postcode as well as those directly located within it. It also describes the type of collection point, access days and hours and address of the collection point.
- Query Delivery Timeslots
- Returns all delivery timeslots available for each day of the week and the times associated with that particular day
- Query Tracking
- Queries the current status for a consignment or article. This API can be used to display white label (your own branding) tracking on your website
- Delivery Dates
- Returns a list of 10 delivery dates available for an article/consignment based on the lodgement date, from/to locations and the network used to deliver the product type. Always presents the expected delivery date first followed by nine additional dates.
What do I need to do to access the Delivery Choices APIs?
Access to the Delivery Choices API suite requires an API key and an Australia Post credit account.
Prior to being able to use the Delivery Choice APIs a number of steps must be completed:
- Receive your invitation email and login to your Australia Post ‘My Account’ using the link provided
- Accept the invitation (The invitation must be accepted within 4 weeks otherwise it will expire)
- Click the ‘Accept’ link in the invitations table and then click the ‘Confirm’ button
- Your invitation has now been accepted and added to the ‘Established associations’ table
- Press the back button to return to your ‘My account’ page
- Create a new Service Profile
- Click the ‘Manage organisations’ button
- Click the link corresponding to your organisation
- Click the ‘Create new service profile’ button
- Confirm your details and select which Delivery Choices APIs you require access to
- Once you have created a service profile you will have the production API credentials required to access the Australia Post production API data
Need more help?
Contact Us
Still can't find what you need? Contact us and we'll get back to you.