Article

Returns list of articles and treat a variant combination same as an article

get/core/latest/articles/article-and-variants

Request

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

Query parameters

include-quantityboolean

flag to include quantity in the result.

limitinteger

Define the limit of the article list that this API returns.<br />For example, if a company have 20 articles in total, and this <b>limit</b> parameter is 5, and the <b>offset</b> parameter is 0,<br />then this API will return article list containing the first 5 articles<br />If not set, then default value of 48 is used

offsetinteger

Define which position to start getting article list.<br />For example, if a company have 20 articles in total, and this <b>offset</b> parameter is 5,<br />then this API will return article list from the 5th article.<br />If not set, then default value of 0 is used

sell-in-bookingboolean

flag to define sellable article for booking.

sell-in-online-shopboolean

flag to query articles that are sold in online shop.

use-posboolean

flag to define article that are using in POS.

Response

List of article and variant

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.