get
https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/revenue_center
Returns a paginated list of the revenue centers (sales areas) defined for a location.
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| location_id | integer | Yes | Location whose revenue centers are listed. |
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | integer | No | Filter by status (1 = active). |
| user_id | integer | Yes | The acting user. |
| limit | integer | No | Page size. |
| paginate | string | No | Pagination mode. |
| page | integer | No | Page number. |
| global_on_id | integer | No | Originating channel identifier. |
cURL Example
curl --request GET \
--url "https://sandbox-api.softpoint.io/interface/v1/locations/3000324/revenue_center?status=1&user_id=1&limit=10&paginate=data&page=1&global_on_id=2" \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
{
"revenue_center": {
"current_page": 1,
"data": [
{
"id": "6557",
"id_external": "100",
"pos_id": 100,
"location_id": 3000324,
"status": 1,
"default": 1,
"name": "RESTAURANT"
}
],
"per_page": 10,
"total": 1
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
| revenue_center | object | Paginator wrapper. |
| revenue_center.data | array | Revenue-center records. |
| data[].id | string | Internal revenue-center ID. |
| data[].id_external | string | External/POS ID. |
| data[].pos_id | integer | POS-side identifier. |
| data[].status | integer | Status. |
| data[].default | integer | 1 if this is the default revenue center. |
| data[].name | string | Revenue-center name. |
Status Codes
| Code | Description |
|---|---|
| 200 | Revenue centers returned |
| 401 | Token missing or invalid |
Workflow Placement
A reference read used to resolve revenue-center IDs before creating an order/ticket.
Notes
-
The paginator is nested under a
revenue_centerkey. -
Exactly one record is typically flagged
default: 1.
Common Mistakes
- Reading
dataat the top level instead of underrevenue_center.