Get Saved Pickup Locations

Get Saved Pickup Locations - List registered pickup locations

Use this endpoint to retrieve pickup locations saved in Flype for the authenticated account.

This endpoint can be used to verify registered locations, check location status, and retrieve location identifiers for order creation.

When to use this endpoint

To list pickup locations registered with Flype.
To confirm the correct externalLocationId before creating orders.
To check whether a location is active or inactive.
To audit or troubleshoot pickup location setup.

Pagination

offset controls the starting index.
limit controls the number of records returned.

Important notes

If no locations match, data will be returned as an empty array.
Inactive locations may not be usable for rates or shipment creation.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200

application/json

Bodyapplication/json

Examples

SuccessEmpty Response

{
  "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
  }
}

🟠401

🟠400

Get Saved Pickup Locations - List registered pickup locations

When to use this endpoint

Pagination

Important notes

Request

Request Code Samples

Responses

Get Saved Pickup Locations

Get Saved Pickup Locations - List registered pickup locations#

When to use this endpoint#

Pagination#

Important notes#

Request

Request Code Samples

Responses

Get Saved Pickup Locations - List registered pickup locations

When to use this endpoint

Pagination

Important notes