Zum Hauptinhalt springen
GET
List Articles
Das Feld plots enthält die eindeutigen Parzellen des Artikels ohne Geometrie, höchstens 1000 Einträge (nach id sortiert); plotsTruncated: true zeigt an, dass es mehr gibt. Die Geometrie einer Parzelle liefert GET /api/v1/plots/{id}. supplierLinks listet die Lieferantenverknüpfungen des Artikels als [{ supplierId, supplierArticleId }] ([] ohne Lieferant). Die supplierArticleId adressiert den Artikel für genau einen Lieferanten — für supplierArticleIds in POST /api/v1/plots und supplierArticleId in GET /api/v1/evidence. Dasselbe Feld trägt der in Bestellzeilen eingebettete Artikel. Siehe Herkunft pro Bestellung per ERP.

Autorisierungen

Authorization
string
header
erforderlich

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

Abfrageparameter

internalArticleNr
string

Filter by internal article number (ERP ID), exact match. A per-order copy of an article is <internalArticleNr>#<orderNumber> — encode # as %23.

externalArticleNr
string

Filter by external article number

hsCode
string

Filter by HS code

externalSupplierId
string

Filter by the supplier number from your ERP (externalSupplierId) of a supplier linked to the article

orderNumber
string

Filter by order number: articles on a line of that order

species
string

Filter by species: articles with a linked plot naming this scientific name (exact match)

commodityGroup
enum<string>

Filter by commodity group

Verfügbare Optionen:
cattle,
cocoa,
coffee,
oil_palm,
rubber,
soya,
wood,
non_relevant
articleType
enum<string>

Filter by article type

Verfügbare Optionen:
purchase,
sale
eudrRelevant
enum<string>

Filter by EUDR relevance

Verfügbare Optionen:
true,
false
limit
integer
Standard:100

Maximum number of results to return (default 100, max 1000).

Erforderlicher Bereich: 1 <= x <= 1000
offset
integer | null
Standard:0

Number of results to skip for pagination.

Erforderlicher Bereich: x >= 0
fields
string

Comma-separated list of the resource's top-level keys to return (per element for a list), e.g. id,name; omit for the full body. Top-level only; whitespace is trimmed and duplicates count once. fields never adds keys: a selected optional key that is absent on a row stays absent. 400 when passed more than once, when empty, or when it names an unknown key (the error names it and lists the allowed ones).

Antwort

List of articles

id
string
erforderlich

UUID of the article.

name
string
erforderlich

Article name.

shortDescription
string
erforderlich

Short description of the article; empty string when none was given.

internalArticleNr
string
erforderlich

Internal article number (your ERP ID), unique per company. A per-order copy of an article carries <internalArticleNr>#<orderNumber>; the number to show to people is externalArticleNr when set, else internalArticleNr.

externalArticleNr
string | null
erforderlich

External article number, e.g. a supplier's or customer's number. On a per-order copy it holds the original article's internalArticleNr.

ean
string | null
erforderlich

EAN / GTIN barcode, or null.

hsCode
string
erforderlich

Harmonized System code

articleType
string
erforderlich

purchase (bought from a supplier) or sale (sold by your company).

eudrRelevant
boolean
erforderlich

Automatically determined from HS code

needsManualCheck
boolean
erforderlich

true when the EUDR classification derived from the HS code should be checked by a person.

sourceScope
string
erforderlich

standing: the article's source is fixed. perOrder: the article is a template whose source varies per order; order import creates one copy per order from it.

hsPlausibility
object | null
erforderlich

Stored result of an advisory check of the HS code against the article description, or null when not checked. Stored only: it never warns about or blocks a create or update. The object's shape is not part of the v1 contract and may change — do not depend on it.

suppliers
object[]
erforderlich

The suppliers linked to the article. Embedded suppliers carry empty articles and plots.

plots
object[]
erforderlich

Distinct plots of the article without geometry, at most 1000 (ordered by id); fetch geometry via GET /plots/{id}.

complianceResults
object[]
erforderlich

The EUDR compliance result per supplier link of the article.

geoComplianceResults
any[]
erforderlich

Geolocation compliance details. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.

Legal compliance details. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.

Legal documents on record. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.

Per-category legal compliance results. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.

questionnaires
any[]
erforderlich

Supplier questionnaire responses. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.

countryOfProduction
string[] | null
erforderlich

Countries of production declared on one of the article's supplier links (which one is not specified), or null.

commodityGroup
string
erforderlich

EUDR commodity group, derived from the HS code unless set explicitly. One of the CommodityGroup values.

weightPerPieceKg
number | null
erforderlich

Weight of one piece in kg, used to derive net mass from a piece count; null when unknown.

deletedAt
string | null
erforderlich

When the article was moved to the trash (ISO 8601, UTC); null for a live article.

plotsTruncated
boolean
erforderlich

true when the article has more than 1000 distinct plots and plots holds only the first 1000 by id.

certifications
any[]

Certifications (e.g. FSC, PEFC) on record for the article; absent when the article has no supplier link. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.

ownSupplierArticleIds
string[]

UUIDs of the article's own supplier articles (one per linked supplier); absent when the article has no supplier link.

The article's supplier links. supplierArticleId addresses this article for one supplier: pass it in supplierArticleIds of POST /api/v1/plots. Present on the article endpoints and on order-line articles; [] when the article has no supplier.

inputArticles
any[]

Upstream input articles recorded for the article's supply chain; absent when there are none. Present, but the item shape is not part of the v1 contract and may change — do not depend on it.