Skip to main content
POST

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Body

application/json
name
string
required

Article name

Minimum string length: 1
internalArticleNr
string
required

Internal article number (must be unique per company)

Minimum string length: 1
hsCode
string
required

HS code — EUDR relevance and commodity group are determined automatically

Minimum string length: 1
shortDescription
string

Short description of the article.

articleType
enum<string>

Defaults to purchase. Sale articles are automatically linked to your company as supplier.

Available options:
purchase,
sale
externalArticleNr
string

External article number, e.g. a supplier's or customer's number.

ean
string

EAN / GTIN barcode.

weightPerPieceKg
number

Weight of one piece in kg; must be greater than 0. Lets order lines be sent as a piece count.

sourceScope
enum<string>

standing (default): the source is fixed. perOrder: the source varies per order and order import creates one copy of the article per order.

Available options:
standing,
perOrder
supplierId

Link to an existing supplier (recommended — fetch IDs via GET /api/v1/suppliers). Required for purchase articles if supplierName is not provided.

supplierName
string

Fallback when you have no supplierId (prefer supplierId). Matched against your existing suppliers ignoring case and surrounding/repeated whitespace; if none matches, a new supplier is created. Required for purchase articles if supplierId is not provided.

supplierEmail

Optional supplier contact email. Used when creating a new supplier via supplierName.

eudrRelevant
boolean

Explicit EUDR classification; overrides the one derived from the HS code.

commodityGroup
enum<string>

Explicit EUDR commodity group; overrides the one derived from the HS code.

Available options:
cattle,
cocoa,
coffee,
oil_palm,
rubber,
soya,
wood,
non_relevant
acknowledgeWarnings
boolean

Set to true to override soft duplicate warnings. If omitted/false and the article triggers a soft warning (duplicate name or duplicate EAN), the request returns 409 with a machine-readable warnings array instead of creating the article. A hard duplicate of internalArticleNr always returns 409 and cannot be overridden.

Response

Article created successfully (single)

article
object
required

The stored article fields. Further keys may be present and are not part of the contract; read the full article with GET /api/v1/articles/{id}.