Article

the Article API

get
Path parameters
idinteger · int64Required

an article id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Responses
chevron-right
200

OK

*/*
get
/erp/articles/{id}
200

OK

Update existing article

put
Path parameters
idinteger · int64Required

an article id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

active

Default: true
baseArticlebooleanRead-onlyOptional

Ist das der Basis-Artikel des Produkts?

Default: true
productTypestring · enumRead-onlyOptional

Artikelarten

Possible values:
priceBasestring · enumOptional

Preisbasis

Possible values:
serialTypestring · enumRead-onlyOptional

Serientyp eines Artikels

Possible values:
expiryDateTypestring · enumRead-onlyOptional

Art des Haltbarkeitsdatums bei Serienartikeln

Possible values:
warrantyInMonthsinteger · int32Read-onlyOptional

Garantie in Monaten

serialNumberLabelingTypestring · enumRead-onlyOptional

Seriennummer Auszeichnungsart

Possible values:
numberstring · max: 255Required

unique product number

sellablebooleanOptional

is this product sellable

Default: true
purchasablebooleanOptional

is this product purchasable

Default: true
solvablebooleanOptional

is this product solvable to another package-variant

Default: false
mergeablebooleanOptional

is this product mergeable to another package-variant

Default: false
salesUnitnumberOptional

Verkaufseinheit

grossVolumeInCubicMetersnumberOptional

gross Volume in cubic meters

capacitynumberOptional

capacity

baseCapacitynumberOptional

base capacity

netSalesPricenumberOptional

net sales prices

grossSalesPricenumberOptional

gross sales prices

customobjectOptional

Search-Dialog

basePriceUnitnumberOptional

Basispreiseinheit

deliverablebooleanRequired

Ist der Artikel noch lieferbar?

Default: true
customsTariffNumberstring · max: 15Optional

Zolltarifnummer

manufacturerIdstringOptional

Hersteller des Produkts

listingIdstringOptional

die id des Listings

taxLiabilityReversedbooleanOptional

Umkehrung der Steuerschuld nach §13b UStG?

Default: false
sellableWithoutStockbooleanOptional

is this product sellable without any quantity at the stock

Default: false
listedbooleanOptional

soll der Artikel gelistet werden

Default: true
listingStatestring · enumRead-onlyOptional

Synchronisationsstatus eines Listings

Possible values:
listingStateChangeTimestring · date-timeRead-onlyOptional

die letzte Aktualisierung des listingStates

namestringOptional

name of this product

alternativeNamestringOptional

alternative name of this product

descriptionstringOptional

description of this product

listingDescriptionCustomobjectOptional

Search-Dialog

listingCustomobjectOptional

Search-Dialog

languageCodestringOptional

Einschränkung auf Land

isDangerousGoodbooleanOptional

Artikel ist Gefahrgut

Default: false
availableAlonebooleanOptional

alleine lieferbarer Artikel?

Default: true
pickingTypestring · enumOptional

Definiert die Art, wie ein Artikel kommissioniert werden darf

Default: ACCORDING_TO_TEMPLATEPossible values:
workUnitInMinutesinteger · int32Optional

Arbeitseinheit in Minuten

initialLastPurchasePricenumberOptional

Letzter EKP (Startwert)

initialAvgPurchasePricenumberOptional

Durchschnittl. EKP (Startwert)

determineAvgPurchasePricebooleanOptional

dEK berechnen?

Default: true
commissionablebooleanOptional

provisionsberechtiger Artikel?

Default: true
cashDiscountablebooleanOptional

skontierbarer Artikel?

Default: true
discountablebooleanOptional

rabattierbarer Artikel?

Default: true
printWarningIfNoContingentAvailablebooleanOptional

Nur für Kontingentartikel: soll bei der Abrechnung angedruckt werden, dass kein Kontingent vorhanden ist?

Default: true
freelyPickablebooleanOptional

Frei kommissionierbar

Default: false
shippingLabelPrintingbooleanOptional

Versandlabeldruck

Default: false
permissibleForOrderProposalbooleanOptional

zulässig für Aufnahme in Bestellvorschläge

Default: true
dropShippingPolicystring · enumRequired

Definiert, ob und wie ein Artikel per Streckengeschäft verkauft werden darf

Default: STORAGEPossible values:
fabricationbooleanOptional

Produktion

Default: false
onlyManualFabricationbooleanOptional

Nur manuelle Produktion

Default: false
fabricationOfComponentsstring · enumOptional

Produktion von Komponenten

Possible values:
needsAssessmentOnlyOnReservationBasisbooleanOptional

Bedarfsermittlung nur über Reservierungen

Default: false
remarkstringOptional

Sonderbemerkung

notestringOptional

Notiz

Responses
chevron-right
200

successful operation

*/*
put
/erp/articles/{id}
delete
Path parameters
idinteger · int64Required

