API Reference

Locations are a very important piece of data in order to create a delivery. There are 2 type of locations: pick up and drop off. Both share the same key information:

  • Address
  • Address details
  • Latitude and Longitude
  • Contact Information
    • Full Name
    • Phone Number
    • E-Mail
  • Notes

Pickup locations are what we could call stores, warehouses or any specific place where a courier will go to pickup products.

In the pickup object, you can provide your own internal code to identify a location in the location_reference_id field. This way you can use the Get Order or List deliveries endpoint to search for details, orders, events and more for that specific location.

Once Location endpoint is live

We are currently working on a locations endpoint to let you pre-create locations in case you'd prefer that. That's an optional way of using the API for specific business types. For example, this is helpful for businesses with static number of locations like a food franchises with 50 outlets in the country.

The endpoint is not released but you can access it here. We'll share further instructions once it is live.