Create a pickface product assignment
curl --request POST \
--url https://clarus-api.com/api/pickface_products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "pickface_products",
"attributes": {
"product_id": 123,
"location_id": 456,
"replenishment_type": "continuous",
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": false
}
}
}
'import requests
url = "https://clarus-api.com/api/pickface_products"
payload = { "data": {
"type": "pickface_products",
"attributes": {
"product_id": 123,
"location_id": 456,
"replenishment_type": "continuous",
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": False
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'pickface_products',
attributes: {
product_id: 123,
location_id: 456,
replenishment_type: 'continuous',
trigger_min: 10,
trigger_max: 100,
priority: 1,
full_storage_units_only: false
}
}
})
};
fetch('https://clarus-api.com/api/pickface_products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 1,
"type": "pickface_products",
"attributes": {
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": false
},
"relationships": {
"product": {
"data": {
"id": 123,
"type": "products"
}
},
"location": {
"data": {
"id": 456,
"type": "locations"
}
}
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Products
Create a pickface product assignment
Assign a product to a pickface location for replenishment. Exactly one of location_id or location_group_id must be provided to specify where the product will be picked from.
POST
/
api
/
pickface_products
Create a pickface product assignment
curl --request POST \
--url https://clarus-api.com/api/pickface_products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "pickface_products",
"attributes": {
"product_id": 123,
"location_id": 456,
"replenishment_type": "continuous",
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": false
}
}
}
'import requests
url = "https://clarus-api.com/api/pickface_products"
payload = { "data": {
"type": "pickface_products",
"attributes": {
"product_id": 123,
"location_id": 456,
"replenishment_type": "continuous",
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": False
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'pickface_products',
attributes: {
product_id: 123,
location_id: 456,
replenishment_type: 'continuous',
trigger_min: 10,
trigger_max: 100,
priority: 1,
full_storage_units_only: false
}
}
})
};
fetch('https://clarus-api.com/api/pickface_products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 1,
"type": "pickface_products",
"attributes": {
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": false
},
"relationships": {
"product": {
"data": {
"id": 123,
"type": "products"
}
},
"location": {
"data": {
"id": 456,
"type": "locations"
}
}
}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "pickface_products",
"attributes": {
"product_id": 123,
"location_id": 456,
"replenishment_type": "continuous",
"trigger_min": 10,
"trigger_max": 100,
"priority": 1,
"full_storage_units_only": false
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
product_id | Yes | The product to assign to a pickface |
location_id | Conditional | Pickface location ID (exactly one of location_id or location_group_id required) |
location_group_id | Conditional | Location group ID (exactly one of location_id or location_group_id required) |
replenishment_type | No | Type of replenishment: continuous, demand, or order_volume |
trigger_min | No | Minimum stock level that triggers replenishment (>= 0) |
trigger_max | No | Maximum stock level for replenishment target (>= 0) |
priority | No | Replenishment priority (>= 0, lower number = higher priority) |
full_storage_units_only | No | Whether to replenish only with full storage units |
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.
Body
application/json
Show child attributes
Show child attributes
Response
Pickface product assignment created successfully
Response containing a pickface product assignment with its relationships
Show child attributes
Show child attributes
⌘I