an article id

Responses
chevron-right
200

OK

*/*
delete
/erp/articles/{id}
200

OK

Update existing Resource

put
Path parameters
idinteger · int64Required

ID of Article

taxIdinteger · int64Required

ID of product-tax

Body

steuerzuordnung eines artikels

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

countryCodestringRequired

the country, this entry is valid for

validFromstring · dateRequired

the date, this entry is valid from

articleIdinteger · int64Read-onlyOptional

the date, this entry is valid from

Responses
chevron-right
200

successful operation

*/*
put
/erp/articles/{id}/taxes/{taxId}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

ID of Article

taxIdinteger · int64Required

ID of product-tax

Responses
chevron-right
200

successful operation

*/*
delete
/erp/articles/{id}/taxes/{taxId}

Verlängert eine Sperre

put
Path parameters
idinteger · int64Required

ID der gesperrten Resource

lockTokeninteger · int64Required

Token der zu verlängernden Sperre

Query parameters
leasePeriodinteger · int64Required

Optionale Lease-Dauer in Sekunden

Responses
chevron-right
200

OK

*/*
put
/erp/articles/{id}/leasable-lock/{lockToken}
200

OK

Gibt ein Sperre frei

delete
Path parameters
idinteger · int64Required

ID der gesperrten Resource

lockTokeninteger · int64Required

Token der freizugebenden Sperre

Responses
chevron-right
200

OK

No content

delete
/erp/articles/{id}/leasable-lock/{lockToken}
200

OK

No content

get
Path parameters
idinteger · int64Required

an article id

componentIdinteger · int64Required

an component id

Query parameters
languageCodestringOptional
Responses
chevron-right
200

OK

*/*
get
/erp/articles/{id}/fabrication-components/{componentId}
200

OK

put
Path parameters
idinteger · int64Required

an article id

componentIdinteger · int64Required

an component id

Query parameters
languageCodestringOptional
Body

Komponente eines Produktionsartikels

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

quantitynumberRequired

Menge

namestring · max: 255Optional

Bezeichnung

descriptionstring · max: 2147483647Optional

Beschreibung

forSerialInheritancebooleanOptional

Basis für die Vererbung der Seriennummer

Default: false
sortOrderinteger · int32Optional

Sortierreihenfolge

activebooleanRead-onlyOptional

Aktiv?

Default: true
Responses
chevron-right
200

OK

*/*
put
/erp/articles/{id}/fabrication-components/{componentId}
200

OK

delete
Path parameters
idinteger · int64Required

an article id

componentIdinteger · int64Required

an component id

Responses
chevron-right
200

OK

*/*
delete
/erp/articles/{id}/fabrication-components/{componentId}
200

OK

deaktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
chevron-right
200

successful operation

*/*
put
/erp/articles/{id}/deactivate
get
Path parameters
idinteger · int64Required

an article id

componentIdinteger · int64Required

an component id

Query parameters
languageCodestringOptional
Responses
chevron-right
200

OK

