Skip to main content
POST
/
api
/
product_storage_units
Create a product storage unit
curl --request POST \
  --url https://clarus-api.com/api/product_storage_units \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "product_storage_units",
    "attributes": {
      "product_id": 150,
      "storage_unit_type_id": 12,
      "stock_configuration": "case",
      "unit_of_measure": "centimetre",
      "per_layer": 10,
      "number_of_layers": 5,
      "total": 50
    }
  }
}
'
{
  "data": {
    "id": "1",
    "type": "product_storage_units",
    "attributes": {
      "product_id": 150,
      "priority": 0,
      "per_layer": 10,
      "number_of_layers": 5,
      "total": 50
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "product_storage_units",
    "attributes": {
      "product_id": 150,
      "storage_unit_type_id": 12,
      "stock_configuration": "case",
      "unit_of_measure": "centimetre",
      "per_layer": 10,
      "number_of_layers": 5
    }
  }
}
FieldRequiredDescription
product_idYesProduct
storage_unit_type_idYesStorage unit type
stock_configurationYesunit, case, inner, or outer
unit_of_measureYesDimension unit
per_layer / number_of_layersYesLayer config
Priority is unique per product; change it via PATCH /api/product_storage_units/{id}/priority.

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

Created successfully

The response is of type object.