Skip to main content
GET
/
products
/
stop-list
Get stop list
curl --request GET \
  --url https://integrations.clopos.com/open-api/products/stop-list \
  --header 'x-brand: <api-key>' \
  --header 'x-token: <api-key>' \
  --header 'x-venue: <api-key>'
{
  "success": true,
  "data": [
    {
      "id": 123,
      "limit": 123,
      "timestamp": 123
    }
  ]
}

Authorizations

x-token
string
header
required

Access token obtained from /auth endpoint

x-brand
string
header
required

Brand identifier

x-venue
string
header
required

Venue identifier

Query Parameters

filters[0][0]
string

Filter field name. Use 'id' to filter by product ID.

Example:

"id"

filters[0][1]
integer[]

Array of product IDs to filter. Use multiple parameters like filters[0][1][0]=1&filters[0][1][1]=332

Response

Stop list retrieved successfully

success
boolean
required

Indicates the result of the request

data
object[]
required

Array of stop list entries. If empty or a product is missing, that product has no stop list limitations.