*/*
get
/erp/articles/{id}/components/{componentId}
200

OK

put
Path parameters
idinteger · int64Required

an article id

componentIdinteger · int64Required

an component id

Query parameters
languageCodestringOptional
Body

Komponenten eines Baugruppen- oder Jumbo-Artikels

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

containerArticleIdinteger · int64Required

Baugruppen- oder Jumbo-Artikel

componentArticleIdinteger · int64Required

Artikel dieser Komponente

numberstringOptional

Artikelnummer der Komponente

namestringOptional

Name der Komponente

descriptionstringOptional

Beschreibung der Komponente

quantitynumberOptional

Menge der Komponente

positioninteger · int32Optional

Position der Komponente innerhalb des Containers

salesPricenumberOptional

Verkaufspreis der Komponente

purchasePricenumberOptional

Einkaufspreis (DEK) der Komponente

grossWeightnumberOptional

Brutto-Gewicht der Komponente

netWeightnumberOptional

Netto-Gewicht der Komponente

stockAmountnumberOptional

Bestand der Komponente

stockAvailablenumberOptional

verfügbare Menge der Komponente

Responses
chevron-right
200

OK

*/*
put
/erp/articles/{id}/components/{componentId}
200

OK

delete
Path parameters
idinteger · int64Required

an article id

componentIdinteger · int64Required

an component id

Responses
chevron-right
200

OK

*/*
delete
/erp/articles/{id}/components/{componentId}
200

OK

aktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
chevron-right
200

successful operation

*/*
put
/erp/articles/{id}/activate
get
Path parameters
articleIdinteger · int64Required

an article id

listingIdinteger · int64Required

a listing id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Responses
chevron-right
200

OK

*/*
get
/erp/articles/{articleId}/listings/{listingId}
200

OK

put
Path parameters
articleIdinteger · int64Required

an article id

listingIdinteger · int64Required

an sales-channel id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

sellableWithoutStockbooleanOptional

is this product sellable without any quantity at the stock

Default: false
listedbooleanOptional

soll der Artikel gelistet werden

Default: true
listingStatestring · enumRead-onlyOptional

Synchronisationsstatus eines Listings

Possible values:
listingStateChangeTimestring · date-timeRead-onlyOptional

die letzte aktualisierung des listingStates

customobjectOptional

Search-Dialog

proposedLowestPriceNetnumberRead-onlyOptional

Niedrigster Netto-Preis der letzten 30 Tage (vom System ermittelt)

proposedLowestPriceGrossnumberRead-onlyOptional

Niedrigster Brutto-Preis der letzten 30 Tage (vom System ermittelt)

customLowestPriceNetnumberOptional

Niedrigster Netto-Preis der letzten 30 Tage (benutzerdefinierte Eingabe)

customLowestPriceGrossnumberOptional

Niedrigster Brutto-Preis der letzten 30 Tage (benutzerdefinierte Eingabe)

Responses
chevron-right
200

OK

*/*
put
/erp/articles/{articleId}/listings/{listingId}
200

OK

patch
Path parameters
articleIdinteger · int64Required

an article id

listingIdinteger · int64Required

an listingId id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Body
objectOptional

Search-Dialog

Responses
chevron-right
200

OK

*/*
patch
/erp/articles/{articleId}/listings/{listingId}
200

OK

put
Path parameters
articleIdinteger · int64Required

an article id

listingIdinteger · int64Required

an listing id

Query parameters
statestring · enumRequired

Synchronisationsstatus eines Listings

Possible values:
Responses
chevron-right
200

OK

No content

put
/erp/articles/{articleId}/listings/{listingId}/state
200

OK

No content

Führt den Druck eines Etikettendruck-Stapels durch

put
Path parameters
batchIdstring · uuidRequired
Body
exportFormatstring · enumOptional

output forma für mail/file-export

Possible values:
exportFilenamestringOptional

filename (ohne extension) bei einem file-export

outputTypestringOptional

outputType

groupIdentifierstringOptional

OutputReportGroup Identifier (optional), sonst Default-Group des Moduls

publishedbooleanOptional

sollen nur bereits veröffentlichte Dokumente beachtet werden?

Responses
chevron-right
200

OK

*/*
Responseobject
put
/erp/articles/print-labels/{batchId}
200

