Locations

List locations

Changed on

Returns a cursor-paginated list of the locations acting as pickup or last-leg delivery points in your program. Narrow to one with id or your own external_id, though sending both is a 400, or filter by service. The name and address on each are what a buyer sees at checkout.

get/locations

Request

  • Base URL: https://api.ekho.com
  • URL: https://api.ekho.com/locations
  • Auth: HTTP bearer

Query parameters

idstring

Ekho location id. Narrows the list to at most one.

external_idstring

Your own id for the location. Narrows the list to at most one.

service'pickup' | 'last_leg_delivery'

Return only locations that perform this service.

limitinteger

Page size, 1 to 100.

Example:20
starting_afterstring

Return the page after this resource id (newest first).

Response

A page of locations.

has_moreboolean required

True when another page follows the returned one.

next_cursorstring nullable required

Pass as starting_after to fetch the next page; null when has_more is false.

Example response

{
  "data": [
    {
      "id": "svp_7Ye2kQp91LmXw4Za",
      "external_id": "APEX-4471",
      "name": "Apex Powersports of Charlotte",
      "email": "service@apexpowersports.example",
      "phone": "+17045550143",
      "address": {
        "address_line_one": "1100 Apex Commerce Dr",
        "address_line_two": "Suite 120",
        "city": "Charlotte",
        "state": "NC",
        "zip": "28217",
        "lat": 35.2271,
        "lng": -80.8431
      }
    }
  ]
}

Changes

  • c4f268c2d91bRevision changes
    • breaking

      removed the enum value delivery from the query request parameter service

    • warning

      added the new last_leg_delivery enum value to the /// response property for the response status

    • info

      added the new enum value last_leg_delivery to the query request parameter service

    • info

      removed the delivery enum value from the /// response property for the response status

  • 78c545d96a34Revision changes
    • info

      endpoint added