Fetch Pickup Location Details

Fetch Pickup Location Details - Retrieve a saved pickup location

Use this endpoint to retrieve details for a specific pickup location using its externalLocationId.

The response includes the saved pickup address, contact information, status, and other location details available to the authenticated account.

When to use this endpoint

To verify a pickup location before creating orders.
To confirm whether a pickup location is active.
To troubleshoot pickup address or contact information issues.

Important notes

The externalLocationId identifies the pickup origin.
A pickup location may be shared by multiple merchants.
Use Create Bulk Orders to create shipments from this pickup location.

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

Location FoundLocation Not 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"
  }
}

🟠401

Fetch Pickup Location Details

Fetch Pickup Location Details - Retrieve a saved pickup location

When to use this endpoint

Important notes

Request

Request Code Samples

Responses

Fetch Pickup Location Details

Fetch Pickup Location Details - Retrieve a saved pickup location#

When to use this endpoint#

Important notes#

Request

Request Code Samples

Responses

Fetch Pickup Location Details - Retrieve a saved pickup location

When to use this endpoint

Important notes