Skip to main content
PATCH
/
v2
/
itemdetails
/
change
Modifies an existing regular item with all specified properties. This command enables complete reconfiguration of an item including identifiers, descriptions, prices, measurements, and miscellaneous information.
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v2/itemdetails/change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "productGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shippingClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "manufacturerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "categories": {
    "categories": [
      {
        "categoryId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      }
    ]
  },
  "identifiers": {
    "sku": "<string>",
    "amazonFnsku": "<string>",
    "gtin": "<string>",
    "manufacturerNumber": "<string>",
    "isbn": "<string>",
    "tariccode": "<string>",
    "upc": "<string>",
    "unNumber": "<string>",
    "hazardNumber": "<string>",
    "ownIdentifier": "<string>",
    "defaultAsin": "<string>",
    "jfsku": "<string>"
  },
  "descriptions": {
    "defaultDescriptions": [
      {
        "languageIso": "<string>",
        "descriptionData": {
          "itemName": "<string>",
          "shortDescription": "<string>",
          "description": "<string>",
          "metaDescription": "<string>",
          "metaKeywords": "<string>",
          "titleTag": "<string>",
          "urlPath": "<string>"
        }
      }
    ],
    "salesChannelDescriptions": [
      {
        "salesChannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "languageIso": "<string>",
        "descriptionData": {
          "itemName": "<string>",
          "shortDescription": "<string>",
          "description": "<string>",
          "metaDescription": "<string>",
          "metaKeywords": "<string>",
          "titleTag": "<string>",
          "urlPath": "<string>"
        }
      }
    ],
    "platformDescriptions": [
      {
        "platformId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "languageIso": "<string>",
        "descriptionData": {
          "itemName": "<string>",
          "shortDescription": "<string>",
          "description": "<string>",
          "metaDescription": "<string>",
          "metaKeywords": "<string>",
          "titleTag": "<string>",
          "urlPath": "<string>"
        }
      }
    ]
  },
  "prices": {
    "ignoreDiscounts": true,
    "salesPriceNet": 123,
    "suggestedRetailPrice": 123,
    "purchasePriceNet": 123,
    "ebayPrice": 123,
    "amazonPrice": 123,
    "salesChannelPrices": [
      {
        "saleschannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "customerGroupPrices": [
          {
            "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "prices": [
              {
                "fromQuantity": 123,
                "netPrice": 123,
                "reduceStandardPriceByPercent": 123
              }
            ]
          }
        ],
        "isActive": true
      }
    ],
    "customerPrices": [
      {
        "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "prices": [
          {
            "fromQuantity": 123,
            "netPrice": 123,
            "reduceStandardPriceByPercent": 123
          }
        ]
      }
    ],
    "defaultPrices": [
      {
        "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "prices": [
          {
            "fromQuantity": 123,
            "netPrice": 123,
            "reduceStandardPriceByPercent": 123
          }
        ]
      }
    ]
  },
  "measurements": {
    "height": 123,
    "length": 123,
    "shippingWeight": 123,
    "weight": 123,
    "width": 123
  },
  "images": {
    "defaultImages": [
      {
        "blobIdentifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "sortNumber": 123,
        "isMainImage": true
      }
    ],
    "platformImages": [
      {
        "platformId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "images": [
          {
            "blobIdentifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sortNumber": 123,
            "isMainImage": true
          }
        ]
      }
    ],
    "saleschannelImages": [
      {
        "saleschannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "images": [
          {
            "blobIdentifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sortNumber": 123,
            "isMainImage": true
          }
        ]
      }
    ],
    "ebayImages": [
      {
        "ebayAccountId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "images": [
          {
            "blobIdentifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "sortNumber": 123,
            "isMainImage": true
          }
        ]
      }
    ]
  },
  "suppliers": {
    "defaultSupplier": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "defaultDropshippingSupplier": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "suppliers": [
      {
        "supplierId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "supplierItemName": "<string>",
        "supplierItemNumber": "<string>",
        "stockLevel": 123,
        "netPurchasePrice": 123,
        "minimumPurchaseQuantity": 123,
        "deliveryTimeInDays": 123,
        "isDropshippingActive": true,
        "packageUnitDescription": "<string>",
        "packageUnitQuantity": 123,
        "notes": "<string>",
        "vatRate": 123,
        "useSupplierDeliveryTime": true,
        "includeSupplierStock": true,
        "purchaseInterval": 123,
        "scalePrices": [
          {
            "fromQuantity": 123,
            "netPrice": 123,
            "usePercentageDiscount": true,
            "percentageDiscount": 123
          }
        ]
      }
    ]
  },
  "variations": {
    "variations": [
      {
        "variationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "position": 123,
        "descriptions": [
          {
            "languageIso": "<string>",
            "name": "<string>"
          }
        ],
        "values": [
          {
            "variationValueId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "itemNumber": "<string>",
            "gTIN": "<string>",
            "weightOffset": 123,
            "descriptions": [
              {
                "languageIso": "<string>",
                "name": "<string>"
              }
            ],
            "surcharges": {
              "defaultSurchargeNet": 123,
              "customerGroupSurcharges": [
                {
                  "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
                  "surcharge": 123,
                  "isActive": true
                }
              ],
              "salesChannelSurcharges": [
                {
                  "salesChannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
                  "surcharges": [
                    {
                      "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
                      "surcharge": 123,
                      "isActive": true
                    }
                  ]
                }
              ]
            },
            "position": 123,
            "image": "b45f6432-2462-4c6f-b00f-1d9d01000000"
          }
        ]
      }
    ]
  },
  "deliveryStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "includeInPriceList": true,
  "ignoreOrderSuggestions": true,
  "ignoreDiscounts": true,
  "countryOfOrigin": "<string>",
  "notes": "<string>",
  "features": {
    "features": [
      {
        "featureId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
      }
    ]
  },
  "attributes": {
    "values": [
      {
        "attributeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "defaultValues": [
          {
            "languageIso": "<string>",
            "value": "<string>"
          }
        ],
        "salesChannelValues": [
          {
            "salesChannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "values": [
              {
                "languageIso": "<string>",
                "value": "<string>"
              }
            ]
          }
        ]
      }
    ]
  },
  "unitPricing": {
    "salesUnitId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "packagingUnitId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "innerQuantity": 123,
    "innerQuantityUnitId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "isBasePriceDeclared": true,
    "basePriceReferenceUnitId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "basePriceReferenceAmount": 123
  },
  "specialPrices": {
    "isActive": true,
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "isEndDateActive": true,
    "minimumStockQuantity": 123,
    "isStockRestrictionActive": true,
    "salesChannelSpecialPrices": [
      {
        "salesChannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "specialPrices": [
          {
            "customerGroupId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
            "netPrice": 123,
            "isActive": true
          }
        ]
      }
    ]
  },
  "storageConstraints": {
    "allowNegativeStock": true,
    "itemPlatformNegativeStocks": [
      {
        "platformId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "isNegativeStockAllowed": true
      }
    ],
    "itemSalesChannelNegativeStocks": [
      {
        "salesChannelId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
        "isNegativeStockAllowed": true
      }
    ],
    "buffer": 123,
    "globalMinimumStockLevel": 123,
    "hasBatch": true,
    "isInventoryManagementActive": true,
    "isBestBeforeManaged": true,
    "isStockDivisible": true
  }
}
'

