Skip to main content
POST
/
api
/
locations
Create a location
curl --request POST \
  --url https://clarus-api.com/api/locations \
  --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
    }
  }
}
'
{
  "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
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "locations",
    "attributes": {
      "code": "A-01-01-01",
      "warehouse_id": 1,
      "location_type_id": 1,
      "description": "Aisle A, Bay 01, Level 01, Position 01",
      "barcode": "LOC-A010101",
      "aisle": "A",
      "bay": "01",
      "level": "01",
      "position": "01"
    }
  }
}

​
Key Fields

FieldRequiredDescription
codeYesUnique location code (max 60 chars)
warehouse_idYesID of the warehouse
location_type_idYesLocation type defining behavior
barcodeNoScannable barcode for RF devices
aisle, bay, level, positionNoPhysical location coordinates

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
data
object
required

Response

Location created successfully

​
data
object