Skip to main content
POST
Create Item

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

Request parameters

Creates a new regular item with all specified properties. This command enables complete configuration of an item including identifiers, descriptions, prices, and measurements. - Request

categories
object
required

Category assignments of the item. Defines all categories to which the item should be assigned for better organization and navigation.

identifiers
object
required

Identifiers of the item with all relevant markings and numbers for unique identification of the item in various systems.

descriptions
object
required

Descriptions of the item in different languages and for different platforms/sales channels. Includes names, short and long descriptions as well as SEO-relevant information.

productGroupId
string<uuid>

The ID of the product group to which the item should be assigned. Product groups serve for categorical classification of items for reports and analyses.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

shippingClassId
string<uuid>

The ID of the shipping class to which the item should be assigned.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

manufacturerId
string<uuid>

The ID of the manufacturer to which the item should be assigned.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

prices
object

Price structures of the item for different sales channels, customer groups and individual customers. Includes sales prices, purchase prices and tier prices.

suppliers
object

Suppliers associated with the item including supplier-specific information such as purchase prices, delivery times and order intervals.

measurements
object

Physical dimensions and weight specifications of the item for storage, shipping and product presentation. Important for shipping cost calculations and storage space optimization.

customFields
object

Custom fields defined for the item to store additional information. Useful for special requirements or integrations.

variations
object

Variations of an item

features
object

Features of an item

attributes
object

Attributes of an item

unitPricing
object

UnitPricing information of an item

specialPrices
object

SpecialPrices information of an item

crosssellingGroups
object

CrosssellingGroups of an item

images
object

Images of the item. Not processed by this operation - assign images with PATCH /v2/items/{itemId} once the item exists.

storageConstraints
object

ItemStorageConstraints information of an item

salesChannels
object[]

A list of sales channels that should be activated after a successful creation of the item. Omitting the property, sending an empty list and sending null all activate no sales channel. A sales channel that does not resolve to an activatable sales channel is rejected before the item is created, so no item is left behind. A sales channel that resolves but is incompatible with the item is skipped without an error. IncludeItemImages has no effect on this endpoint, because a newly created item has no images to copy.

Response

Item was successfully created

Creates a new regular item with all specified properties. This command enables complete configuration of an item including identifiers, descriptions, prices, and measurements. - Response

itemId
string<uuid>
required

Unique ID of the newly created item - this key is used for all further operations with the item.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"