Update composite products

Update an existing composite product

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
with	Array of strings string Enum: attributes images variants variants.attributes variants.prices variants.stocks variants.customData variants.relatedVariants productSortings customData sellableTimeframes
ignoreAttributeLocks	boolean
ignoreCategoryLocks	boolean
ignoreMasterIfExist	boolean

Request body

required

Parameter	Details
id readonly	integer
problems	string Example: system: product has no image
referenceKey	string Example: M0001-black
name MinProps: 1	object Example: { "de_DE": "Blaues Hemd", "en_GB": "Blue Shirt" }
master required	object referenceKey string Example: M0001 attributes array object categories object
state	string Enum: live draft problem new inApproval blocked Default: live Example: live
attributes	object Example: [ { "name": "color", "type": "localizedStringList", "value": [ { "de_DE": "blau", "en_GB": "blue" }, { "de_DE": "schwarz", "en_GB": "black" } ], "isLocked": true } ] name string type string Enum: simple simpleList localizedString localizedStringList advanced advancedList value shopCountrySpecific array object
variants	object referenceKey string Pattern: ^[a-zA-Z0-9-_\. ]$ Example: M0001-black-M ean string MaxLength: 55 Example: 0000007619991 attributes array Example: [ { "name": "size", "type": "simple", "value": "M", "isLocked": false } ] object prices array object stocks array object customData nullable object MinProps: 1 relatedVariants array object referenceKey string required Pattern: ^[a-zA-Z0-9-_\. ]$ Example: M0001-black-M ean string MaxLength: 55 Example: 0000007619991 attributes array Example: [ { "name": "size", "type": "simple", "value": "M", "isLocked": false } ] object prices array object stocks array object customData nullable object MinProps: 1 relatedVariants required MinItems: 2
images	object referenceKey string Pattern: ^[a-zA-Z0-9-_\. ]*$ Example: my_original_name.jpg name string Example: image.jpg position integer Example: 3 assetUrl string Example: images/my_image.jpg attributes array Example: [ { "name": "view", "type": "simple", "value": "front", "isLocked": true } ] object source object
productSortings	object productId integer writeonly Example: 1 productReferenceKey string writeonly MinLength: 1 Example: M0001-red shopKey string Example: ms countryCode string MinLength: 2 MaxLength: 2 Example: DE sortKey string Example: default-ms sortValue integer Example: 1
customData nullable	object MinProps: 1
sellableTimeframes	object productId integer Example: 12345 shopKey string Example: ay countryCode string MinLength: 2 MaxLength: 2 Example: de sellableFrom string nullable Format: date-time Example: 2025-01-01T00:00:00Z sellableTo string nullable Format: date-time Example: 2025-12-31T23:59:59Z
isComposite readonly	boolean
merchantReferenceKeys	string

Responses

200

Product was successfully updated.

application/json

Success

integer

problems

Array of string

referenceKeyrequired

string

Example:

M0001-black

required

object

Example:

{
  "de_DE": "Blaues Hemd",
  "en_GB": "Blue Shirt"
}

required

object

staterequired

string

Example:

live

Array of object

Example:

[
  {
    "name": "color",
    "type": "localizedStringList",
    "value": [
      {
        "de_DE": "blau",
        "en_GB": "blue"
      },
      {
        "de_DE": "schwarz",
        "en_GB": "black"
      }
    ],
    "isLocked": true
  }
]

Array of object

null

Array of object

isCompositerequired

boolean

merchantReferenceKeys

Array of string

400

Bad Request

application/json

Error

401

Unauthorized

application/json

Error

404

Not Found

application/json

Error

409

Conflict error

application/json

Error

503

Service unavailable error

application/json

Error

PUT/products/composite/{productIdentifier}

Request samples

Response samples

200

Complete Product:

Content type: application/json

Minimal Draft Product:

Content type: application/json