Get Saved Pickup Locations

GET

/locations

GET /locations — List saved pickup locations

Returns all pickup locations saved in Flype for the authenticated client.

Use cases

Verify which locations are registered in Flype

Audit or troubleshoot pickup location setup

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

Query parameters (pagination)

offset (default 0): starting index of results to return

limit (default 50): number of records to return (max per Flype configuration)

Response

Returns a list of locations in data and pagination info in pagination.

Each location includes a status field.

If no locations match, data will be an empty array.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Responses

🟢200

application/json

Bodyapplication/json

🟠401

🟠400

Request Example

Shell

JavaScript

Java

Swift

curl --location '/locations?offset=0&limit=50' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
  "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"
    },
    {
      "externalLocationId": "STORE_567",
      "name": "Manhattan",
      "status": "INACTIVE",
      "address": {
        "street1": "235 West 56th street",
        "street2": "Building 1",
        "city": "New York",
        "postalCode": "10019",
        "country": "United States"
      },
      "contact": {
        "name": "Pickup Desk",
        "phone": "+1-212-555-0101"
      },
      "createdAtUtc": "2026-01-15T11:10:00Z"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 50,
    "total": 2
  }
}

Upsert Pickup Location

Fetch Pickup Location Details

Get Saved Pickup Locations

GET /locations — List saved pickup locations#

Request

Responses

GET /locations — List saved pickup locations