API Reference

Delivery Point object

This is an object representing delivery points.

Delivery points

Delivery points are simply the location involved in the delivery and some extra information regarding the location for how the delivery should be made or who is involved in the delivery. This can be a pickup location and dropoff location and can be represented with an address in words, or just latitude and longitude coordinates.

When creating a delivery point, you can either send in the address in words, or in the geographic coordinate of latitude and longitude pairs. Either way, we will try to make out the other with what you submit to us.

Although not required, it is also recommended you add notes about the delivery point for a better delivery experience for your users. For example, "only pick up from the sous chef", "knock 3 times" and "yellow door with a 4" can give information about the who, how and where of the delivery respectively.


Delivery point object fields

FieldData typeDescriptionType
idstringunique id of delivery pointrequired
business_idstringreference to unique id of business making requestrequired
emailstringemail address of contact person at the delivery addressrequired
phone_numberstringphone number of contact person at the delivery addressrequired
namestringname of contact person at the delivery addressrequired
notesstringadditional information on how and where to delivery package at the delivery locationoptional
addressjsonfull delivery address including street, city, state, zip code and countryoptional
longitudenumbergeographic coordinate that specifies the north–south position of the delivery point on the Earth's surfaceoptional
latitudenumbergeographic coordinate that specifies the west–east position of the delivery point on the Earth's surfaceoptional