🔒 Create product V3

post

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

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:create.

Create a product. If number is omitted, the next number is drawn from the merchandise group's number range, falling back to the general product number range, scoped by the project. An explicitly requested number that is already in use is rejected with 409 Conflict.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Data for creating a new product.

name

string

required

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. If omitted, the next number is drawn from the merchandise group's number range, falling back to the general product number range, scoped by the project. 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

required

Project the product belongs to.

description

string

Product description (primary language).

ean

string

length ≤ 1024

European Article Number.

unit

string

length ≤ 255

Unit of measure.

customsTariffNumber

string

length ≤ 64

Customs tariff number.

internalComment

string

Internal comment (not shown to customers).

countryOfOrigin

string

length ≤ 2

^[A-Z]{2}$

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

regionOfOrigin

string

enum

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

ageRating

string

length ≤ 3

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. Defaults to standard.

Allowed:

serialNumberTracking

string

enum

Serial-number tracking mode. Defaults to none.

Allowed:

disabledReason

string

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

length ≤ 255

Manufacturer name.

manufacturerProductNumber

string

length ≤ 255

Product number assigned by the manufacturer.

manufacturerUrl

string

length ≤ 255

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.

merchandiseGroup

object

Merchandise group of the product, used for account mapping and number ranges.

defaultSupplier

object

Default supplier address.

variantOf

object | null

Parent product this product is a variant of. Omit the field or pass null to create a regular (non-variant) product.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Create a product. If number is omitted, the next number is drawn from the merchandise group's number range, falling back to the general product number range, scoped by the project. An explicitly requested number that is already in use is rejected with 409 Conflict.

400Failed validation

409Problem occurred

429Too Many Requests