GROperator

Branches

Every operation of the LastMile Public API, generated from the OpenAPI document. The reference text is in English in both languages.

GET

/api/public/v1/branches

#

List branches

API key + secret, or bearer tokenRequired scope: branches:read

Paginated; ordered by name. Scope branches:read.

Parameters

NameInTypeDescription
pagequeryinteger (int32)
Default: 1

Page number, starting at 1.

pageSizequeryinteger (int32)
Default: 25

Items per page, 1 to 100 (larger values are clamped to 100).

searchquerystring

Optional text matched against name, code and city.

activeOnlyqueryboolean

When true, only active branches.

Request example

GET /branches
curl -G "https://apiv1.groperator.com/api/public/v1/branches" \
  -H "X-API-Key: lmc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  --data-urlencode 'activeOnly=true'

Samples use an API key; replace the placeholders. To use a bearer token instead, send Authorization: Bearer <accessToken>.

Responses

200A page of branches.

Responses · Field
FieldTypeDescription
items
required
array<PublicBranchDto>

Items of the requested page.

id
items[].id
required
string (uuid)

Branch id.

name
items[].name
required
string

Branch name.

code
items[].code
required
string

Branch code.

city
items[].city
required
string

City name as entered on the branch.

phone
items[].phone
stringnullable

Branch phone, when set.

latitude
items[].latitude
number (double)nullable

Latitude, when set.

longitude
items[].longitude
number (double)nullable

Longitude, when set.

isActive
items[].isActive
required
boolean

Whether the branch is active.

page
required
integer (int32)

Current page number, starting at 1.

pageSize
required
integer (int32)

Requested page size (1 to 100, default 25).

totalCount
required
integer (int32)

Total number of items across all pages.

totalPages
required
integer (int32)

Total number of pages.

200 · Example response
{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "code": "string",
      "city": "string",
      "isActive": false
    }
  ],
  "page": 1,
  "pageSize": 1,
  "totalCount": 1,
  "totalPages": 1
}
StatusDescription
400

The request is invalid (code validation_failed, details.errors lists every field).

401

Authentication is missing or invalid (code unauthorized).

403

Missing scope or public API disabled.

429

Too many requests (code rate_limited); wait for the Retry-After header.

Error responses share one body, described in the error reference. Error reference

GET

/api/public/v1/branches/{id}

#

Get one branch

API key + secret, or bearer tokenRequired scope: branches:read

Scope branches:read.

Parameters

NameInTypeDescription
id
required
pathstring (uuid)

Branch id.

Request example

GET /branches/3fa85f64-5717-4562-b3fc-2c963f66afa6
curl "https://apiv1.groperator.com/api/public/v1/branches/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "X-API-Key: lmc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-API-Secret: YOUR_API_SECRET"

Samples use an API key; replace the placeholders. To use a bearer token instead, send Authorization: Bearer <accessToken>.

Responses

200The branch.

Responses · Field
FieldTypeDescription
id
required
string (uuid)

Branch id.

name
required
string

Branch name.

code
required
string

Branch code.

city
required
string

City name as entered on the branch.

phonestringnullable

Branch phone, when set.

latitudenumber (double)nullable

Latitude, when set.

longitudenumber (double)nullable

Longitude, when set.

isActive
required
boolean

Whether the branch is active.

200 · Example response
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "code": "string",
  "city": "string",
  "isActive": false
}
StatusDescription
401

Authentication is missing or invalid (code unauthorized).

403

The credential lacks the required scope, or the public API is disabled (codes forbidden, channel_disabled).

404

Code branch.not_found.

429

Too many requests (code rate_limited); wait for the Retry-After header.

Error responses share one body, described in the error reference. Error reference