> ## Documentation Index > Fetch the complete documentation index at: https://developer.jtl-software.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Item > Get a specific item ## OpenAPI ````yaml /openapi/1.0.json get /items/{itemId} openapi: 3.0.0 info: title: JTL-WAWI API (Cloud) description: "JTL-Wawi-Version: 0.0.0\r\n# Introduction\r\n\r\nWelcome to the JTL-WAWI technical API documentation. This guide is here to help developers understand how our REST API works and how it can be integrated into your existing systems. We'll delve into the details of authentication and data manipulation processes, providing clear examples along the way. Whether you're a developer or an IT professional, this documentation aims to give you a practical understanding, laying the groundwork for effectively using the JTL-WAWI API to enhance your processes.\r\n\r\n# Authentication\r\n\r\nYou register your application with the API by sending a POST request with the required information and corresponding keys. You can find the exact request details at https://developer.jtl-software.com/products/erp/swagger/appregistration. This information has to include the following:\r\n\r\n* AppId\r\n* DisplayName\r\n* Description\r\n* Version\r\n* ProviderName\r\n* ProviderWebsite\r\n* MandatoryApiScopes\r\n\r\nThis data is crucial for identifying and registering your application with the API. The API uses it to generate a temporary authentication ID that allows your application to access the necessary resources. After successful validation of this information, you will receive the API key required for future authentication and API requests.\r\n\r\nBefore you can begin the registration process, you must open JTL-Wawi (new interface) and start the registration process under 'Admin->App registration'. Only at this point are you authorised to send the first API call. This step in JTL-Wawi ensures that your application is properly registered and has permission to use the API.\r\n\r\nThe API will send you an authentication ID in the form of a token. Once you have received this token and successfully completed the registration in JTL-Wawi, you will send another request to the API by including this authentication ID in the URL path.\r\n\r\nAfter successful validation of this second request by the API and confirmation of the correct information, you will be provided with the actual API key. It is important to note that this API key will not be displayed again!\r\n\r\nThis API key will be used in the future to authenticate requests to the API. It is of utmost importance that you securely store the API key upon receipt, as it cannot be retrieved from any other location in the system." contact: name: JTL-Software-GmbH url: https://developer.jtl-software.com/ email: partner@jtl-software.com version: '1.0' x-application-version: 0.0.0.0 servers: - url: https://api.jtl-cloud.com/erp description: Production Environment Cloud API Gateway security: [] tags: - name: worker description: >-

Returns the Available Syncs of the Worker - name: wms description: >-

Query all pick lists for a specific wms warehouse that are not completed. - name: warehouse description: >-

Query all warehouses - name: transactionStatus description: >-

Query all transaction status for sales order - name: tax description: >-

Returns the Taxrate for the given Item - name: item description: >-

Query all tax classes - name: supplier description: >-

Query all suppliers - name: stock description: >-

Query stocks for a specific item, warehouse or storage location - name: shippingmethod description: >-

Query all shipping methods - name: salesorder description: >-

Query all sales orders - name: cancellationreason description: Planned - name: salesinvoicecorrection description: Development - name: saleschannel description: >-

Get all sales channels - name: return description: >-

Create a new return with associated items and packages. - name: returnstate description: Planned - name: returnreason description: Planned - name: property description: >-

Query all properties for items - name: printer description: >-

Returns all Installed Printers - name: paymentmethod description: >-

Query all payment methods - name: onholdreason description: >-

Query all on hold reasons for sales orders - name: offer description: >-

Execute the printing of a Offer - name: Configuration description: Planned - name: invoice description: Planned - name: info description: >-

Returns the status of the API - name: features description: >-

Returns the available feature sets with release state and API version - name: Extensibility description: Planned - name: shipping description: Development - name: deliverynote description: Planned - name: customer description: >-

Query all customers - name: customerGroup description: >-

Query all customer groups - name: customerCategory description: >-

Query all customer categories - name: creditnote description: >-

Execute the printing of a CreditNote - name: company description: >-

Query all companies - name: colorcodes description: >-

Query all color codes for sales orders - name: category description: >-

Query all categories - name: appRegistration description: >-

Send a registration request for an (external) application - name: login description: >-

