Skip to main content
PATCH
/
items
/
{itemId}
Update Item
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/items/{itemId} \
  --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 '
{
  "SKU": "ART2394871",
  "ManufacturerId": 123,
  "ResponsiblePersonId": 123,
  "Categories": [
    {
      "CategoryId": 123
    }
  ],
  "Name": "Interdimensional goggles",
  "Description": "These goggles are a must have product. Everyone needs them. Buy them.",
  "ShortDescription": "The best goggles anyone can buy",
  "Identifiers": {
    "Gtin": "8896982295860",
    "ManufacturerNumber": "75",
    "ISBN": "978-3-86680-192-9",
    "UPC": "889698229586",
    "AmazonFnsku": "FN813S88A43",
    "Asins": "B071GVGFQF",
    "OwnIdentifier": "P446853"
  },
  "Components": [
    {
      "ItemId": 123,
      "Quantity": 2,
      "SortNumber": 1
    }
  ],
  "ItemPriceData": {
    "SalesPriceNet": 125.21,
    "SuggestedRetailPrice": 159.99,
    "PurchasePriceNet": 99.73,
    "EbayPrice": 149.99,
    "AmazonPrice": 149.99
  },
  "ActiveSalesChannels": "",
  "SortNumber": 0,
  "Annotation": "Some additional internal info about the item",
  "ReleasedOnDate": "2023-01-15T13:00:00.0000000+00:00",
  "StorageOptions": {
    "GlobalMinimumStockLevel": 15,
    "Buffer": 5,
    "SerialNumberTracking": false,
    "ProcurementTime": 3,
    "DetermineProcurementTimeAutomatically": false,
    "AdditionalHandlingTime": 3
  },
  "CountryOfOrigin": "DE",
  "ShippingClassId": 123,
  "ProductGroupId": 123,
  "TaxClassId": 123,
  "Dimensions": {
    "Length": 10.5,
    "Width": 5.8,
    "Height": 3
  },
  "Weights": {
    "ItemWeigth": 5,
    "ShippingWeight": 5.5
  },
  "AllowNegativeStock": false,
  "Quantities": {
    "MinimumOrderQuantity": 0,
    "MinimumPurchaseQuantityForCustomerGroup": [
      {
        "CustomerGroupId": 123,
        "PermissibleOrderQuantity": 149.99,
        "MinimumPurchaseQuantity": 1,
        "IsActive": true
      }
    ],
    "PermissibleOrderQuantity": 0
  },
  "DangerousGoods": {
    "UnNumber": "0070",
    "HazardNo": "Class1 explosives"
  },
  "Taric": "61071100",
  "SearchTerms": "goggles, magnification, lenses",
  "PriceListActive": false,
  "IgnoreDiscounts": false,
  "AvailabilityId": 123
}
'
{
  "Id": 123,
  "SKU": "ART2394871",
  "ManufacturerId": 123,
  "ResponsiblePersonId": 123,
  "IsActive": true,
  "Categories": [
    {
      "CategoryId": 123,
      "Name": "House and Garden"
    }
  ],
  "Name": "Interdimensional goggles",
  "Description": "These goggles are a must have product. Everyone needs them. Buy them.",
  "ShortDescription": "The best goggles anyone can buy",
  "Identifiers": {
    "Gtin": "8896982295860",
    "ManufacturerNumber": "75",
    "ISBN": "978-3-86680-192-9",
    "UPC": "889698229586",
    "AmazonFnsku": "FN813S88A43",
    "Asins": "B071GVGFQF",
    "OwnIdentifier": "P446853"
  },
  "Components": [
    {
      "ItemId": 123,
      "Quantity": 2,
      "SortNumber": 1
    }
  ],
  "ChildItems": "",
  "ParentItemId": 123,
  "ItemPriceData": {
    "SalesPriceNet": 125.21,
    "SuggestedRetailPrice": 159.99,
    "PurchasePriceNet": 99.73,
    "EbayPrice": 149.99,
    "AmazonPrice": 149.99
  },
  "ActiveSalesChannels": "",
  "SortNumber": 0,
  "Annotation": "Some additional internal info about the item",
  "Added": "2023-01-15T13:00:00.0000000+00:00",
  "Changed": "2023-01-15T13:00:00.0000000+00:00",
  "ReleasedOnDate": "2023-01-15T13:00:00.0000000+00:00",
  "StorageOptions": {
    "InventoryManagementActive": true,
    "SplitQuantity": false,
    "GlobalMinimumStockLevel": 15,
    "Buffer": 5,
    "SerialNumberItem": false,
    "SerialNumberTracking": false,
    "SubjectToShelfLifeExpirationDate": false,
    "SubjectToBatchItem": false,
    "ProcurementTime": 3,
    "DetermineProcurementTimeAutomatically": false,
    "AdditionalHandlingTime": 3
  },
  "CountryOfOrigin": "DE",
  "ConditionId": 123,
  "ShippingClassId": 123,
  "ProductGroupId": 123,
  "TaxClassId": 123,
  "Dimensions": {
    "Length": 10.5,
    "Width": 5.8,
    "Height": 3
  },
  "Weights": {
    "ItemWeigth": 5,
    "ShippingWeight": 5.5
  },
  "AllowNegativeStock": false,
  "Quantities": {
    "MinimumOrderQuantity": 0,
    "MinimumPurchaseQuantityForCustomerGroup": [
      {
        "CustomerGroupId": 123,
        "PermissibleOrderQuantity": 149.99,
        "MinimumPurchaseQuantity": 1,
        "IsActive": true
      }
    ],
    "PermissibleOrderQuantity": 0
  },
  "DangerousGoods": {
    "UnNumber": "0070",
    "HazardNo": "Class1 explosives"
  },
  "Taric": "61071100",
  "SearchTerms": "goggles, magnification, lenses",
  "PriceListActive": false,
  "IgnoreDiscounts": false,
  "AvailabilityId": 123
}

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

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

