> ## 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
> Queries all storage locations for a given warehouse.
## OpenAPI
````yaml /openapi/2.0.json get /v2/warehouses/{warehouseId}/storage-locations
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/warehouses/{warehouseId}/storage-locations:
get:
tags:
- Warehouses
summary: Query Storage Locations
description: Queries all storage locations for a given warehouse.
operationId: Warehouse_QueryStorageLocationsAsync
parameters:
- 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-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: 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: 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.
````