Sends a request to log in the user / dynamically assign the WAWI user. Only use this request if your API uses SSL. - name: logout description: >-

Sends a request to log out the user - name: accountingData description: Planned paths: /items/{itemId}: get: tags: - item summary: Get Item description: Get a specific item operationId: ItemHeader_GetItemAsync parameters: - name: itemId in: path required: true description: The id of the Item to return. schema: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey' x-position: 1 - name: x-runas in: header description: >- The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'. schema: type: string - name: x-tenant-id in: header required: true schema: type: string format: uuid description: The tenant ID for the target ERP instance. responses: '200': description: Returns the Item for the given id. content: application/json: schema: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.Item '401': description: '' content: application/json: {} '402': description: No licence available or the app has not been authorised by JTL. content: application/json: {} '404': description: No item with the given ID exists. content: application/json: schema: $ref: >- #/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse deprecated: true security: - oauth2-authorization-code: [] - oauth2-client-credentials: [] components: schemas: JTL.Data.Contracts.Keys.ArtikelKey: type: integer format: int32 additionalProperties: false JTL.Wawi.Rest.Contracts.Models.V1.Item.Item: type: object description: 'Model Class: Item ' additionalProperties: false required: - Id - SKU - ManufacturerId - ResponsiblePersonId - IsActive - Categories - Name - Description - ShortDescription - Identifiers - Components - ChildItems - ParentItemId - ItemPriceData - ActiveSalesChannels - SortNumber - Annotation - Added - Changed - ReleasedOnDate - StorageOptions - CountryOfOrigin - ConditionId - ShippingClassId - ProductGroupId - TaxClassId - Dimensions - Weights - AllowNegativeStock - Quantities - DangerousGoods - Taric - SearchTerms - PriceListActive - IgnoreDiscounts - AvailabilityId properties: Id: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey' description: Unique ID to identify an item. SKU: type: string description: >- Item SKU. If no SKU is given when posting an item, the SKU will be generated automatically. ManufacturerId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.HerstellerKey' description: The manufacturer ID. ResponsiblePersonId: $ref: >- #/components/schemas/JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ProductComplianceContactKey description: The Responsible person ID. IsActive: type: boolean description: Indicates if the item is active. Categories: type: array description: List of all the categories for the item. items: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.CategoryReference Name: type: string description: Name of the item in the default language in JTL-Wawi. Description: type: string description: Full textdescription for the item ShortDescription: type: string description: Short description of the item in the default language in JTL-Wawi. Identifiers: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemIdentifiers description: Identifiers for items like EAN and UPC. Components: type: array description: Components for the item if the item is a bill of material. items: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemComponent ChildItems: type: array description: IDs of the child items, if the item is a parent item. items: type: integer format: int32 ParentItemId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey' description: ID of the parent item, if the item is a child item. ItemPriceData: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPrice description: Price data of the item. ActiveSalesChannels: type: array description: >- 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. items: type: string x-delete-saleschannel: PrimitiveType: 7 AnyType: 0 Value: true SortNumber: type: integer description: >- The sort number of the item, used in some sales channels for ordering items. format: int32 Annotation: type: string description: The item annotation. Added: type: string description: Date when the item was added to the system. format: date-time Changed: type: string description: >- Date of the last change made to the item. Only item data changes are relevant for this field, not changes in stock. format: date-time ReleasedOnDate: type: string description: The date when the item was put up for sale. format: date-time StorageOptions: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemStorageOption description: Storage options for the item. CountryOfOrigin: type: string description: The country of origin of the item. ConditionId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ZustandKey' description: Condition ID of the item. Default if nothing is specified. ShippingClassId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.VersandklasseKey' description: The shipping class ID. ProductGroupId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarengruppeKey' description: The ID of the item group. TaxClassId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.SteuerklasseKey' description: The ID of the tax class. Dimensions: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Dimensions description: The dimensions of the item. Weights: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemWeights description: The weight of the item. AllowNegativeStock: type: boolean description: >- This option allows you to sell a higher quantity of the item than is actually in stock. Quantities: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemQuantities description: Quantities of the item. DangerousGoods: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDangerousGoods description: Any information about dangerous goods. Taric: type: string description: Taric code of the item. SearchTerms: type: string description: Search terms for the item. PriceListActive: type: boolean description: Indicates if the item is in the price list. IgnoreDiscounts: type: boolean description: Indicates if discounts are to be disregarded. AvailabilityId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.LieferstatusKey' description: Availability ID of the item. JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse: type: object description: >- Represents an error response returned by the system in case of a failure or exception. additionalProperties: false properties: ErrorCode: type: string description: >- Gets or sets the error code that identifies the type of error encountered. ValidationErrors: type: object description: >- Gets or sets a dictionary containing validation errors associated with the request. deprecated: true x-deprecatedMessage: Use Errors additionalProperties: type: string Errors: type: object description: Gets or sets a collection of errors associated with the response. additionalProperties: type: array items: type: string ErrorMessage: type: string description: >- Gets or sets the error message that provides details about the error encountered. Stacktrace: type: string description: >- Gets or sets the stack trace associated with the error, providing detailed information about the sequence of method calls that led to the exception. JTL.Data.Contracts.Keys.HerstellerKey: type: integer format: int32 additionalProperties: false JTL.Wawi.ContactManagement.Core.Contracts.Domain.Keys.ProductComplianceContactKey: type: integer description: Produktverantwortlichen Schlüssel format: int32 additionalProperties: false JTL.Wawi.Rest.Contracts.Models.V1.Item.CategoryReference: type: object description: 'Model Class: CategoryReference ' additionalProperties: false required: - CategoryId - Name properties: CategoryId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KategorieKey' description: Unique ID to identify a category. Name: type: string description: Name in the default language of the category. JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemIdentifiers: type: object description: 'Model Class: ItemIdentifiers ' additionalProperties: false required: - Gtin - ManufacturerNumber - ISBN - UPC - AmazonFnsku - Asins - OwnIdentifier properties: Gtin: type: string description: GTIN ManufacturerNumber: type: string description: Manufacturer number. ISBN: type: string description: ISBN UPC: type: string description: UPC AmazonFnsku: type: string description: An item's Amazon FNSKU. Asins: type: array description: A list of the item's ASINs. items: type: string OwnIdentifier: type: string description: A custom identifier for the item. JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemComponent: type: object description: 'Model Class: ItemComponent ' additionalProperties: false required: - ItemId - Quantity - SortNumber properties: ItemId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.ArtikelKey' description: Item ID of the item's component. Quantity: type: number description: Quantity of the component in the bill of material. format: decimal SortNumber: type: integer description: >- Defines the order of the components when shown in lists and sales channels. format: int32 JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemPrice: type: object description: 'Model Class: ItemPrice ' additionalProperties: false required: - SalesPriceNet - SuggestedRetailPrice - PurchasePriceNet - EbayPrice - AmazonPrice properties: SalesPriceNet: type: number description: The net sales price of the item. format: decimal SuggestedRetailPrice: type: number description: The suggested retail price for the item. format: decimal PurchasePriceNet: type: number description: The purchase price of the item. format: decimal EbayPrice: type: number description: Default price in new listing templates. format: decimal AmazonPrice: type: number description: Brutto price for new Amazon listings. format: decimal JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemStorageOption: type: object description: 'Model Class: ItemStorageOption ' additionalProperties: false required: - InventoryManagementActive - SplitQuantity - GlobalMinimumStockLevel - Buffer - SerialNumberItem - SerialNumberTracking - SubjectToShelfLifeExpirationDate - SubjectToBatchItem - ProcurementTime - DetermineProcurementTimeAutomatically - AdditionalHandlingTime properties: InventoryManagementActive: type: boolean description: >- Indicates if inventory management for the item is active, meaning that the item displays stock quantities. SplitQuantity: type: boolean description: Indicates if the item can be split into quantities less than 1. GlobalMinimumStockLevel: type: number description: >- Defines the minimum quantity that should always be in stock. For example, when calculating purchasing orders. format: decimal Buffer: type: integer description: >- The buffer of the item. Used when selling time-delayed across different sales channels, so as not to sell more than is in stock. format: int32 SerialNumberItem: type: boolean description: Indicates the item's serial number when shipping the sales orders. SerialNumberTracking: type: boolean description: >- Indicates if serial numbers are to be identified during a goods receipt process from a supplier. SubjectToShelfLifeExpirationDate: type: boolean description: >- Indicates if the item has an expiration date, also known as a best before date. SubjectToBatchItem: type: boolean description: Indicates whether the item is a batch item or not. ProcurementTime: type: integer description: >- The procurement time indicates how many days it will take for the goods to be ready for shipment if they are currently out of stock. Procurement time is determined automatically on the basis of the supplier’s delivery time. By default, the delivery time of the default supplier is used as the procurement time. If additional processing time (in days) has been specified, this is added to the procurement time. format: int32 DetermineProcurementTimeAutomatically: type: boolean description: >- If this option is set, the procurement time will be calculated from the default supplier's shipment time. AdditionalHandlingTime: type: integer description: >- Indicates the additional processing time in days required to process. It is always added to the delivery time. format: int32 JTL.Data.Contracts.Keys.ZustandKey: type: integer format: int32 additionalProperties: false JTL.Data.Contracts.Keys.VersandklasseKey: type: integer format: int32 additionalProperties: false JTL.Data.Contracts.Keys.WarengruppeKey: type: integer format: int32 additionalProperties: false JTL.Data.Contracts.Keys.SteuerklasseKey: type: integer format: int32 additionalProperties: false JTL.Wawi.Rest.Contracts.Models.V1.Common.Dimensions: type: object description: 'Model Class: Dimensions ' additionalProperties: false required: - Length - Width - Height properties: Length: type: number description: Length format: decimal Width: type: number description: Width format: decimal Height: type: number description: Height format: decimal JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemWeights: type: object description: 'Model Class: ItemWeights ' additionalProperties: false required: - ItemWeigth - ShippingWeight properties: ItemWeigth: type: number description: The weight of the item in kilograms. format: decimal ShippingWeight: type: number description: The shipping weight of the item in kilograms. format: decimal JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemQuantities: type: object description: 'Model Class: ItemQuantities ' additionalProperties: false required: - MinimumOrderQuantity - MinimumPurchaseQuantityForCustomerGroup - PermissibleOrderQuantity properties: MinimumOrderQuantity: type: number description: The minimum order quantity of the item. format: decimal MinimumPurchaseQuantityForCustomerGroup: type: array description: >- A collection of minimum order quantities for different customer groups. items: $ref: >- #/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemMinimumPurchaseQuantityForCustomerGroup PermissibleOrderQuantity: type: number description: >- The permissible order quantity for the item. Indicates the increments in which the item is sold. format: decimal JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemDangerousGoods: type: object description: 'Model Class: ItemDangerousGoods ' additionalProperties: false required: - UnNumber - HazardNo properties: UnNumber: type: string description: The UN number for the item. HazardNo: type: string description: The hazard number for the item. JTL.Data.Contracts.Keys.LieferstatusKey: type: integer format: int32 additionalProperties: false JTL.Data.Contracts.Keys.KategorieKey: type: integer format: int32 additionalProperties: false JTL.Wawi.Rest.Contracts.Models.V1.Item.ItemMinimumPurchaseQuantityForCustomerGroup: type: object description: 'Model Class: ItemMinimumPurchaseQuantityForCustomerGroup ' additionalProperties: false required: - CustomerGroupId - PermissibleOrderQuantity - MinimumPurchaseQuantity - IsActive properties: CustomerGroupId: $ref: '#/components/schemas/JTL.Data.Contracts.Keys.KundenGruppeKey' description: Unique ID to identify a customer group. PermissibleOrderQuantity: type: number description: >- The permissible order quantity for the item. Indicates the increments in which the item is sold. format: decimal MinimumPurchaseQuantity: type: number description: The minimum purchase quantity for a customer group. format: decimal IsActive: type: boolean description: Indicates if this setting is active or deactivated. JTL.Data.Contracts.Keys.KundenGruppeKey: type: integer format: int32 additionalProperties: false securitySchemes: oauth2-authorization-code: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.jtl-cloud.com/oauth2/auth tokenUrl: https://auth.jtl-cloud.com/oauth2/token scopes: {} oauth2-client-credentials: type: oauth2 flows: clientCredentials: tokenUrl: https://auth.jtl-cloud.com/oauth2/token scopes: {} ````