Product

Manage product data in the VARIO Cloud API, including product settings, bundles, variants, suppliers, customers, copying and unit price conversion.

Artikel kopieren

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bundlebooleanOptional

Handelt es sich um ein Gebinde?

Default: false

typestring · enumOptional

Artikelarten

Possible values:

serialTypestring · enumOptional

Serientyp eines Artikels

Possible values:

expiryDateTypestring · enumOptional

Art des Haltbarkeitsdatums bei Serienartikeln

Possible values:

minimumRemainingDaysBeforeExpiryDateOnGoodsReceiptinteger · int32Optional

Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss

minimumRemainingDaysBeforeExpiryDateForGoodsIssuedinteger · int32Optional

Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss

warrantyInMonthsinteger · int32Optional

Garantie in Monaten

lotOnlyRequiredWhenBookedToSalesStoragebooleanOptional

Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)

Default: false

serialNumberLabelingTypestring · enumOptional

Seriennummer Auszeichnungsart

Possible values:

fabricationSerialNumberLabelingTypestring · enumOptional

Produktions-S/N-Auszeichnungsart

Possible values:

customsTariffNumberstring · max: 15Optional

Zolltarifnummer

useSerialSequencerConfigurationbooleanOptional

Soll ein eigener Zählerkreis für Seriennummern verwendet werden?

Responses

200

successful operation

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bundlebooleanOptional

Handelt es sich um ein Gebinde?

Default: false

typestring · enumOptional

Artikelarten

Possible values:

serialTypestring · enumOptional

Serientyp eines Artikels

Possible values:

expiryDateTypestring · enumOptional

Art des Haltbarkeitsdatums bei Serienartikeln

Possible values:

minimumRemainingDaysBeforeExpiryDateOnGoodsReceiptinteger · int32Optional

Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss

minimumRemainingDaysBeforeExpiryDateForGoodsIssuedinteger · int32Optional

Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss

warrantyInMonthsinteger · int32Optional

Garantie in Monaten

lotOnlyRequiredWhenBookedToSalesStoragebooleanOptional

Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)

Default: false

serialNumberLabelingTypestring · enumOptional

Seriennummer Auszeichnungsart

Possible values:

fabricationSerialNumberLabelingTypestring · enumOptional

Produktions-S/N-Auszeichnungsart

Possible values:

customsTariffNumberstring · max: 15Optional

Zolltarifnummer

useSerialSequencerConfigurationbooleanOptional

Soll ein eigener Zählerkreis für Seriennummern verwendet werden?

404

Resource was not found

*/*

422

Resource was not valid to process

*/*

put/erp/products/{id}

PUT /erp/products/{id} HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 1121