​
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-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
itemId
integer<int32>
required

Query Parameters

​
disableAutomaticWorkflows
boolean

If true, the workflows do not trigger automatic.

Body

application/json

The item to update.

Model Class: UpdateItem

​
SKU
string
Example:

"ART2394871"

​
ManufacturerId
integer<int32>
​
ResponsiblePersonId
integer<int32>
​
Categories
object[]
​
Name
string
Example:

"Interdimensional goggles"

​
Description
string
Example:

"These goggles are a must have product. Everyone needs them. Buy them."

​
ShortDescription
string
Example:

"The best goggles anyone can buy"

​
Identifiers
object

Model Class: UpdateItemIdentifiers

​
Components
object[]
​
ItemPriceData
object

Model Class: UpdateItemPrice

​
ActiveSalesChannels
string[]
Example:

""

​
SortNumber
integer<int32>
Example:

0

​
Annotation
string
Example:

"Some additional internal info about the item"

​
ReleasedOnDate
string<date-time>
Example:

"2023-01-15T13:00:00.0000000+00:00"

​
StorageOptions
object

Model Class: UpdateItemStorageOption

​
CountryOfOrigin
string
Example:

"DE"

​
ShippingClassId
integer<int32>
​
ProductGroupId
integer<int32>
​
TaxClassId
integer<int32>
​
Dimensions
object

Model Class: UpdateDimensions

​
Weights
object

Model Class: UpdateItemWeights

​
AllowNegativeStock
boolean
Example:

false

​
Quantities
object

Model Class: UpdateItemQuantities

​
DangerousGoods
object

Model Class: UpdateItemDangerousGoods

​
Taric
string
Example:

"61071100"

​
SearchTerms
string
Example:

"goggles, magnification, lenses"

​
PriceListActive
boolean
Example:

false

​
IgnoreDiscounts
boolean
Example:

false

​
AvailabilityId
integer<int32>

Response

The updated item.

Model Class: Item

​
Id
integer<int32>
required
​
SKU
string
required

Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically.

Example:

"ART2394871"

​
ManufacturerId
integer<int32>
required
​
ResponsiblePersonId
integer<int32>
required
​
IsActive
boolean
required

Indicates if the item is active.

Example:

true

​
Categories
object[]
required

List of all the categories for the item.

​
Name
string
required

Name of the item in the default language in JTL-Wawi.

Example:

"Interdimensional goggles"

​
Description
string
required

Full textdescription for the item

Example:

"These goggles are a must have product. Everyone needs them. Buy them."

​
ShortDescription
string
required

Short description of the item in the default language in JTL-Wawi.

Example:

"The best goggles anyone can buy"

​
Identifiers
object
required

Model Class: ItemIdentifiers

​
Components
object[]
required

Components for the item if the item is a bill of material.

​
ChildItems
integer<int32>[]
required

IDs of the child items, if the item is a parent item.

Example:

""

​
ParentItemId
integer<int32>
required
​
ItemPriceData
object
required

Model Class: ItemPrice

​
ActiveSalesChannels
string[]
required

The list of active sales channels of the item. Only online shops and JTL-POS are permitted. Sales channels that are removed from this list will be deactivated for this item.

Example:

""

​
SortNumber
integer<int32>
required

The sort number of the item, used in some sales channels for ordering items.

Example:

0

​
Annotation
string
required

The item annotation.

Example:

"Some additional internal info about the item"

​
Added
string<date-time>
required

Date when the item was added to the system.

Example:

"2023-01-15T13:00:00.0000000+00:00"

​
Changed
string<date-time>
required

Date of the last change made to the item. Only item data changes are relevant for this field, not changes in stock.

Example:

"2023-01-15T13:00:00.0000000+00:00"

​
ReleasedOnDate
string<date-time>
required

The date when the item was put up for sale.

Example:

"2023-01-15T13:00:00.0000000+00:00"

​
StorageOptions
object
required

Model Class: ItemStorageOption

​
CountryOfOrigin
string
required

The country of origin of the item.

Example:

"DE"

​
ConditionId
integer<int32>
required
​
ShippingClassId
integer<int32>
required
​
ProductGroupId
integer<int32>
required
​
TaxClassId
integer<int32>
required
​
Dimensions
object
required

Model Class: Dimensions

​
Weights
object
required

Model Class: ItemWeights

​
AllowNegativeStock
boolean
required

This option allows you to sell a higher quantity of the item than is actually in stock.

Example:

false

​
Quantities
object
required

Model Class: ItemQuantities

​
DangerousGoods
object
required

Model Class: ItemDangerousGoods

​
Taric
string
required

Taric code of the item.

Example:

"61071100"

​
SearchTerms
string
required

Search terms for the item.

Example:

"goggles, magnification, lenses"

​
PriceListActive
boolean
required

Indicates if the item is in the price list.

Example:

false

​
IgnoreDiscounts
boolean
required

Indicates if discounts are to be disregarded.

Example:

false

​
AvailabilityId
integer<int32>
required