🔒 Update product V3

patch

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

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: product:update.

Update a product. Only the fields the request carries are written, everything else keeps its value; a nullable field is cleared by passing null. Categories are written as a delta: an entry with an id assigns that category, an entry with deleted: true removes the assignment, and a category the list does not mention keeps its state. Custom fields work the same way per key. A number already used by another product is rejected with 409 Conflict. The response body carries the assigned categories and the custom fields, so they can be checked without a follow-up read.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Body Params

Fields to change on an existing product. Only the fields the request carries are written; everything else keeps its value. Where a field is nullable, null clears it.

name

string

length ≤ 255

Product name (primary language).

number

string

length ≤ 255

SKU / product number. Must not be in use by another product; a taken number is rejected with 409 Conflict. Sending the number the product already carries is accepted and changes nothing. Note: deleting a product releases its number for reuse, but the placeholder number DEL stays permanently taken once any product has been deleted.

project

object | null

Project the product belongs to. Pass null to remove the project assignment, which makes the product visible regardless of project access.

description

string | null

Product description (primary language).

ean

string | null

European Article Number.

unit

string | null

Unit of measure.

customsTariffNumber

string | null

Customs tariff number.

internalComment

string | null

Internal comment (not shown to customers).

countryOfOrigin

string | null

^[A-Z]{2}$

Country of origin (ISO 3166-1 alpha-2).

regionOfOrigin

string | null

enum

German federal state of origin (two-digit code; 99 = foreign origin).

ageRating

string | null

Age rating (DHL identity check), e.g. 16 or 18.

minimumOrderQuantity

integer

≥ 0

Minimum order quantity.

minimumStockLevel

integer

≥ 0

Minimum stock level.

taxRate

string

enum

VAT rate tier applied to the product.

Allowed:

serialNumberTracking

string

enum

Serial-number tracking mode.

Allowed:

disabledReason

string | null

Reason/message for the internal block.

isStockItem

boolean

Whether the product is stock-managed.

isDisabled

boolean

Whether the product is internally blocked (disabled).

hasBatches

boolean

Whether batch/charge management is active.

hasBestBeforeDate

boolean

Whether best-before-date tracking is active.

hasBillOfMaterials

boolean

Whether the product has a bill of materials.

isAssembledJustInTime

boolean

Whether the BOM is assembled just-in-time.

isProductionProduct

boolean

Whether the product is produced in-house.

isExternallyProduced

boolean

Whether the product is produced externally.

isShippingCostsProduct

boolean

Whether the product represents shipping costs.

isMatrixProduct

boolean

Whether the product is a matrix (variant parent) product.

isStockTakingDisabled

boolean

Whether stock-taking is disabled for the product.

allowPurchaseFromAllSuppliers

boolean

Whether purchasing from all suppliers is allowed.

printSettings

object

Document print settings applied when the product appears on a document.

manufacturer

string | null

Manufacturer name.

manufacturerProductNumber

string | null

Product number assigned by the manufacturer.

manufacturerUrl

string | null

Manufacturer URL.

measurements

object

Physical measurements.

isDiscountProduct

boolean

Whether the product is a discount product.

discountPercentage

number

≥ 0

Discount percentage.

stockTaking

object

Stock-taking valuation.

calculatedPurchasePrice

object

Calculated purchase price.

calculatoryPurchasePriceSettings

object

Calculatory purchase-price recalculation configuration.

salesChannelDefaults

object

Default sales-channel settings, applied in every sales channel that does not use individual settings.

merchandiseGroup

object | null

Merchandise group of the product, used for account mapping and number ranges. Pass null to remove the assignment.

defaultSupplier

object | null

Default supplier address. Pass null to remove the assignment.

variantOf

object | null

Parent product this product is a variant of. Pass null to detach the product from its parent, which also removes the option values that made it a variant.

400Failed validation

409Problem occurred

429Too Many Requests