Update a location
curl --request PATCH \
--url https://clarus-api.com/api/locations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "locations",
"attributes": {
"code": "<string>",
"warehouse_id": 123,
"location_type_id": 123,
"description": "<string>",
"barcode": "<string>",
"aisle": "<string>",
"bay": "<string>",
"level": "<string>",
"position": "<string>",
"pick_sequence": 123,
"putaway_sequence": 123,
"max_weight": 123,
"max_cube": 123,
"is_pickface": true,
"is_active": true,
"string1": "<string>",
"string2": "<string>",
"string3": "<string>",
"string4": "<string>",
"string5": "<string>",
"integer1": 123,
"integer2": 123,
"integer3": 123,
"integer4": 123,
"integer5": 123,
"boolean1": true,
"boolean2": true,
"boolean3": true,
"boolean4": true,
"boolean5": true
}
}
}
'import requests
url = "https://clarus-api.com/api/locations/{id}"
payload = { "data": {
"type": "locations",
"attributes": {
"code": "<string>",
"warehouse_id": 123,
"location_type_id": 123,
"description": "<string>",
"barcode": "<string>",
"aisle": "<string>",
"bay": "<string>",
"level": "<string>",
"position": "<string>",
"pick_sequence": 123,
"putaway_sequence": 123,
"max_weight": 123,
"max_cube": 123,
"is_pickface": True,
"is_active": True,
"string1": "<string>",
"string2": "<string>",
"string3": "<string>",
"string4": "<string>",
"string5": "<string>",
"integer1": 123,
"integer2": 123,
"integer3": 123,
"integer4": 123,
"integer5": 123,
"boolean1": True,
"boolean2": True,
"boolean3": True,
"boolean4": True,
"boolean5": True
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'locations',
attributes: {
code: '<string>',
warehouse_id: 123,
location_type_id: 123,
description: '<string>',
barcode: '<string>',
aisle: '<string>',
bay: '<string>',
level: '<string>',
position: '<string>',
pick_sequence: 123,
putaway_sequence: 123,
max_weight: 123,
max_cube: 123,
is_pickface: true,
is_active: true,
string1: '<string>',
string2: '<string>',
string3: '<string>',
string4: '<string>',
string5: '<string>',
integer1: 123,
integer2: 123,
integer3: 123,
integer4: 123,
integer5: 123,
boolean1: true,
boolean2: true,
boolean3: true,
boolean4: true,
boolean5: true
}
}
})
};
fetch('https://clarus-api.com/api/locations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "locations",
"attributes": {
"code": "<string>",
"warehouse_id": 123,
"location_type_id": 123,
"description": "<string>",
"barcode": "<string>",
"aisle": "<string>",
"bay": "<string>",
"level": "<string>",
"position": "<string>",
"pick_sequence": 123,
"putaway_sequence": 123,
"max_weight": 123,
"max_cube": 123,
"is_pickface": true,
"is_active": true,
"string1": "<string>",
"string2": "<string>",
"string3": "<string>",
"string4": "<string>",
"string5": "<string>",
"integer1": 123,
"integer2": 123,
"integer3": 123,
"integer4": 123,
"integer5": 123,
"boolean1": true,
"boolean2": true,
"boolean3": true,
"boolean4": true,
"boolean5": true
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Locations
Update a location
Update an existing location’s attributes such as its code, description, or capacity settings.
PATCH
/
api
/
locations
/
{id}
Update a location
curl --request PATCH \
--url https://clarus-api.com/api/locations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "locations",
"attributes": {
"code": "<string>",
"warehouse_id": 123,
"location_type_id": 123,
"description": "<string>",
"barcode": "<string>",
"aisle": "<string>",
"bay": "<string>",
"level": "<string>",
"position": "<string>",
"pick_sequence": 123,
"putaway_sequence": 123,
"max_weight": 123,
"max_cube": 123,
"is_pickface": true,
"is_active": true,
"string1": "<string>",
"string2": "<string>",
"string3": "<string>",
"string4": "<string>",
"string5": "<string>",
"integer1": 123,
"integer2": 123,
"integer3": 123,
"integer4": 123,
"integer5": 123,
"boolean1": true,
"boolean2": true,
"boolean3": true,
"boolean4": true,
"boolean5": true
}
}
}
'import requests
url = "https://clarus-api.com/api/locations/{id}"
payload = { "data": {
"type": "locations",
"attributes": {
"code": "<string>",
"warehouse_id": 123,
"location_type_id": 123,
"description": "<string>",
"barcode": "<string>",
"aisle": "<string>",
"bay": "<string>",
"level": "<string>",
"position": "<string>",
"pick_sequence": 123,
"putaway_sequence": 123,
"max_weight": 123,
"max_cube": 123,
"is_pickface": True,
"is_active": True,
"string1": "<string>",
"string2": "<string>",
"string3": "<string>",
"string4": "<string>",
"string5": "<string>",
"integer1": 123,
"integer2": 123,
"integer3": 123,
"integer4": 123,
"integer5": 123,
"boolean1": True,
"boolean2": True,
"boolean3": True,
"boolean4": True,
"boolean5": True
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'locations',
attributes: {
code: '<string>',
warehouse_id: 123,
location_type_id: 123,
description: '<string>',
barcode: '<string>',
aisle: '<string>',
bay: '<string>',
level: '<string>',
position: '<string>',
pick_sequence: 123,
putaway_sequence: 123,
max_weight: 123,
max_cube: 123,
is_pickface: true,
is_active: true,
string1: '<string>',
string2: '<string>',
string3: '<string>',
string4: '<string>',
string5: '<string>',
integer1: 123,
integer2: 123,
integer3: 123,
integer4: 123,
integer5: 123,
boolean1: true,
boolean2: true,
boolean3: true,
boolean4: true,
boolean5: true
}
}
})
};
fetch('https://clarus-api.com/api/locations/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "locations",
"attributes": {
"code": "<string>",
"warehouse_id": 123,
"location_type_id": 123,
"description": "<string>",
"barcode": "<string>",
"aisle": "<string>",
"bay": "<string>",
"level": "<string>",
"position": "<string>",
"pick_sequence": 123,
"putaway_sequence": 123,
"max_weight": 123,
"max_cube": 123,
"is_pickface": true,
"is_active": true,
"string1": "<string>",
"string2": "<string>",
"string3": "<string>",
"string4": "<string>",
"string5": "<string>",
"integer1": 123,
"integer2": 123,
"integer3": 123,
"integer4": 123,
"integer5": 123,
"boolean1": true,
"boolean2": true,
"boolean3": true,
"boolean4": true,
"boolean5": true
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "locations",
"attributes": {
"description": "Updated description",
"barcode": "LOC-A010101-NEW"
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
code | No | Unique location code (max 60 chars) |
description | No | Location description |
barcode | No | Scannable barcode for RF devices |
aisle, bay, level, position | No | Physical location coordinates |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Path Parameters
The unique identifier of the location to update
Body
application/json
Show child attributes
Show child attributes
Response
Location updated successfully
Show child attributes
Show child attributes
⌘I

