Create new product V1

post deprecated

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

Creates a new product.

Warning: Multiple request body content types

Due to technical limitations, the information provided here may not display all available request body content types. We are currently working with our third-party documentation provider to address this issue. For a complete and accurate representation of the available content types, we recommend referring to the full OpenAPI specification.

We apologize for any inconvenience caused and appreciate your understanding as we work to resolve this matter.

Available request content types:

application/json
application/vnd.xentral.upsert+json

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Product create request payload

name

string

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

Reference to another resource

tags

array of objects

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

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'

shopPriceDisplay

string | null

Only used by some online shops. For more information have a look into our handbook.

category

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.

freeFields

array of objects | null

freeFields

variantOf

object | null

Reference to a parent product

options

array of objects

options

variants

array of objects

variants

Headers

accept

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

204

Operation completed successfully, no response body

403

Unable to authorize the client

415

Resource representation send in the request is not supported.

429

Too many API calls made.

Language

Credentials

Bearer

URL

Loading…

Response

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

text/html

application/problem+json

application/json