Get Location

GET /v2/tms-api/locations/{external_reference_id}

Retrieve details for a specific location using its external reference ID.

Path Parameters

external_reference_idstringrequired

The location's external reference ID (from your system)

Request Examples

cURL

curl -X GET "https://api.mentium.io/v2/tms-api/locations/LOC-CHICAGO-001" \
  -H "X-API-Key: your_api_key_here"

Python

import requests

response = requests.get(
    "https://api.mentium.io/v2/tms-api/locations/LOC-CHICAGO-001",
    headers={"X-API-Key": "your_api_key_here"}
)
print(response.json())

Response

200 OK

{
  "id": "loc_abc123def456",
  "external_reference_id": "LOC-CHICAGO-001",
  "name": "Chicago Distribution Center",
  "address_line1": "123 Industrial Blvd",
  "address_line2": null,
  "city": "Chicago",
  "state": "IL",
  "postal_code": "60601",
  "country": "US",
  "latitude": 41.8781,
  "longitude": -87.6298,
  "email": "warehouse@example.com",
  "phone_number": "312-555-0100",
  "weekday_open_hours": "08:00",
  "weekday_close_hours": "17:00",
  "weekend_open_hours": null,
  "weekend_close_hours": null,
  "internal_notes": null,
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-29T14:20:00Z"
}

404 Not Found

{
  "detail": "Location with external_reference_id 'LOC-CHICAGO-001' not found"
}

Response Fields

Field	Type	Description
id	string	Internal Mentium location ID
external_reference_id	string	Your external reference ID
name	string	Location name
address_line1	string	Street address line 1
address_line2	string	Street address line 2
city	string	City name
state	string	State/Province code
postal_code	string	Postal/ZIP code
country	string	Country code
latitude	number	Latitude (auto-geocoded if not provided)
longitude	number	Longitude (auto-geocoded if not provided)
email	string	Contact email address
phone_number	string	Contact phone number
weekday_open_hours	string	Weekday opening hours (HH:MM)
weekday_close_hours	string	Weekday closing hours (HH:MM)
weekend_open_hours	string	Weekend opening hours (HH:MM)
weekend_close_hours	string	Weekend closing hours (HH:MM)
internal_notes	string	Internal notes
created_at	string	Creation timestamp (ISO 8601)
updated_at	string	Last update timestamp (ISO 8601)