Fetch Pickup Location Details

GET

/locations/{externalLocationId}

Get location details by externalLocationId

Returns the saved pickup location details for the provided externalLocationId.

Use cases

Retrieve the unique pickup location identifier mapped to a known externalLocationId

Validate the saved pickup address/contact details

Check the location status (e.g., ACTIVE, INACTIVE) before using it in /rates or order creation

Path parameter

externalLocationId: your unique pickup location identifier (previously sent to Flype or generated by Flype)

Response

Returns the location object in data.

If the location does not exist, returns 404 Not Found.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Bodyapplication/json

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location '/locations/STORE_123' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Location Found

{
  "status": "success",
  "data": {
    "externalLocationId": "STORE_123",
    "name": "Store Name - Downtown",
    "status": "ACTIVE",
    "address": {
      "street1": "123 Main St",
      "street2": "Suite 10",
      "city": "New York",
      "postalCode": "10001",
      "country": "United States"
    },
    "contact": {
      "name": "Pickup Desk",
      "phone": "+1-212-555-0101"
    },
    "createdAtUtc": "2026-02-01T12:10:00Z"
  }
}

Get Saved Pickup Locations

ApiStatus

Fetch Pickup Location Details

Get location details by externalLocationId#

Request

Responses

Get location details by externalLocationId