Retrieve A Location

get

https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID

Fetches a single location's complete profile and operating settings, including its default revenue center, tax rate, and printing configuration.

Request Headers

Header	Required	Description
Authorization	Yes	Bearer YOUR_ACCESS_TOKEN

Request Parameters

Path Parameters:

Parameter	Type	Required	Description
location_id	integer	Yes	Location to retrieve.

Query Parameters:

Parameter	Type	Required	Description
user_id	integer	Yes	The acting user.
global_on_id	integer	No	Originating channel identifier. (1)

cURL Example

curl --request GET \
  --url "https://sandbox-api.softpoint.io/interface/v1/locations/98342?user_id=1&global_on_id=1" \
  --header "Authorization: Bearer YOUR_ACCESS_TOKEN"

Success Response

{
  "profile": {
    "location_name": "Copperfield Bistro",
    "legal_entity_name": "Copperfield - LAB",
    "external_id": "Xy7PbD2k",
    "status": 1,
    "address": "456 Elm St.",
    "city": "Blueberry Springs",
    "global_state_id": 5,
    "state": "California",
    "global_country_id": 3,
    "country": "United States",
    "zip_code": "923748",
    "email": "[email protected]",
    "phone": "(345) 987-6573"
  },
  "settings": {
    "location_id": 98342,
    "global_business_types_id": 4,
    "business_type": "Casual Dining",
    "eod_time": "02:30:00",
    "timezone": "(GMT-08:00) America, Los Angeles"
  },
  "revenue_center": { "pos_id": 2, "name": "DINING ROOM", "default": 1 },
  "order_types": [],
  "tax_rates": { "status": 1, "name": "Sales Tax - CA", "rate": "8.250", "type": 0, "default": 1 },
  "printing_settings": { "receipt_text": 1, "receipt_email": 1, "receipt_print": 1 }
}

Response Fields

Field	Type	Description
profile	object	Identifying and contact details (name, legal entity, address, state/country, email, phone).
settings	object	Operating settings (business type, end-of-day time, timezone, age verification).
revenue_center	object	The default revenue center (`pos_id`, `name`, `default`).
order_types	array	Configured order types (may be empty).
tax_rates	object	The default tax rate (`name`, `rate` as a percent string, `default`).
printing_settings	object	Receipt delivery flags (`receipt_text`, `receipt_email`, `receipt_print`).

Error Responses

Unauthorized / Invalid Token

{
  "error": {
    "code": 10759,
    "message": "Operation timed out. Please try again.",
    "details": { "Exception": "Could not decode token: The token \"token\" is an invalid JWS" }
  }
}

Status Codes

Code	Description
200	Location returned
401	Token missing, expired, or invalid

Workflow Placement

A read operation used to confirm a location's configuration after boarding or before processing orders.

Notes

Unlike Retrieve All Locations, this returns a structured profile/settings object rather than a flat summary.
Here tax_rates.rate is a percentage string (for example, "8.250"), distinct from the basis-point value accepted by Update A Location.

Common Mistakes

Omitting user_id.
Expecting the same shape as the list endpoint.

Responses

200OK

401Unauthorized