Skip to main content
GET
List shops (stores / boutiques / points of sale)

Authorizations

Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

page
integer
default:1

Page number, 1-indexed (default: 1)

Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:20

Number of items per page, max 100 (default: 20)

Required range: 1 <= x <= 100
q
string

Case-insensitive substring search query

isActive
enum<string>

Filter by active status. true = active only, false = inactive only, omit = all shops.

Available options:
true,
false
kind
string

Filter by shop kind (e.g. STORE, WAREHOUSE, OUTLET).

Response

Successful response

data
object[]
required

Page of items

meta
object
required

Pagination metadata

success
enum<boolean>
required
Available options:
true