> ## 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.
# Retrieves a bill of materials by its ID.
> Retrieves a bill of materials by its ID.
## OpenAPI
````yaml /openapi/2.0.json get /v2/bills-of-materials/{id}
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.1.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: '2.0'
x-application-version: 2.1.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: Wawi App
description: >-
Get a
specific customer
- name: Warehouses
description: >-
Queries all
storage locations for a given warehouse.
- name: Units
description: Development
- name: Transaction Status
description: >-
Queries all transaction statuses for a sales
order.
- name: Tax
description: >-
Returns the tax
rate for the given item.
- name: Inventory
description: >-
Queries
stocks for a specific item, warehouse or storage location.
- name: Sales Order
description: Planned
- name: Sales Invoice Correction
description: Planned
- name: Sales Channel
description: >-
Gets all
sales channels.
- name: Return
description: >-
Create a new
return with associated items and packages.
- name: Item
description: >-
Queries all
responsible persons.
- name: Refund
description: Planned
- name: Property
description: >-
Queries all
properties of items.
- name: Printer
description: >-
Retrieves all
installed printers.
- name: Master Data
description: >-
Queries
all on hold reasons for sales orders.
- name: Manufacturer
description: Development
- name: Label
description: Development
- name: Sales 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: Shipment
description: Development
- name: Delivery Note
description: Planned
- name: Custom Field
description: Development
- name: Customer
description: >-
Deletes a
specific customer.
- name: Authentication
description: >-
Send a
registration request for an (external) application
- name: Attribute
description: Development
- name: Sales Quotation
description: >-
Execute
the printing of a sales quotation
- name: Production
- name: Resources
- name: Company
- name: Marketplace Order
- name: Marketplace Offer
- name: Marketplace Invoicing
- name: Warehouse Assistant
paths:
/v2/bills-of-materials/{id}:
get:
tags:
- Production
summary: Retrieves a bill of materials by its ID.
description: Retrieves a bill of materials by its ID.
operationId: BillsOfMaterials_GetBillOfMaterialsById
parameters:
- name: id
in: path
required: true
schema:
$ref: '#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey'
example: b45f6432-2462-4c6f-b00f-1d9d01000000
x-position: 1
- name: x-companyid
in: header
description: >-
The Company-Id (int or uuid) of the company on whose behalf the
request is executed.
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: ''
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.BillOfMaterials
'400':
description: ''
content:
application/json: {}
'401':
description: ''
content:
application/json: {}
'403':
description: ''
content:
application/json: {}
'404':
description: ''
content:
application/json: {}
'500':
description: ''
content:
application/json: {}
security:
- oauth2-authorization-code:
- pps.read
- oauth2-client-credentials:
- pps.read
components:
schemas:
JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.BillOfMaterials:
type: object
description: >-
A bill of materials for a production item. It defines which operations
must be performed and which components are required to produce the
production item.
additionalProperties: false
required:
- id
- productionItemId
- version
- name
- state
- createDate
- producibleStock
- componentPostingsShelfLifeEndDateRequirements
- componentPostingsBatchNumberRequirements
properties:
id:
$ref: '#/components/schemas/JTL.Pps.Core.Contracts.Keys.BillOfMaterialKey'
description: The ID of this bill of materials.
productionItemId:
$ref: '#/components/schemas/JTL.Pps.Core.Contracts.Keys.ProdItemKey'
description: The ID of the production item of this bill of materials.
version:
type: integer
description: The version of this bill of materials.
format: int32
name:
type: string
description: The name of this production bill of materials.
description:
type: string
description: The description of this production bill of materials.
state:
$ref: >-
#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.BillOfMaterialsState
description: The status of this production bill of materials.
createDate:
type: string
description: The timestamp when this bill of materials was created.
format: date-time
updateDate:
type: string
description: >-
The timestamp when this bill of materials was last modified, or NULL
if this bill of materials has not been modified yet.
format: date-time
updateUserId:
$ref: '#/components/schemas/JTL.Identity.Abstractions.BenutzerKey'
description: >-
The ID of the user who last modified this bill of materials, or NULL
if this bill of materials has not been modified yet.
activationDate:
type: string
description: >-
The timestamp when this bill of materials was activated, or NULL if
this bill of materials has not been activated yet.
format: date-time
producibleStock:
type: number
description: The last calculated producible stock.
format: decimal
producibleStockCalculationDate:
type: string
description: >-
The timestamp when the producible stock was last calculated, or NULL
if it has not been calculated yet.
format: date-time
componentPostingsShelfLifeEndDateRequirements:
$ref: >-
#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.OverallComponentPostingsInventoryAccountingDataRequirements
description: >-
Specifies requirements for the production input of all components of
this bill of materials regarding the shelf life end dates of the
stock accounts to be debited. This specification can be overridden
for individual components of this bill of materials.
componentPostingsBatchNumberRequirements:
$ref: >-
#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.OverallComponentPostingsInventoryAccountingDataRequirements
description: >-
Specifies requirements for the production input of all components of
this bill of materials regarding the batch numbers of the stock
accounts to be debited. This specification can be overridden for
individual components of this bill of materials.
shelfLifeEndDateGenerationMode:
$ref: >-
#/components/schemas/JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.ShelfLifeEndDateGenerationMode
description: >-
Indicates how the shelf life end date of a product is calculated
after completing a lot.
additionalShelfLifeEndDateTime:
type: string
description: >-
A time span that is added when calculating the shelf life end date
of a product after completing a lot.
format: duration
JTL.Pps.Core.Contracts.Keys.ProdItemKey:
type: string
description: Der Schlüssel eines Produktionsartikels.
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.BillOfMaterialsState:
type: integer
description: >-
0 = Draft, 1 = Default, 2 = Archived, 3 = Alternative, 4 =
ProductionOrderCustomization, 99 = Deleted
format: int32
x-enumNames:
- Draft
- Default
- Archived
- Alternative
- ProductionOrderCustomization
- Deleted
enum:
- 0
- 1
- 2
- 3
- 4
- 99
JTL.Identity.Abstractions.BenutzerKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.OverallComponentPostingsInventoryAccountingDataRequirements:
type: integer
description: 0 = None, 1 = Identical
format: int32
x-enumNames:
- None
- Identical
enum:
- 0
- 1
JTL.PPS.ProductionItems.PublicApi.DataTransferObjects.V2.BillsOfMaterials.ShelfLifeEndDateGenerationMode:
type: integer
description: 0 = Earliest, 1 = Latest, 2 = ProductionDate
format: int32
x-enumNames:
- Earliest
- Latest
- ProductionDate
enum:
- 0
- 1
- 2
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:
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
all.read: Allows the application to read all data.
authentication.updateforeignapp: Grants permission to update registered third-party apps.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
customfields.read: Grants permission to read custom fields.
customfields.write: Grants permission to create and modify custom fields.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliverynotes.print: Grants permission to print and output delivery notes.
deliverynotes.read: Grants permission to read delivery notes.
deliverynotes.write: Grants permission to create and modify delivery notes.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
foreignapps.manage: >-
Grants permission to manage registered third-party apps
(registration, update and removal).
inventories.read: Grants permission to read stock levels.
inventories.write: Grants permission to modify stock levels.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
labels.read: Grants permission to read labels.
labels.write: Grants permission to create and modify labels.
masterdata.read: >-
Read master data such as shipping methods, payment methods, color
codes and tax classes.
orders.read: Grants permission to read orders.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
saleschannels.read: Grants permission to read sales channels.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorders.print: Grants permission to print and output sales orders.
salesorders.read: Grants permission to read sales orders.
salesorders.write: Grants permission to create and modify sales orders.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
system.worker.read: >-
Grants permission to read the configuration and status of
background workers.
system.worker.write: Grants permission to configure and control background workers.
taxes.read: Grants permission to read tax data.
warehouse.read: Grants permission to read warehouse data.
wawiapp.all: Grants access to Wawi app related operations.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.print: Grants permission to print and output sales invoices.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.print: Grants permission to print and output sales quotations.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
suppliers.read: Grants permission to read suppliers.
resources.read: Grants permission to read resource management data.
resources.write: Grants permission to create and modify resource management data.
pps.read: Grants permission to read production data.
pps.write: Grants permission to create and modify production data.
masterdata.write: Write master data
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
oauth2-client-credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Grants permission to read item data.
items.write: Grants permission to create and modify item data.
all.read: Allows the application to read all data.
authentication.updateforeignapp: Grants permission to update registered third-party apps.
customers.read: Grants permission to read customer data.
customers.write: Grants permission to create and modify customer data.
customfields.read: Grants permission to read custom fields.
customfields.write: Grants permission to create and modify custom fields.
deliveries.read: Grants permission to read deliveries.
deliveries.write: Grants permission to create and modify deliveries.
deliverynotes.print: Grants permission to print and output delivery notes.
deliverynotes.read: Grants permission to read delivery notes.
deliverynotes.write: Grants permission to create and modify delivery notes.
extensibility.integration: >-
Grants permission to manage extensions and integrations of the
JTL-Wawi.
foreignapps.manage: >-
Grants permission to manage registered third-party apps
(registration, update and removal).
inventories.read: Grants permission to read stock levels.
inventories.write: Grants permission to modify stock levels.
invoices.read: Grants permission to read invoices.
invoices.write: Grants permission to create and modify invoices.
labels.read: Grants permission to read labels.
labels.write: Grants permission to create and modify labels.
masterdata.read: >-
Read master data such as shipping methods, payment methods, color
codes and tax classes.
orders.read: Grants permission to read orders.
picklists.read: Grants permission to read pick lists.
picklists.write: Grants permission to create and modify pick lists.
returns.read: Grants permission to read returns.
returns.write: Grants permission to create and modify returns.
saleschannels.read: Grants permission to read sales channels.
salesinvoicecorrections.read: Grants permission to read invoice corrections.
salesinvoicecorrections.write: Grants permission to create and modify invoice corrections.
salesorders.print: Grants permission to print and output sales orders.
salesorders.read: Grants permission to read sales orders.
salesorders.write: Grants permission to create and modify sales orders.
system.config.read: Grants permission to read the system configuration.
system.config.write: Grants permission to modify the system configuration.
system.worker.read: >-
Grants permission to read the configuration and status of
background workers.
system.worker.write: Grants permission to configure and control background workers.
taxes.read: Grants permission to read tax data.
warehouse.read: Grants permission to read warehouse data.
wawiapp.all: Grants access to Wawi app related operations.
currencies.read: Grants read access to currencies.
jera.read: Grants read access to JERA internal endpoints.
paymentmethods.read: Grants read access to payment methods.
salesinvoicecorrections.print: Grants permission to print and output invoice corrections.
salesinvoices.print: Grants permission to print and output sales invoices.
salesinvoices.read: Grants read access to sales invoices.
salesinvoices.write: Grants write access to sales invoices.
salesquotations.print: Grants permission to print and output sales quotations.
salesquotations.read: Grants read access to sales quotations.
salesquotations.write: Grants write access to sales quotations.
suppliers.read: Grants permission to read suppliers.
resources.read: Grants permission to read resource management data.
resources.write: Grants permission to create and modify resource management data.
pps.read: Grants permission to read production data.
pps.write: Grants permission to create and modify production data.
masterdata.write: Write master data
inventory.read: Grants permission to read stock levels.
inventory.write: Grants permission to modify stock levels.
taxes.write: Grants permission to create and modify tax data.
application.runas: >-
Allows the application to execute requests on behalf of another
user.
````