Update product v2

patch

https://{xentralId}.xentral.biz/api/v2/products/{id}

Updates details of a single product

Path Params

string

required

The resource's identifier.

Body Params

Product update request payload

name

string

Name of the product.

number

string

Number / SKU of the product.

project

object

Reference to another resource

description

string | null

Description of the product.

internalComment

string | null

Text only for internal information.

shortDescription

string | null

Short description of the product.

customsTariffNumber

string | null

Customs tariff number of the product.

ean

string | null

EAN of the product

minimumOrderQuantity

number

Numerical minimum order quantity of the product.

minimumStorageQuantity

number

Numerical minimum storage quantity of the product.

allowPurchaseFromAllSuppliers

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

hasBatches

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

serialNumbersMode

string

enum

4 different modes available if the product has serial numbers or not and how they are handled. For more information about the different modes have a look into our handbook.

Allowed:

hasBestBeforeDate

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

hasBillOfMaterials

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

isAssembledJustInTime

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

isProductionProduct

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

isExternallyProduced

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

isDisabled

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

disabledReason

string | null

Shows the reason why the product is locked when clicking into the product.

hidePriceOnDocuments

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

ageRating

string | null

enum

Sets an age rating for the product. Currently only used for the shipping service provider DHL.

Allowed:

countryOfOrigin

string | null

Two-digit ISO country code for country of origin of the product.

regionOfOrigin

string | null

enum

01 - Schleswig-Holstein, 02 - Hamburg, 03 - Niedersachsen, 04 - Bremen, 05 - Nordhrein-Westfalen, 06 - Hessen, 07 - Rheinland-Pfalz, 08 - Baden-Württemberg, 09 - Bayern, 10 - Saarland, 11 - Berlin, 12 - Brandenburg, 13 - Mecklenburg-Vorpommern, 14 - Sachsen, 15 - Sachsen-Anhalt, 16 - Thüringen, 99 - foreign origin

unit

string | null

Name of the unit.

measurements

object

manufacturer

object

isStockItem

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

isStockTakingDisabled

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

hideJustInTimeItemsOnDocuments

Loose boolean type which accepts boolean, number 0 or 1 and string 'true' or 'false'

salesTax

string

enum

Selection of three possible values for the sales tax of the product.

Allowed:

isShippingCostsProduct

boolean

Determines if a product is used as a shipping costs product. For more information have a look into our handbook.

isMatrixProduct

boolean

Determines if a product is a matrix product. For more information have a look into our handbook.

discount

object

stockTaking

object

Contains settings for stock taking.

calculatedPurchasePrice

object

Contains settings for the calculated purchase price.

calculatoryPurchasePriceSettings

object

Contains settings for the calculatory purchase price triggers.

salesChannel

object

General sales channel information that is valid for all sales channels, if not overridden by individual sales channel information.

merchandiseGroup

object

Reference to another resource

400IETF RFC 9457 Problem API compliant response

401Unable to authenticate the client

409Request conflict with the current state of the target resource