> ## 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.
# Query Storage Locations
> Query all storage locations for a given warehouse
## OpenAPI
````yaml /openapi/2.1.json get /v2/warehouses/{warehouseId}/storagelocations
openapi: 3.0.0
info:
title: JTL-WAWI API (Cloud)
description: "JTL-Wawi-Version: 2.2.0-alpha.7351+Sha.7529201\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.1'
x-application-version: 2.2.0.0
servers:
- url: https://api.jtl-cloud.com/erp
description: Production Environment Cloud API Gateway
security: []
tags:
- name: wms
description: >-
Query all pick
lists for a specific wms warehouse that are not completed.
- name: WawiApp
description: Development
- 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: shipment
description: >-
Download a
PDF Shipping Label from database by ID
- name: salesorder
description: >-
Query all
sales orders
- name: cancellationreason
description: Planned
- name: salesinvoicecorrection
description: Development
- 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: manufacturer
description: Development
- name: label
description: Development
- 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: customfields
description: Development
- name: customfield
description: Development
- 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: Development
- name: appRegistration
description: >-
DEPRECATED seit Wawi 2.2.0: No-Op. Seit
Wawi 2.1.0 registriert sich die Wawi selbst per JWT.
- 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: attribute
description: Development
- name: accountingData
description: Planned
paths:
/v2/warehouses/{warehouseId}/storagelocations:
get:
tags:
- warehouse
summary: Query Storage Locations
description: Query all storage locations for a given warehouse
operationId: Warehouse_QueryStorageLocationsAsync
parameters:
- name: x-tenant-id
in: header
required: true
schema:
type: string
format: uuid
description: The tenant ID for the target ERP instance.
- name: pageNumber
in: query
description: Number of the page of items to fetch.
schema:
type: integer
format: int32
x-position: 1
- name: pageSize
in: query
description: Size of the page that is specified by `pageNumber`.
schema:
type: integer
format: int32
x-position: 2
- name: warehouseId
in: path
required: true
description: The id of the warehouse that the storage locations belong to.
schema:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
example: b45f6432-2462-4c6f-b00f-1d9d01000000
x-position: 3
- 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-companyid
in: header
description: >-
The Company-Id (int or uuid) of the company on whose behalf the
request is executed.
schema:
type: string
responses:
'200':
description: Returns all storage locations of the warehouse.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation
'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 warehouse with the given ID exists.
content:
application/json:
schema:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Abstraction.Exceptions.ErrorResponse
security:
- oauth2-authorization-code:
- warehouse.read
- oauth2-client-credentials:
- warehouse.read
components:
schemas:
JTL.Data.Contracts.Keys.WarenlagerKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Rest.Contracts.Models.PagedListOfJTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation:
type: object
description: Represents a paginated list of items
additionalProperties: false
required:
- TotalItems
- PageNumber
- PageSize
- Items
properties:
totalItems:
type: integer
description: Gets or sets the total number of items available in the data source.
format: int32
pageNumber:
type: integer
description: Gets or sets the current page number in the paginated list.
format: int32
pageSize:
type: integer
description: Gets or sets the number of items per page in the paginated list.
format: int32
items:
type: array
description: Gets or sets the collection of items contained in the paged list.
items:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation
totalPages:
type: integer
description: >-
Gets the total number of pages based on the total number of items
and the page size.
format: int32
hasPreviousPage:
type: boolean
description: >-
Gets a value indicating whether there is a previous page available
in the paginated list.
hasNextPage:
type: boolean
description: Gets a value indicating whether there is a next page available.
nextPageNumber:
type: integer
description: >-
Gets the number of the next page if there is one; otherwise, returns
the total number of pages.
format: int32
previousPageNumber:
type: integer
description: >-
Gets the number of the previous page. If there is no previous page,
it returns 1.
format: int32
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.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocation:
type: object
description: 'Model Class: StorageLocation '
additionalProperties: false
required:
- Id
- WarehouseId
- Name
- StorageLocationType
- SortNumber
- Priority
- LockForShipment
- LockForAvailability
- Comment
- Dimensions
properties:
id:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenLagerPlatzKey'
description: Unique ID of the storage location or bin.
warehouseId:
$ref: '#/components/schemas/JTL.Data.Contracts.Keys.WarenlagerKey'
description: ID of the warehouse where the storage location is located.
name:
type: string
description: >-
Name of the storage bin. This identifies the exact location inside
the warehouse.
storageLocationType:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocationType
description: Type of the storage location.
sortNumber:
type: integer
description: >-
Sort number for the storage location. Used for creating picking
lists.
format: int32
priority:
type: integer
description: Priority of the storage location.
format: int32
lockForShipment:
type: boolean
description: Declares if the warehouse is locked for shipment.
lockForAvailability:
type: boolean
description: Declares is the warehouse is locked for stock availabilites.
comment:
type: string
description: Comment for the storage bin.
dimensions:
$ref: >-
#/components/schemas/JTL.Wawi.Rest.Contracts.Models.V1.Common.Dimensions
description: Dimentions of the storage bin.
JTL.Data.Contracts.Keys.WarenLagerPlatzKey:
type: string
format: uuid
example: b45f6432-2462-4c6f-b00f-1d9d01000000
additionalProperties: false
JTL.Wawi.Rest.Contracts.Models.V1.Warehouse.StorageLocationType:
type: object
description: 'Model Class: StorageLocationType '
additionalProperties: false
required:
- Id
- Name
- Description
- Scope
properties:
id:
type: string
description: Unique Id of the storage location type as UUID.
name:
type: string
description: Name of the storage location type.
description:
type: string
description: Description of the storage location type.
scope:
type: array
description: List of Scopes with permissions
items:
type: string
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
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: Artikel lesen
items.write: Artikel schreiben
saleschannels.read: Verkaufskanäle lesen
accountings.read: TbD
all.read: Erlaubt der Anwendung, alle Daten zu lesen.
cusomters.read: TbD
customers.read: TbD
customers.write: TbD
customfields.read: TbD
customfields.write: TbD
deliveries.read: TbD
deliveries.write: TbD
deliverynotes.print: TbD
deliverynotes.read: TbD
deliverynotes.write: TbD
extensibility.integration: TbD
inventories.read: TbD
inventories.write: TbD
invoices.print: TbD
invoices.read: TbD
invoices.write: TbD
labels.read: TbD
labels.write: TbD
offers.print: TbD
offers.read: TbD
orders.read: TbD
picklists.read: TbD
picklists.write: TbD
returns.read: TbD
returns.write: TbD
salesinvoicecorrections.print: TbD
salesinvoicecorrections.read: TbD
salesinvoicecorrections.write: TbD
salesorders.print: TbD
salesorders.read: TbD
salesorders.write: TbD
suppliers.read: TbD
system.config.read: TbD
system.config.write: TbD
system.read: TbD
taxes.read: TbD
warehouse.read: TbD
wawiapp.all: Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.
currencies.read: Ermöglicht den Lesezugriff auf Währungen.
jera.read: Ermöglicht den Lesezugriff auf JERA-interne Endpunkte.
paymentmethods.read: Ermöglicht den Lesezugriff auf Zahlungsarten.
payments.write: Ermöglicht den Schreibzugriff auf Zahlungen.
salesinvoices.read: Ermöglicht den Lesezugriff auf Verkaufsrechnungen.
salesinvoices.write: Ermöglicht den Schreibzugriff auf Verkaufsrechnungen.
salesquotations.read: Ermöglicht den Lesezugriff auf Verkaufsangebote.
salesquotations.write: Ermöglicht den Schreibzugriff auf Verkaufsangebote.
system.worker.read: Worker-Synchronisationen lesen
system.worker.write: Worker-Synchronisationen schreiben
resources.read: Ressourcen lesen
resources.write: Ressourcen schreiben
pps.read: Produktionsdaten lesen
pps.write: Produktionsdaten schreiben
inventory.read: Lagerbestand lesen
inventory.write: Lagerbestand schreiben
taxes.write: Steuern schreiben
application.runas: >-
Ermöglicht der Anwendung, Anfragen im Namen eines anderen
Benutzers auszuführen.
oauth2-client-credentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://auth.jtl-cloud.com/oauth2/token
scopes:
items.read: Artikel lesen
items.write: Artikel schreiben
saleschannels.read: Verkaufskanäle lesen
accountings.read: TbD
all.read: Erlaubt der Anwendung, alle Daten zu lesen.
cusomters.read: TbD
customers.read: TbD
customers.write: TbD
customfields.read: TbD
customfields.write: TbD
deliveries.read: TbD
deliveries.write: TbD
deliverynotes.print: TbD
deliverynotes.read: TbD
deliverynotes.write: TbD
extensibility.integration: TbD
inventories.read: TbD
inventories.write: TbD
invoices.print: TbD
invoices.read: TbD
invoices.write: TbD
labels.read: TbD
labels.write: TbD
offers.print: TbD
offers.read: TbD
orders.read: TbD
picklists.read: TbD
picklists.write: TbD
returns.read: TbD
returns.write: TbD
salesinvoicecorrections.print: TbD
salesinvoicecorrections.read: TbD
salesinvoicecorrections.write: TbD
salesorders.print: TbD
salesorders.read: TbD
salesorders.write: TbD
suppliers.read: TbD
system.config.read: TbD
system.config.write: TbD
system.read: TbD
taxes.read: TbD
warehouse.read: TbD
wawiapp.all: Ermöglicht den Zugriff auf Wawi-App bezogene Opperationen.
currencies.read: Ermöglicht den Lesezugriff auf Währungen.
jera.read: Ermöglicht den Lesezugriff auf JERA-interne Endpunkte.
paymentmethods.read: Ermöglicht den Lesezugriff auf Zahlungsarten.
payments.write: Ermöglicht den Schreibzugriff auf Zahlungen.
salesinvoices.read: Ermöglicht den Lesezugriff auf Verkaufsrechnungen.
salesinvoices.write: Ermöglicht den Schreibzugriff auf Verkaufsrechnungen.
salesquotations.read: Ermöglicht den Lesezugriff auf Verkaufsangebote.
salesquotations.write: Ermöglicht den Schreibzugriff auf Verkaufsangebote.
system.worker.read: Worker-Synchronisationen lesen
system.worker.write: Worker-Synchronisationen schreiben
resources.read: Ressourcen lesen
resources.write: Ressourcen schreiben
pps.read: Produktionsdaten lesen
pps.write: Produktionsdaten schreiben
inventory.read: Lagerbestand lesen
inventory.write: Lagerbestand schreiben
taxes.write: Steuern schreiben
application.runas: >-
Ermöglicht der Anwendung, Anfragen im Namen eines anderen
Benutzers auszuführen.
````