Skip to main content
GET
/
items
/
{itemId}
Get Item
curl --request GET \
  --url https://api.jtl-cloud.com/erp/items/{itemId} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
{
  "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 return.

Response

Returns the Item for the given id.

Model Class: Item

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

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.

Description
string
required

Full textdescription for the item

ShortDescription
string
required

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

Identifiers
object
required

Identifiers for items like EAN and UPC.

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.

ParentItemId
integer<int32>
required

ID of the parent item, if the item is a child item.

ItemPriceData
object
required

Price data of the item.

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.

SortNumber
integer<int32>
required

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

Annotation
string
required

The item annotation.

Added
string<date-time>
required

Date when the item was added to the system.

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.

ReleasedOnDate
string<date-time>
required

The date when the item was put up for sale.

StorageOptions
object
required

Storage options for the item.

CountryOfOrigin
string
required

The country of origin of the item.

ConditionId
integer<int32>
required

Condition ID of the item. Default if nothing is specified.

ShippingClassId
integer<int32>
required

The shipping class ID.

ProductGroupId
integer<int32>
required

The ID of the item group.

TaxClassId
integer<int32>
required

The ID of the tax class.

Dimensions
object
required

The dimensions of the item.

Weights
object
required

The weight of the item.

AllowNegativeStock
boolean
required

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

Quantities
object
required

Quantities of the item.

DangerousGoods
object
required

Any information about dangerous goods.

Taric
string
required

Taric code of the item.

SearchTerms
string
required

Search terms for the item.

PriceListActive
boolean
required

Indicates if the item is in the price list.

IgnoreDiscounts
boolean
required

Indicates if discounts are to be disregarded.

AvailabilityId
integer<int32>
required

Availability ID of the item.