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/v2/products/stop-list
This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses. Query Parameters
Filters
You can filter by product IDs to get stop list data for specific products.
| Parameter | Type | Required | Description |
|---|
filters[0][0] | string | No | Filter field name. Use "id" to filter by product ID. |
filters[0][1] | array | No | Array 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
1 and 332.
Request Example
curl --location --globoff 'https://integrations.clopos.com/open-api/v2/products/stop-list?filters[0][0]=id&filters[0][1][0]=1&filters[0][1][1]=332' \
--header 'x-token: oauth_example_token' \
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
}
]
}
When no products are on the stop list, the response returns an empty data array: {"success": true, "data": []}. This is normal and indicates no products currently have stock limitations.
400 Bad Request — Invalid Parameters
{
"success": false,
"error": "invalid_parameter",
"message": "Invalid filter parameters"
}
{
"success": false,
"error": "unauthorized",
"message": "Missing authentication headers"
}
Field Reference
Stop List Entry Object
| Field | Type | Description |
|---|
id | integer | Product ID. This corresponds to the product identifier. |
limit | integer | Stock limit for the product. 0 means the product is out of stock or has no available quantity. |
timestamp | integer | Unix 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.
