Article

Returns article list of a company

get/core/latest/articles

Request

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

Query parameters

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

product-type'SERVICE' | 'PRODUCTION' | 'TRADE' | 'OTHER' | 'GIFT_CARD' | 'PREPAYMENT'

Type of product used for an article

Filter articles with this product type.

Response

Articles

idstring

Id of the article. Does not need to be included when creating article

nameDEstring required

Name of the article in German

nameENstring

Name of the article in English

nameFRstring

Name of the article in French

nameITstring

Name of the article in Italian

descriptionDEstring

Description of the article in German

descriptionENstring

Description of the article in English

descriptionFRstring

Description of the article in French

descriptionITstring

Description of the article in Italian

extendedDescriptionDEstring

Extended description of the article in German

extendedDescriptionENstring

Extended description of the article in English

extendedDescriptionFRstring

Extended description of the article in French

extendedDescriptionITstring

Extended description of the article in Italian

unitDEstring required

Unit of the article in German

unitENstring

Unit of the article in English

unitFRstring

Unit of the article in French

unitITstring

Unit of the article in Italian

barcodestring

Barcode of the article

usePosboolean

Decides if this article is used for POS or not

imageHrefsstring[]

Reference uris for the images of this article if present.

isArticleSetboolean

Decides if this article is an article set

articleSetNamestring

Name of the article set. Does not need to be included if article is not an article set.

defaultQuantitynumber

The default quantity of the article

accountingTagsstring[] required

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

articleNumberstring required

Article number

hasVariantboolean

Specify if the article has variants or not

includedInArticleSetsstring[]

Names of the article sets that the article is included in.<br />If the article have some variants, then only the variants will show the article set name they belong to, not the parent article (null value is shown).

sellInOnlineShopboolean

Specify if the article is able to be sold on the Online shop or not

isAdultArticleboolean

Specify if the article is only used for adult or not

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

The product type of the article

searchTagsstring[]

Search tags make it easier for your customer to find your product in the online shop

numberType'NO_NUMBER' | 'BATCH_NUMBER' | 'SERIAL_NUMBER'

Inventory Number Type<br />Use either NO_NUMBER or SERIAL_NUMBER

Example response

[
  {
    "id": "1",
    "options": [
      {
        "name": "color"
      }
    ],
    "imageHrefs": [
      "https://api.klara.ch/core/latest/articles/1/images/1"
    ],
    "articleNumber": "ABC123",
    "posCategories": [
      {
        "id": "1",
        "category_href": "https://api.klara.ch/core/latest/article-categories/1",
        "nameDE": "shop",
        "nameEN": "shop",
        "nameFR": "shop",
        "nameIT": "shop"
      }
    ],
    "posFilters": [
      {
        "id": "1",
        "filter_href": "https://api.klara.ch/core/latest/article-filters/1",
        "nameDE": "shop",
        "nameEN": "shop",
        "nameFR": "shop",
        "nameIT": "shop"
      }
    ],
    "onlineShopCategories": [
      {
        "id": "1",
        "category_href": "https://api.klara.ch/core/latest/article-categories/1",
        "nameDE": "shop",
        "nameEN": "shop",
        "nameFR": "shop",
        "nameIT": "shop"
      }
    ],
    "onlineShopFilters": [
      {
        "id": "1",
        "filter_href": "https://api.klara.ch/core/latest/article-filters/1",
        "nameDE": "shop",
        "nameEN": "shop",
        "nameFR": "shop",
        "nameIT": "shop"
      }
    ],
    "bookingCategories": [
      {
        "id": "1",
        "category_href": "https://api.klara.ch/core/latest/article-categories/1",
        "nameDE": "shop",
        "nameEN": "shop",
        "nameFR": "shop",
        "nameIT": "shop"
      }
    ],
    "vats": [
      {
        "vatType": "NORMAL",
        "vatCase": "TAXABLE_SUPPLY",
        "vatCode": "1"
      }
    ]
  }
]

Changes

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