Search POS articles
search_pos_articlesSearch the organization's POS provider's catalogue, live through its article search: articles by name (query), within a category (categoryId) or exactly by ids, or with kind: "categories" the venue's categories. venueId is one of the organization's venues, its id from list_venues. The ids and price lists in the answer are what link_benefit_articles and a stamp card's article rule take. Cluby keeps no copy of the catalogue, so this needs the POS connection's articleSearchUrl (get_pos_connection) and the provider's service to answer; 400 without the former (404 without an enabled connection), 502 with the reason when the latter does not answer the contract.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"venueId": "<venueId>"
},
"name": "search_pos_articles"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Exactly these articles or categories, repeated (`ids=4012&ids=4015`), up to 50: the names behind the ids a benefit or a stamp card holds. Not with `query`. | |
| kind | No | Which list to fill: articles, or the venue's categories. | articles |
| after | No | The previous page's `nextAfter`. | |
| limit | No | Articles or categories per page, 1 to 100. | |
| orgId | No | Organization public id, the `id` field from list_orgs. Omit it when the API key reaches exactly one organization. | |
| query | No | A case-insensitive substring of the name. Not with `ids`. | |
| venueId | Yes | The venue whose catalogue to search: its `id` from `GET /v2/orgs/my`, or the scan event's `venueId`. | |
| categoryId | No | Articles only: limit to this category. |