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
    }
  ]
}

​
Purpose

Retrieve stop list data for specific products. The stop list indicates product limitations such as stock limits. If a product is not returned in the response, it means that product does not have any stop list limitations.

​
HTTP Request

GET https://integrations.clopos.com/open-api/products/stop-list

​
Query Parameters

​
Filters

You can filter by product IDs to get stop list data for specific products.
ParameterTypeRequiredDescription
filters[0][0]stringNoFilter field name. Use "id" to filter by product ID.
filters[0][1]arrayNoArray of product IDs to filter.

​
Filter Syntax

To filter by product IDs, use the following format: 
filters[0][0]=id&filters[0][1][0]=1&filters[0][1][1]=332
This will filter for products with IDs 1 and 332.

​
Request Example

curl --location --globoff 'https://integrations.clopos.com/open-api/products/stop-list?filters[0][0]=id&filters[0][1][0]=1&filters[0][1][1]=332' \
  --header 'x-token: oauth_example_token' \
  --header 'x-brand: openapitest' \
  --header 'x-venue: 1'

​
Response

​
200 OK — Success

Returns an array of stop list entries for the requested products. If a product does not have stop list limitations, it will not appear in the response. 
{
    "success": true,
    "data": [
        {
            "id": 54,
            "limit": 0,
            "timestamp": 1761202010781
        },
        {
            "id": 57,
            "limit": 3,
            "timestamp": 1761202001368
        },
        {
            "id": 275,
            "limit": 5,
            "timestamp": 1762929390368
        },
        {
            "id": 306,
            "limit": 5,
            "timestamp": 1761202448860
        }
    ]
}

​
400 Bad Request — Invalid Parameters

{
  "success": false,
  "error": "invalid_parameter",
  "message": "Invalid filter parameters"
}

​
401 Unauthorized — Missing Header

{
  "success": false,
  "error": "unauthorized",
  "message": "Missing authentication headers"
}

​
Response Fields

FieldTypeDescription
successbooleanIndicates the result of the request.
dataarrayArray of stop list entries. If empty or a product is missing, that product has no stop list limitations.

​
Stop List Entry Object

FieldTypeDescription
idintegerProduct ID. This corresponds to the product identifier.
limitintegerStock limit for the product. 0 means the product is out of stock or has no available quantity.
timestampintegerUnix timestamp (in milliseconds) when the stop list entry was last updated.

​
Notes

  • The id field in the response represents the product_id.
  • If a product is not included in the response data, it means that product does not have any stop list limitations.
  • Use the filters parameter to query specific products by their IDs.
  • The limit field indicates the available stock limit. A value of 0 typically means the product is unavailable.
  • The timestamp field shows when the stop list entry was last updated, useful for tracking changes.

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.