To get started using the Parcelpoint API:
- Request access for a developer account
- Locate your Client ID and Client Secret in the email we sent to you
- Generate your HTTP Bearer Token to utilise the API
What can the API do?
You can use the Parcelpoint API to deliver or return your products within our geographic zones.
Here is the flow of events that developers most commonly follow when using our API:
Delivery
- At the time of fulfillment, manifest a parcel using the customers address
- While the delivery is in progress, you can track the status of the parcel by polling the API or using the tracking page
Pickup
- Display a list of pickup locations for the customer to choose from on your checkout
- At the time of fulfillment, manifest a parcel using the address of the chosen pickup location
- While the delivery is in progress, you can track the status of the parcel by polling the API or using the tracking page
Returns
- Display a list of return locations for the customer to choose from on your checkout
- At the completion of the booking, manifest a return using the address of the chosen return location
- While the return is in progress, you can track the status of the return by polling the API or using the tracking page
Rate Limiting
There is a global rate limit for API requests.
| Environment | Requests/minute |
|---|---|
| Sandbox | 10,000 |
| Production | 10,000 |
Exceeding this rate limit will result in a 429 response.
Versioning
Versioning allows us to provide developers with a consistent experience. We provide two levels of versioning:
- Resource: All endpoints are prefixed with a version such as
/v1. This version refers to the overall layout of the endpoints and response standards. - Client: Developers can ensure consistent fields and formats by specifying a version as an HTTP header.
Addresses
Please format all addresses this way:
Unit/Suite/Level, Street Address, Suburb, State, PostcodeAny other information, like apartment number, door codes, "care of" instructions, should all be added to pickup or dropoff notes fields. Any extra information included may result in a malformed address, and our geocoder will not be able to find the location.