Update Item - JTL Developer Documentation

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": "<string>", "ManufacturerId": 123, "ResponsiblePersonId": 123, "Categories": [ { "CategoryId": 123 } ], "Name": "<string>", "Description": "<string>", "ShortDescription": "<string>", "Identifiers": { "Gtin": "<string>", "ManufacturerNumber": "<string>", "ISBN": "<string>", "UPC": "<string>", "AmazonFnsku": "<string>", "Asins": [ "<string>" ], "OwnIdentifier": "<string>" }, "Components": [ { "ItemId": 123, "Quantity": 123, "SortNumber": 123 } ], "ItemPriceData": { "SalesPriceNet": 123, "SuggestedRetailPrice": 123, "PurchasePriceNet": 123, "EbayPrice": 123, "AmazonPrice": 123 }, "ActiveSalesChannels": [ "<string>" ], "SortNumber": 123, "Annotation": "<string>", "ReleasedOnDate": "2023-11-07T05:31:56Z", "StorageOptions": { "GlobalMinimumStockLevel": 123, "Buffer": 123, "SerialNumberTracking": true, "ProcurementTime": 123, "DetermineProcurementTimeAutomatically": true, "AdditionalHandlingTime": 123 }, "CountryOfOrigin": "<string>", "ShippingClassId": 123, "ProductGroupId": 123, "TaxClassId": 123, "Dimensions": { "Length": 123, "Width": 123, "Height": 123 }, "Weights": { "ItemWeigth": 123, "ShippingWeight": 123 }, "AllowNegativeStock": true, "Quantities": { "MinimumOrderQuantity": 123, "MinimumPurchaseQuantityForCustomerGroup": [ { "CustomerGroupId": 123, "PermissibleOrderQuantity": 123, "MinimumPurchaseQuantity": 123, "IsActive": true } ], "PermissibleOrderQuantity": 123 }, "DangerousGoods": { "UnNumber": "<string>", "HazardNo": "<string>" }, "Taric": "<string>", "SearchTerms": "<string>", "PriceListActive": true, "IgnoreDiscounts": true, "AvailabilityId": 123 } '

{ "Id": 123, "SKU": "<string>", "ManufacturerId": 123, "ResponsiblePersonId": 123, "IsActive": true, "Categories": [ { "CategoryId": 123, "Name": "<string>" } ], "Name": "<string>", "Description": "<string>", "ShortDescription": "<string>", "Identifiers": { "Gtin": "<string>", "ManufacturerNumber": "<string>", "ISBN": "<string>", "UPC": "<string>", "AmazonFnsku": "<string>", "Asins": [ "<string>" ], "OwnIdentifier": "<string>" }, "Components": [ { "ItemId": 123, "Quantity": 123, "SortNumber": 123 } ], "ChildItems": [ 123 ], "ParentItemId": 123, "ItemPriceData": { "SalesPriceNet": 123, "SuggestedRetailPrice": 123, "PurchasePriceNet": 123, "EbayPrice": 123, "AmazonPrice": 123 }, "ActiveSalesChannels": [ "<string>" ], "SortNumber": 123, "Annotation": "<string>", "Added": "2023-11-07T05:31:56Z", "Changed": "2023-11-07T05:31:56Z", "ReleasedOnDate": "2023-11-07T05:31:56Z", "StorageOptions": { "InventoryManagementActive": true, "SplitQuantity": true, "GlobalMinimumStockLevel": 123, "Buffer": 123, "SerialNumberItem": true, "SerialNumberTracking": true, "SubjectToShelfLifeExpirationDate": true, "SubjectToBatchItem": true, "ProcurementTime": 123, "DetermineProcurementTimeAutomatically": true, "AdditionalHandlingTime": 123 }, "CountryOfOrigin": "<string>", "ConditionId": 123, "ShippingClassId": 123, "ProductGroupId": 123, "TaxClassId": 123, "Dimensions": { "Length": 123, "Width": 123, "Height": 123 }, "Weights": { "ItemWeigth": 123, "ShippingWeight": 123 }, "AllowNegativeStock": true, "Quantities": { "MinimumOrderQuantity": 123, "MinimumPurchaseQuantityForCustomerGroup": [ { "CustomerGroupId": 123, "PermissibleOrderQuantity": 123, "MinimumPurchaseQuantity": 123, "IsActive": true } ], "PermissibleOrderQuantity": 123 }, "DangerousGoods": { "UnNumber": "<string>", "HazardNo": "<string>" }, "Taric": "<string>", "SearchTerms": "<string>", "PriceListActive": true, "IgnoreDiscounts": true, "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

The id of the Item to update.

Query Parameters

disableAutomaticWorkflows

boolean

If true, the workflows do not trigger automatic.

Body

application/json

The item to update.

Model Class: UpdateItem

SKU

string

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

ManufacturerId

integer<int32>

The manufacturer ID.

ResponsiblePersonId

integer<int32>

The Responsible person ID.

Response

The updated item.

Model Class: Item

integer<int32>

required

Unique ID to identify an item.

SKU

string

required

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

ManufacturerId

integer<int32>

required

The manufacturer ID.

ResponsiblePersonId

integer<int32>

required

The Responsible person ID.

IsActive

boolean

required

Indicates if the item is active.

REST API

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response