v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List all the company dispatches

get/v1/dispatch_locations

Query parameters

ids[]integer[]

Specify the IDs of the dispatch locations of the company.

vendor_idsstring[]

Specify the IDs of the vendors from where the dispatch originates.

per_pageinteger

Denotes the number records to be shown per page.

page_nointeger

The current page number.

Response

200

Example response

{
  "dispatch_locations": [
    {
      "dispatch_location": {
        "id": 2,
        "vendor_id": "DL1",
        "lat": 2,
        "lon": 3,
        "name": "Office",
        "address1": "350 Sansome St.",
        "address2": "San Francisco",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94104",
        "country": "US",
        "arrive_radius": 200,
        "depart_radius": 200,
        "phone": "(650) 238-9293"
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 2
  }
}