1. Home
  2. Docs
  3. API documentation
  4. partner API
  5. List all available destinations

List all available destinations

Only applicable if you are going to be using delivery to our APMs (Automatic
Parcel Machines).
This call will list all available APM locations where we can deliver your parcel to. Use /destinations to list available APM locations we can deliver the goods to. You will refer to these records by id when requesting delivery later on.
These parameters are available to you to filter all APM locations:

NameTypeDescription
latlngstringIf applied, only locations in the specified
radius from these gps coordinates are
returned.
radiusnumberRadius in meters to return only locations
within a selected radius from given GPS
location.
Ignored if latlng is not present.
requiredSizenumberReturn only locations that can accept a
package of your requiredSize.
locationTypearray[string]Return only locations with given a type. If
not present, filter is not applied.
Available values : apm, any-apm, warehouse, depot
namestringReturn only locations with matching name

See an example of an integration:

GET /destinations

curl -X 'GET' \
  ‘.../destinations?latlng=48.78081955454138%2C12.446962472273063&radius=1000&requiredSize=1’ \
  -H 'accept: application/json'							

Status Code 200

{
  "data": [
    {
      "id": "string",
      "type": "apm",
      "image": "https://via.placeholder.com/150",
      "lat": "48.78081955454138",
      "lng": "12.446962472273063",
      "title": "ΠΑΝΤΕΛΟΓΛΟΥ ΔΗΜΗΤΡΗΣ",
      "name": "ΠΑΝΤΕΛΟΓΛΟΥ ΔΗΜΗΤΡΗΣ",
      "addressLine1": "ΛΕΩΦΟΡΟΣ ΕΙΡΗΝΗΣ 28",
      "addressLine2": "string",
      "postalCode": "15121",
      "country": "GR",
      "note": "You can find it behind the pet shop",
      "expectedDeliveryTime": "2021-06-07T12:33:18.723Z"
    }
  ]
}

Status Code 400

The server cannot or will not process the request due to something that is perceived to be your error (e.g., malformed request syntax, invalid request message). You are to modify the request before sending it again.

{
  "code": "string",
  "message": "string"
}

Status Code 401

Not Authorized. You are either using an expired Access token to access the data or trying to initialize Auth session with invalid data.

Alternatively, refer to section 4 for a PHP script you can embed into your web to display
all available APMs via a pop-up widget, or for a brief descriptions of successful custom
map integration.


id
When requesting delivery, you will refer to these records by id.
You will need also to select location from which the delivery will be picked up – typically
your warehouse. You can list all your warehouses using /origins API which has the same
parameters as /destinations API call where you do not specify parameters latlng, radius or
requiredSize, but you specify locationType as “warehouse”. You refer to this location by
its ID.


Moreover there is one specific location called any-apm that can be listed by the same
way and using locationType as “any-apm”, it returns just one location – any-apm. You can
refer to it by its ID. Usage of this will be explained in next section.