Skip to main content
POST
/
api
/
location_ranges
Generate locations from a range
curl --request POST \
  --url https://clarus-api.com/api/location_ranges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "location_ranges",
    "attributes": {
      "prefix": "WH1-",
      "range_start_zone": "A",
      "range_end_zone": "C",
      "range_start_aisle": "01",
      "range_end_aisle": "10",
      "warehouse_id": 1,
      "location_type_id": 2,
      "active": true
    }
  }
}
'
{
  "error": "<string>"
}

​
Request Structure

{
  "data": {
    "type": "location_ranges",
    "attributes": {
      "prefix": "WH1-",
      "range_start_zone": "A",
      "range_end_zone": "C",
      "range_start_aisle": "01",
      "range_end_aisle": "10",
      "warehouse_id": 1,
      "location_type_id": 2
    }
  }
}
Generates the cartesian product of the supplied ranges (at least one range_start_*/range_end_* pair is required). Each created location’s code is the concatenation of its range components.
FieldRequiredDescription
warehouse_idYesTarget warehouse
location_type_idYesLocation type for the created locations
range_start_* / range_end_*At least one pairRanges for zone, aisle, column, row, slot
prefixNoCode prefix

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

Operation completed successfully with no content to return