{
  "version": "text",
  "info": {},
  "id": "text",
  "bundle": false,
  "bundleSchemaRef": {
    "id": "text"
  },
  "type": "WITH_STOCK",
  "availabilityDetermination": {
    "inStock": "IGNORE",
    "reserved": "IGNORE",
    "ordered": "IGNORE",
    "inPicking": "IGNORE",
    "reporting": "IGNORE"
  },
  "serialType": "NONE",
  "expiryDateType": "NONE",
  "minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt": 1,
  "minimumRemainingDaysBeforeExpiryDateForGoodsIssued": 1,
  "warrantyInMonths": 1,
  "lotOnlyRequiredWhenBookedToSalesStorage": false,
  "serialNumberLabelingType": "MANUAL",
  "fabricationSerialNumberLabelingType": "QUERY_ON_START",
  "customsTariffNumber": "text",
  "countryOfOrigin": {
    "id": 1,
    "isoAlpha2": "text",
    "isoAlpha3": "text"
  },
  "regionOfOrigin": {
    "id": "text"
  },
  "useSerialSequencerConfiguration": true,
  "serialSequencerConfiguration": {
    "version": "text",
    "info": {},
    "id": "text",
    "configurationDetail": {
      "type": "NON_POOLED_SEQUENCES",
      "assignmentMode": "MANUAL",
      "length": 1,
      "padChar": "text",
      "expression": "text",
      "postExpression": "text",
      "initialValue": 1,
      "numberUnique": true
    },
    "alternativeConfiguration": {
      "id": "text"
    },
    "active": true
  },
  "variantValues": [],
  "variantSchemaRef": {
    "id": "text"
  },
  "mainVariantProductRef": {
    "id": "text"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bundle": false,
  "bundleSchemaRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "type": "WITH_STOCK",
  "articleRefs": [],
  "availabilityDetermination": {
    "inStock": "IGNORE",
    "reserved": "IGNORE",
    "ordered": "IGNORE",
    "inPicking": "IGNORE",
    "reporting": "IGNORE"
  },
  "serialType": "NONE",
  "expiryDateType": "NONE",
  "minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt": 1,
  "minimumRemainingDaysBeforeExpiryDateForGoodsIssued": 1,
  "warrantyInMonths": 1,
  "lotOnlyRequiredWhenBookedToSalesStorage": false,
  "serialNumberLabelingType": "MANUAL",
  "fabricationSerialNumberLabelingType": "QUERY_ON_START",
  "customsTariffNumber": "text",
  "countryOfOrigin": {
    "id": 1,
    "isoAlpha2": "text",
    "isoAlpha3": "text",
    "label": "text"
  },
  "regionOfOrigin": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "useSerialSequencerConfiguration": true,
  "serialSequencerConfiguration": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "configurationGroup": "text",
    "configurationDetail": {
      "type": "NON_POOLED_SEQUENCES",
      "assignmentMode": "MANUAL",
      "length": 1,
      "padChar": "text",
      "expression": "text",
      "postExpression": "text",
      "initialValue": 1,
      "numberUnique": true
    },
    "alternativeConfiguration": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true
  },
  "variantValues": [],
  "variantSchemaRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "mainVariantProductRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

*/*

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

*/*

409

unable to delete Resource, due to constraints, existing references or internal state

*/*

delete/erp/products/{id}

DELETE /erp/products/{id} HTTP/1.1
Host: api.example.com
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

post

Path parameters

idinteger · int64Required

a product id

Body

productTypestring · enumOptional

Artikelarten

Possible values:

Responses

200

OK

*/*

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

bundlebooleanOptional

Handelt es sich um ein Gebinde?

Default: false

typestring · enumOptional

Artikelarten

Possible values:

serialTypestring · enumOptional

Serientyp eines Artikels

Possible values:

expiryDateTypestring · enumOptional

Art des Haltbarkeitsdatums bei Serienartikeln

Possible values:

minimumRemainingDaysBeforeExpiryDateOnGoodsReceiptinteger · int32Optional

Mindestrestlaufzeit Eingang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel bei der Einbuchung in ein Verkaufslager noch aufweisen muss

minimumRemainingDaysBeforeExpiryDateForGoodsIssuedinteger · int32Optional

Mindestrestlaufzeit Ausgang (Tage): Minimale Restlaufzeit in Tagen, die ein Artikel beim Verkauf noch aufweisen muss

warrantyInMonthsinteger · int32Optional

Garantie in Monaten

lotOnlyRequiredWhenBookedToSalesStoragebooleanOptional

Charge muss bei Einbuchung in ein Verkaufslager vergeben werden (für Serientyp LOT und BEST_BEFORE)

Default: false

serialNumberLabelingTypestring · enumOptional

Seriennummer Auszeichnungsart

Possible values:

fabricationSerialNumberLabelingTypestring · enumOptional

Produktions-S/N-Auszeichnungsart

Possible values:

customsTariffNumberstring · max: 15Optional

Zolltarifnummer

useSerialSequencerConfigurationbooleanOptional

Soll ein eigener Zählerkreis für Seriennummern verwendet werden?

post/erp/products/{id}/copy

POST /erp/products/{id}/copy HTTP/1.1
Host: api.example.com
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "modules": [
    "CUSTOM"
  ],
  "copyEntries": [],
  "productType": "WITH_STOCK"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "bundle": false,
  "bundleSchemaRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "type": "WITH_STOCK",
  "articleRefs": [],
  "availabilityDetermination": {
    "inStock": "IGNORE",
    "reserved": "IGNORE",
    "ordered": "IGNORE",
    "inPicking": "IGNORE",
    "reporting": "IGNORE"
  },
  "serialType": "NONE",
  "expiryDateType": "NONE",
  "minimumRemainingDaysBeforeExpiryDateOnGoodsReceipt": 1,
  "minimumRemainingDaysBeforeExpiryDateForGoodsIssued": 1,
  "warrantyInMonths": 1,
  "lotOnlyRequiredWhenBookedToSalesStorage": false,
  "serialNumberLabelingType": "MANUAL",
  "fabricationSerialNumberLabelingType": "QUERY_ON_START",
  "customsTariffNumber": "text",
  "countryOfOrigin": {
    "id": 1,
    "isoAlpha2": "text",
    "isoAlpha3": "text",
    "label": "text"
  },
  "regionOfOrigin": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "useSerialSequencerConfiguration": true,
  "serialSequencerConfiguration": {
    "version": "text",
    "info": {
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdFrom": "text",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "key": "text",
    "configurationGroup": "text",
    "configurationDetail": {
      "type": "NON_POOLED_SEQUENCES",
      "assignmentMode": "MANUAL",
      "length": 1,
      "padChar": "text",
      "expression": "text",
      "postExpression": "text",
      "initialValue": 1,
      "numberUnique": true
    },
    "alternativeConfiguration": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "active": true
  },
  "variantValues": [],
  "variantSchemaRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "mainVariantProductRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Für Gebinde: Alle Lieferanten zu Artikeln des Gebindes

get

Path parameters

idinteger · int64Required

a product id

Responses

200

OK

*/*

Article-Supplier-Relation

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

articleIdstringRequired

Referenced Article

articleNamestringOptional

Referenced Article name

accountIdstringRequired

Referenced Supplier-Account

articleNumberstringRead-onlyOptional

Artikelnummer

accountDisplayNamestringRead-onlyOptional

Anzeigename des Accounts

activebooleanRequired

Aktiv?

Default: true

supplierArticleNumberstringOptional

Abweichende Produktnummer

supplierArticleNamestringOptional

Abweichende Produktbezeichnung

supplierArticleDescriptionstringOptional

Abweichende Produktbeschreibung

supplierArticleIdentifierstringOptional

Abweichender Produktidentifer (z.B. Barcode)

useSupplierArticleNumberbooleanOptional

Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)

Default: false

useSupplierArticleNamebooleanOptional

Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)

Default: false

useSupplierArticleDescriptionbooleanOptional

Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)

Default: false

useSupplierArticleIdentifierbooleanOptional

Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)

Default: false

purchaseUnitnumberOptional

Einkaufseinheit

packagingUnitnumberOptional

Verpackungseinheit

deliveryTimeinteger · int32Optional

Lieferzeit in (Werk-)Tagen

minimumOrderQuantitynumberOptional

Mindestbestellmenge

supplierReportingStocknumberOptional

Lieferanten-Meldebestand

mainSupplierbooleanOptional

Hauptlieferant

Default: false

defaultNetPricenumberOptional

Standardpreis Netto

defaultGrossPricenumberOptional

Standardpreis Brutto

orderOnComponentBasebooleanOptional

Sollen Baugruppen auf Komponenten-Basis bestellt werden?)

Default: true

dropShippingAllowedbooleanOptional

Kennzeichen, ob Streckengeschäft erlaubt

get/erp/products/{id}/suppliers

GET /erp/products/{id}/suppliers HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

[]

Für Gebinde: Alle Kunden zu Artikeln des Gebindes

get

Path parameters

idinteger · int64Required

a product id

Responses

200

OK

*/*

Article-Customer-Relation

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

articleIdinteger · int64Required

Referenced Article

articleNamestringOptional

Referenced Article name

accountIdinteger · int64Required

Referenced Customer-Account

articleNumberstringRead-onlyOptional

Artikelnummer

accountDisplayNamestringRead-onlyOptional

Anzeigename des Accounts

activebooleanOptional

Aktiv?

deviatingArticleNumberstringOptional

Abweichende Produktnummer

deviatingArticleNamestringOptional

Abweichende Produktbezeichnung

deviatingArticleDescriptionstringOptional

Abweichende Produktbeschreibung

deviatingArticleIdentifierstringOptional

Abweichender Produktidentifer (z.B. Barcode)

useDeviatingArticleNumberbooleanOptional

Soll die abweichende Produktnummer verwendet werden (z.B. in Belegen)

useDeviatingArticleNamebooleanOptional

Soll die abweichende Produktbezeichnung verwendet werden (z.B. in Belegen)

useDeviatingArticleDescriptionbooleanOptional

Soll die abweichende Produktbeschreibung verwendet werden (z.B. in Belegen)

useDeviatingArticleIdentifierbooleanOptional

Soll der abweichende Produktidentifier verwendet werden (z.B. in einer Scanner-Erfassung)

lockedForCustomerbooleanOptional

Ist das Produkt für den Kunden gesperrt?

defaultNetPricenumberOptional

Standardpreis Netto

defaultGrossPricenumberOptional

Standardpreis Brutto

priceDeterminationstring · enumOptional

Art der Preisermittlung

Default: DEFAULTPossible values:

get/erp/products/{id}/customers

GET /erp/products/{id}/customers HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

[]

get

Path parameters

idinteger · int64Required

ID des Produkts

Query parameters

priceUnitTypeIdstringRequired

Id der Mengeneinheit für den der Preis gilt

convertToUnitTypeIdstringRequired

Id der Mengeneinheit für den der Preis umgerechnet werden soll

pricestringRequired

Preis

Responses

200

OK

*/*

numberOptional

get/erp/products/{id}/convertPriceForGivenUnitTypeForAnotherUnitType

GET /erp/products/{id}/convertPriceForGivenUnitTypeForAnotherUnitType?priceUnitTypeId=text&convertToUnitTypeId=text&price=text HTTP/1.1
Host: api.example.com
Accept: */*

200

OK

1