Create a new product variant

Create a new shop product variant

Rate Limit: 300 Max attempts within 1 minute.

Path Parameters

Parameter	Details
productIdentifier required	string Examples: ^[1-9][0-9]$ ^key%3D[a-zA-Z0-9-_%\+\. ]$

Query Parameters

Parameter	Details
updateIfExists	boolean
with	Array of strings string Enum: attributes customData prices relatedVariants stocks
ignoreAttributeLocks	boolean

Request body

required

Parameter	Details
id readonly	integer
referenceKey required	string Example: M0001-black-M
merchantReferenceKeys required	string
ean MaxLength: 55	string Example: 0000007619991
attributes	object Example: [ { "name": "size", "type": "simple", "value": "M", "isLocked": false } ] name string type string Enum: simple simpleList localizedString localizedStringList advanced advancedList value shopCountrySpecific array object
prices	object price integer Example: 9999 oldPrice integer nullable Example: 10999 recommendedRetailPrice integer nullable Example: 9999 buyingPrice integer nullable Example: 9999 tax number Format: double Example: 19 countryCode string Example: DE currencyCode string Example: EUR groupKey string nullable Example: myPriceGroup promotionKey string nullable Pattern: ^[a-zA-Z0-9-_]+$ Example: myPromotion validFrom string nullable Format: date-time Example: 2021-09-23T11%3A30%3A58%2B00%3A00 validTo string nullable Format: date-time Example: 2021-09-24T11%3A30%3A58%2B00%3A00 merchantReferenceKey string unitPrice object
stocks	object quantity integer Example: 27 warehouseReferenceKey string MinLength: 1 Example: DefaultWarehouse changedAt string Format: date-time Example: 2020-07-23T11%3A30%3A58%2B00%3A00 sellableWithoutStock boolean Example: true merchantReferenceKey string expectedAvailabilityAt string nullable Format: date Example: 2020-07-23
customData nullable	object MinProps: 1
isComposite readonly	boolean
relatedVariants	object variantReferenceKey string Pattern: ^[a-zA-Z0-9-_\. ]*$ Example: M0001-black-M isMainVariant boolean

Responses

200

Product variant was successfully updated. This status code is returned when `updateIfExists=true` and a variant with the given reference key exists.

application/json

Success

integer

referenceKeyrequired

string

Example:

M0001-black-M

merchantReferenceKeysrequired

Array of string

ean

string

Example:

0000007619991

Array of object

null

isComposite

boolean

Array of object

201

Product variant was successfully created.

application/json

Success

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

404

Not Found

application/json

Error

POST/products/{productIdentifier}/variants

Request samples

Response samples

200

Complete Variant:

Content type: application/json

Minimal Variant:

Content type: application/json