Article

Find articles by article numbers

Batch-resolve a list of article numbers to their priced article rows of the caller's company. Returns each row enriched with the price valid on price-date and the appropriate VAT rate. Unknown article numbers are silently skipped (returned list contains only matching rows). Requires permission ARTICLE_READ_ONLY.

get/core/latest/articles/article-numbers

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/core/latest/articles/article-numbers
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Query parameters

unknown

Article numbers to look up. Repeat the parameter for each value (e.g. ?article-numbers=ART-001&article-numbers=ART-002). At most 100 entries; each entry up to 64 characters.

export-vatboolean

If true, return ABROAD (export) VAT rate; otherwise NORMAL. Defaults to false.

price-datestring date
Example:2026-06-01

Date on which prices are evaluated. Format: yyyy-MM-dd. Defaults to today when omitted.

should-validate-vatboolean

If true, cross-validate each row's VAT code against the company's VAT setup on price-date. Defaults to false.

Response

Matching articles

idstring

Id of the article

namestring

Name of the article

descriptionstring

Description for the article

extendedDescriptionstring

This description will be used for example in your online shop

unitstring

Define how the article is count by

barcodestring

Barcode of the article

defaultQuantitynumber

The default quantity of the article

accountingTagsstring[]

Tags used for accounting. Articles with the same tag, same VAT case and same VAT rate are grouped together in the posting

articleNumberstring

Number of the article

productType'SERVICE' | 'PRODUCTION' | 'TRADE' | 'OTHER' | 'GIFT_CARD' | 'PREPAYMENT'

The product type of the article

vatRatenumber

Vat rate of the article

articleType'ARTICLE' | 'ARTICLE_SET' | 'VARIANT'

Article type

priceIncludeVatnumber

price include vat

priceExcludeVatnumber

price exclude vat

hasInventoryboolean

This article has inventory or not

quantityInStocknumber

Quantity in stock

optionValuesstring[]

Variant option of this article

ableToOrderOutOfStockboolean

Flag define the article is allow to order out of stock

Example response

[
  {
    "id": "1",
    "articleNumber": "ABC123"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.