Create product V2

post

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

Creates a new product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Product create request payload

name

string

required

Name of the product.

number

string

Number / SKU of the product.

description

string

Description of the product.

shortDescription

string

Short description of the product.

customsTariffNumber

string

Customs tariff number of the product.

ean

string

EAN of the product.

internalComment

string

Text only for internal information.

project

object

required

Reference to another resource

tags

minimumOrderQuantity

integer

Numerical minimum order quantity of the product.

minimumStorageQuantity

integer

Numerical minimum storage quantity of the product.

allowPurchaseFromAllSuppliers

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

hidePriceOnDocuments

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

manufacturer

object

unit

string

Name of the unit.

measurements

object

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.

ageRating

string

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

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

salesTax

string

enum

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

Allowed:

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'

merchandiseGroup

object

Reference to another resource

standardSupplier

object | null

Reference to a standard supplier for this product

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.

freeFields

array of objects | null

freeFields

variantOf

object | null

Reference to a parent product

options

array of objects

options

variants

array of objects

variants

201Resource successfully created response

400IETF RFC 9457 Problem API compliant response

401Unable to authenticate the client

409Request conflict with the current state of the target resource