Skip to main content
PATCH
/
v2
/
warehouseassistant
/
bin-locations
/
update
Updates metadata of an existing bin location (name, type, sort order).
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/v2/warehouseassistant/bin-locations/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "binLocationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "name": "<string>",
  "type": 123,
  "sort": 123
}
'

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.

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

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
api-version
string
​
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-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Body

application/json

Request parameters

Updates metadata of an existing bin location (name, type, sort order). - Request

​
binLocationId
string<uuid>

Unique identifier of the bin location to update.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

​
name
string

New name for the bin location (must be unique within the warehouse, max 50 chars, no apostrophes).

​
type
integer<int32>

New type for the bin location (0=Standard, 1=Shelf, 2=Floor, 3=Rack, 4=Picking, 5=Transfer, 6=Clarification).

​
sort
integer<int32>

New sort order.

Response

Bin location metadata was successfully updated.