OK

Neuen Artikel (ggf. mit Produkt) erzeugen

post
Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Body
productTypestring · enumOptional

Artikelarten

Possible values:
serialTypestring · enumOptional

Serientyp eines Artikels

Possible values:
createArticlesOrBundlesbooleanOptional

Direkt Artikel/Gebinde anlegen

Default: false
bundlebooleanOptional

Nur wenn productRef leer ist: Handelt es sich um ein Gebinde?

Default: false
numberstringOptional

Artikel-Nummer (nicht, wenn es ein Gebinde ist und ein Produkt angegeben ist

namestringOptional

Bezeichnung

priceUnitnumberRequired

Preiseinheit

priceBasestring · enumOptional

Preisbasis

Possible values:
bundleSchemaIdinteger · int64Optional

Vorlage zum Erstellen mehrerer Artikel

createTemplateIdinteger · int64Optional

Vorlage zum Erstellen eines Artikel

Responses
chevron-right
200

OK

*/*
post
/erp/articles
200

OK

Find all existing article-taxes

get
Path parameters
idinteger · int64Required

ID of Article

Responses
chevron-right
200

successful operation

*/*
get
/erp/articles/{id}/taxes

Create new ProductTax

post
Path parameters
idinteger · int64Required

ID of Article

Body

steuerzuordnung eines artikels

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

countryCodestringRequired

the country, this entry is valid for

validFromstring · dateRequired

the date, this entry is valid from

articleIdinteger · int64Read-onlyOptional

the date, this entry is valid from

Responses
chevron-right
200

successful operation

*/*
post
/erp/articles/{id}/taxes

Prüft, ob eine Resource gesperrt ist

get
Path parameters
idinteger · int64Required

ID einer Resource

Responses
chevron-right
200

OK

*/*
get
/erp/articles/{id}/leasable-lock
200

OK

Erstellt eine neue Sperre, optional mit einer Gültigkeitsdauer

post
Path parameters
idinteger · int64Required

ID der zu sperrenden Resource

Query parameters
leasePeriodinteger · int64Optional

Optionale Lease-Dauer in Sekunden

Responses
chevron-right
200

OK

*/*
post
/erp/articles/{id}/leasable-lock
200

OK

post
Path parameters
idinteger · int64Required

an article id

Query parameters
languageCodestringOptional
Body

Komponente eines Produktionsartikels

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

quantitynumberRequired

Menge

namestring · max: 255Optional

Bezeichnung

descriptionstring · max: 2147483647Optional

Beschreibung

forSerialInheritancebooleanOptional

Basis für die Vererbung der Seriennummer

Default: false
sortOrderinteger · int32Optional

Sortierreihenfolge

activebooleanRead-onlyOptional

Aktiv?

Default: true
Responses
chevron-right
200

OK

*/*
post
/erp/articles/{id}/fabrication-components
200

OK

get
Path parameters
idinteger · int64Required

an article id

Query parameters
languageCodestringOptional
Responses
chevron-right
200

OK

*/*
get
/erp/articles/{id}/components
200

OK

post
Path parameters
idinteger · int64Required

an article id

Query parameters
languageCodestringOptional
Body

Komponenten eines Baugruppen- oder Jumbo-Artikels

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

containerArticleIdinteger · int64Required

Baugruppen- oder Jumbo-Artikel

componentArticleIdinteger · int64Required

Artikel dieser Komponente

numberstringOptional

Artikelnummer der Komponente

namestringOptional

Name der Komponente

descriptionstringOptional

Beschreibung der Komponente

quantitynumberOptional

Menge der Komponente

positioninteger · int32Optional

Position der Komponente innerhalb des Containers

salesPricenumberOptional

Verkaufspreis der Komponente

purchasePricenumberOptional

Einkaufspreis (DEK) der Komponente

grossWeightnumberOptional

Brutto-Gewicht der Komponente

netWeightnumberOptional

Netto-Gewicht der Komponente

stockAmountnumberOptional

Bestand der Komponente

stockAvailablenumberOptional

verfügbare Menge der Komponente

Responses
chevron-right
200

OK

*/*
post
/erp/articles/{id}/components
200

OK

get
Path parameters
articleIdinteger · int64Required

an article id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

allSalesChannelsbooleanOptional

sollen alle SalesChannel gelesen werden, auch die die kein listing haben

Default: false
Responses
chevron-right
200

OK

*/*
get
/erp/articles/{articleId}/listings
200

OK

post
Path parameters
articleIdinteger · int64Required

an article id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

sellableWithoutStockbooleanOptional

is this product sellable without any quantity at the stock

Default: false
listedbooleanOptional

soll der Artikel gelistet werden

Default: true
listingStatestring · enumRead-onlyOptional

Synchronisationsstatus eines Listings

Possible values:
listingStateChangeTimestring · date-timeRead-onlyOptional

die letzte aktualisierung des listingStates

customobjectOptional

Search-Dialog

proposedLowestPriceNetnumberRead-onlyOptional

Niedrigster Netto-Preis der letzten 30 Tage (vom System ermittelt)

proposedLowestPriceGrossnumberRead-onlyOptional

Niedrigster Brutto-Preis der letzten 30 Tage (vom System ermittelt)

customLowestPriceNetnumberOptional

Niedrigster Netto-Preis der letzten 30 Tage (benutzerdefinierte Eingabe)

customLowestPriceGrossnumberOptional

Niedrigster Brutto-Preis der letzten 30 Tage (benutzerdefinierte Eingabe)

Responses
chevron-right
200

OK

*/*
post
/erp/articles/{articleId}/listings
200

OK

Erstellt einen Etikettendruck-Stapel

post
Bodyobject[]

Anfrage Welche Artikel wie oft gedruckt werden soll

printbooleanOptional

Etikettendruck

Default: false
quantityinteger · int32Optional

Menge

Default: 1
Responses
chevron-right
200

OK

*/*
Responsestring · uuid
post
/erp/articles/print-labels
200

OK

Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
chevron-right
200

Workflow-Instanz gefunden

*/*
Responsestring · enum

Status einer Workflow-Instanz

Possible values:
get
/erp/articles/{refId}/workflow-state

Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
chevron-right
200

Workflow-Instanz gefunden

*/*
get
/erp/articles/{refId}/workflow-instances-preset
200

Workflow-Instanz gefunden

Liefert die neuste Workflow-Instanz zu der gegebenen Referenz

get
Path parameters
refIdinteger · int64Required
Responses
chevron-right
200

Workflow-Instanz gefunden

*/*
get
/erp/articles/{refId}/latest-workflow-instance

find all active ui hints of one article

get
Path parameters
idinteger · int64Required
Responses
chevron-right
200

successful operation

*/*
Responsestring[]
get
/erp/articles/{id}/ui-hints
get
Path parameters
idinteger · int64Required

an article id

Responses
chevron-right
200

OK

*/*
get
/erp/articles/{id}/products
200

OK

get
Responses
chevron-right
200

OK

*/*
get
/erp/articles/variables
200

OK

Erstellt entweder eine Etikettendruck-Vorschau zu einem Beleg oder einem Artikel

get
Query parameters
documentIdinteger · int64Optional

Beleg

articleIdinteger · int64Optional

Artikel

Responses
chevron-right
200

OK

*/*
get
/erp/articles/print-labels/candidates
200

OK

delete
Path parameters
idinteger · int64Required

an article id

listingIdinteger · int64Required

a listing id

Query parameters
languageCodestringOptional

Gewünschte Sprache (z.B. de)

Responses
chevron-right
200

OK

*/*
delete
/erp/articles/{id}/listings/{listingId}
200

OK

Last updated

Was this helpful?