Sales Points

Point-of-sale location management and geographic exploration

List sale points

get

/sales-points

Returns all sale points owned by the authenticated merchant.

Roles: Association, Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Query parameters

pageintegerOptional

limitintegerOptional

childManagerstringOptional

SuperManager: filter by child manager ID

Responses

200

Sale point list

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

get/sales-points

GET /api/next/sales-points HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": [
    {
      "_id": "text",
      "name": "text",
      "city": "text",
      "country": "text",
      "street": "text",
      "lat": 1,
      "lng": 1,
      "zipCode": "text",
      "logoUrl": "text"
    }
  ]
}

Create a sale point

post

/sales-points

Creates a new point-of-sale location for the merchant.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Body

namestringRequired

citystringOptional

countrystringOptional

streetstringOptional

latnumberOptional

lngnumberOptional

zipCodestringOptional

logoUrlstringOptional

childManagerstringOptional

SuperManager: create under a specific child manager

Responses

200

Sale point created

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

422

Validation error

application/json

post/sales-points

POST /api/next/sales-points HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "name": "text",
  "city": "text",
  "country": "text",
  "street": "text",
  "lat": 1,
  "lng": 1,
  "zipCode": "text",
  "logoUrl": "text",
  "childManager": "text"
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "name": "text",
    "city": "text",
    "country": "text",
    "street": "text",
    "lat": 1,
    "lng": 1,
    "zipCode": "text",
    "logoUrl": "text"
  }
}

Get a sale point

get

/sales-points/{id}

Returns details of a sale point by ID.

Roles: Manager, SuperManager, SuperAdmin

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Responses

200

Sale point details

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

404

Not found

get/sales-points/{id}

GET /api/next/sales-points/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "name": "text",
    "city": "text",
    "country": "text",
    "street": "text",
    "lat": 1,
    "lng": 1,
    "zipCode": "text",
    "logoUrl": "text"
  }
}

Update a sale point

put

/sales-points/{id}

Updates one or more fields of a sale point.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Body

namestringOptional

citystringOptional

countrystringOptional

streetstringOptional

latnumberOptional

lngnumberOptional

zipCodestringOptional

logoUrlstringOptional

Responses

200

Sale point updated

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

put/sales-points/{id}

PUT /api/next/sales-points/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "name": "text",
  "city": "text",
  "country": "text",
  "street": "text",
  "lat": 1,
  "lng": 1,
  "zipCode": "text",
  "logoUrl": "text"
}

{
  "success": true,
  "status": 1,
  "data": {
    "_id": "text",
    "name": "text",
    "city": "text",
    "country": "text",
    "street": "text",
    "lat": 1,
    "lng": 1,
    "zipCode": "text",
    "logoUrl": "text"
  }
}

Delete a sale point

delete

/sales-points/{id}

Permanently removes a sale point.

Roles: Manager, SuperManager

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Path parameters

idstringRequired

Responses

200

Sale point deleted

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

dataanyOptional

Response payload

401

Unauthorized

application/json

delete/sales-points/{id}

DELETE /api/next/sales-points/{id} HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": null
}

Explore nearby sale points

get

/sales-points/explore

Returns sale points near the given GPS coordinates. Used by the customer-facing map.

Roles: Authenticated users

Authorizations

AuthorizationstringRequired

JWT token obtained from /auth/login or /auth/login/manager. Include as Authorization: Bearer <token>.

Query parameters

longitudenumberRequired

Longitude of the search center

latitudenumberRequired

Latitude of the search center

distancenumberOptional

Search radius in meters (optional)

Responses

200

Nearby sale points

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

401

Unauthorized

application/json

422

Validation error — longitude and latitude are required

application/json

get/sales-points/explore

GET /api/next/sales-points/explore?longitude=1&latitude=1 HTTP/1.1
Host: api.lyzi.fr
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "status": 1,
  "data": [
    {
      "_id": "text",
      "name": "text",
      "city": "text",
      "country": "text",
      "street": "text",
      "lat": 1,
      "lng": 1,
      "zipCode": "text",
      "logoUrl": "text"
    }
  ]
}

Locate sale points (public)

get

/sales-points/locate-sales-points

Public endpoint that returns nearby Lyzi-enabled merchant locations. No authentication required.

Responses

200

Sale point locations

application/json

successbooleanOptional

Whether the request succeeded

statusintegerOptional

HTTP status code

get/sales-points/locate-sales-points

GET /api/next/sales-points/locate-sales-points HTTP/1.1
Host: api.lyzi.fr
Accept: */*

200

Sale point locations

{
  "success": true,
  "status": 1,
  "data": [
    {
      "_id": "text",
      "name": "text",
      "city": "text",
      "country": "text",
      "street": "text",
      "lat": 1,
      "lng": 1,
      "zipCode": "text",
      "logoUrl": "text"
    }
  ]
}