Free-text search across sellable articles
Free-text search across sellable articles (and their variants) of the caller's company. Matches by name, article number, barcode, variant number and set-header name. Returns each row enriched with the price valid on price-date and the appropriate VAT rate. Requires permission ARTICLE_READ_ONLY.
Request
- Base URL: https://api.klara.ch
- URL: https://api.klara.ch/core/latest/articles/search
- Auth: one of:
- API key in header X-API-KEY
- HTTP bearer
Query parameters
If true, return ABROAD (export) VAT rate; otherwise NORMAL.
Renamed to <code>search-key</code>. This name is accepted until <b>2027-09-01</b>; when both are sent, <code>search-key</code> wins. After that date, a request sending <code>keyword</code> without <code>search-key</code> is rejected with <b>400</b>.<br/><br/><strong>Deprecated</strong> — use <code>search-key</code> instead. Free-text search key. Trimmed; empty/missing returns the first page unfiltered.
Page size (1–100).
0-based pagination offset.
Date on which prices are evaluated. Format: yyyy-MM-dd. Defaults to today when omitted.
Free-text search key. Trimmed; empty/missing returns the first page unfiltered.
If true, cross-validate each row's VAT code against the company's VAT setup on price-date.
Response
Matching articles
Example response
[
{
"id": "1",
"articleNumber": "ABC123"
}
]Changes
No recorded changes to this operation across all 1 revision of this API.