Skip to main content
GET
/
articles
/
List all articles
curl --request GET \
  --url http:localhost:3000/v2/articles/ \
  --header 'x-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "chatId": "<string>",
    "type": "ARTICLE",
    "name": "<string>",
    "price": 123,
    "unit": "<string>",
    "description": "<string>",
    "numberExtern": "<string>",
    "prices": [
      {
        "sellPrice": 19.99,
        "buyPrice": 15,
        "currency": "EUR",
        "tax": 0.19,
        "taxRateId": "60c72b2f9b1e8d3f4c8b4567",
        "comment": "<string>"
      }
    ],
    "bookingAccountNumber": "<string>",
    "skontoBookingAccountNumber": "<string>",
    "comment": "<string>",
    "attachmentIds": [
      "<string>"
    ],
    "articleDescription": "<string>",
    "imageUrl": "<string>",
    "groupId": "<string>",
    "supplierId": "<string>",
    "priority": 123,
    "inStock": 123,
    "minimumInStock": 123
  }
]

Authorizations

x-API-Key
string
header
required

Query Parameters

limit
integer
default:100
Required range: 1 <= x <= 1000
offset
integer
default:0
Required range: x >= 0
sort
string

Response

List of articles

type
enum<string>

Type of the product Product type

Available options:
SERVICE_PRODUCT,
ARTICLE
Example:

"ARTICLE"

articleDescription
string | null

Description of the article

imageUrl
string | null

Image URL for the article

groupId
string<objectid> | null

Group ID for the article

supplierId
string<objectid> | null

Supplier ID for the article

priority
integer | null

Priority of the article

inStock
integer | null

How many of the articles are currently in stock

minimumInStock
integer | null

Minimum requirement to be in stock

name
string

Name of the product

price
number | null

Unit price of the product

unit
string | null

Unit of measurement for the product

description
string | null

Description of the product

numberExtern
string | null

External product number (for supplier or external reference)

prices
ProductPrice · object[]

List of prices for the product

bookingAccountNumber
string | null

DATEV booking account number for the product. If not set, the default booking account number of the tax rate will be used.

skontoBookingAccountNumber
string | null

DATEV booking account number for Skonto for the product. If not set, the default of the tax rate will be used.

comment
string | null

Comment for the product

attachmentIds
string<objectid>[]

List of attachment IDs associated with the product

_id
string<objectid>

Unique identifier of the entity

number
integer

Unique number of the entity, used for identification

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

chatId
string<objectid> | null

ID of the chat associated with this entity