Authorizations

​
Authorization
string
header
required

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

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string
​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-companyid
string

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

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

Request parameters

Modifies an existing regular item with all specified properties. This command enables complete reconfiguration of an item including identifiers, descriptions, prices, measurements, and miscellaneous information. - Request

​
itemId
string<uuid>

Unique ID of the item to be modified - this key is used for all further operations with the item.

Example:

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

​
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"

​
categories
object

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

​
identifiers
object

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

​
descriptions
object

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.

​
prices
object

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

​
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.

​
images
object

tbd

​
customFields
object

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

​
suppliers
object

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

​
variations
object

Variations of an item

​
deliveryStatusId
string<uuid>

Delivery status id determining the availability display of the item (e.g. 'immediately available', '2-3 days'). Tab 'Sonstiges'.

Example:

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

​
includeInPriceList
boolean

Indicates whether the item can be included in exported price lists. Tab 'Sonstiges'.

​
ignoreOrderSuggestions
boolean

Indicates whether order suggestions should be ignored for this item. If true, the item will not appear in automatic order suggestions. Tab 'Sonstiges'.

​
ignoreDiscounts
boolean

Indicates whether the item is not eligible for discounts (Rabatte ignorieren / Nicht Rabattfähig). Tab 'Sonstiges'.

​
countryOfOrigin
string

Country of origin (Herkunftsland) - ISO code or country name. Max length 64. Tab 'Sonstiges'.

​
notes
string

Additional notes (Anmerkung) for the item - unlimited length. Tab 'Sonstiges'.

​
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

​
storageConstraints
object

ItemStorageConstraints information of an item

Response

200 - application/json

Item was successfully modified.