Receive stock straight into a putaway location
curl --request POST \
--url https://clarus-api.com/api/receive_tasks/{id}/receive_to_putaway_location \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "tasks",
"attributes": {
"location_to_id": 47,
"storage_unit_to_id": 18,
"confirmed_quantity": 10,
"serial_numbers": [
"SN-001",
"SN-002"
]
}
}
}
'import requests
url = "https://clarus-api.com/api/receive_tasks/{id}/receive_to_putaway_location"
payload = { "data": {
"type": "tasks",
"attributes": {
"location_to_id": 47,
"storage_unit_to_id": 18,
"confirmed_quantity": 10,
"serial_numbers": ["SN-001", "SN-002"]
}
} }
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: 'tasks',
attributes: {
location_to_id: 47,
storage_unit_to_id: 18,
confirmed_quantity: 10,
serial_numbers: ['SN-001', 'SN-002']
}
}
})
};
fetch('https://clarus-api.com/api/receive_tasks/{id}/receive_to_putaway_location', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Goods In: Receipts
Receive stock straight into a putaway location
Complete a receive task by landing the stock directly into a putaway location instead of the receiving area. The destination location_to_id is required because the stock bypasses the receiving step. Otherwise behaves like /api/receive_tasks/{id}/receive: updates the task, increments the inbound item’s quantity_received, and records the receive transaction.
POST
/
api
/
receive_tasks
/
{id}
/
receive_to_putaway_location
Receive stock straight into a putaway location
curl --request POST \
--url https://clarus-api.com/api/receive_tasks/{id}/receive_to_putaway_location \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "tasks",
"attributes": {
"location_to_id": 47,
"storage_unit_to_id": 18,
"confirmed_quantity": 10,
"serial_numbers": [
"SN-001",
"SN-002"
]
}
}
}
'import requests
url = "https://clarus-api.com/api/receive_tasks/{id}/receive_to_putaway_location"
payload = { "data": {
"type": "tasks",
"attributes": {
"location_to_id": 47,
"storage_unit_to_id": 18,
"confirmed_quantity": 10,
"serial_numbers": ["SN-001", "SN-002"]
}
} }
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: 'tasks',
attributes: {
location_to_id: 47,
storage_unit_to_id: 18,
confirmed_quantity: 10,
serial_numbers: ['SN-001', 'SN-002']
}
}
})
};
fetch('https://clarus-api.com/api/receive_tasks/{id}/receive_to_putaway_location', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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": "tasks",
"attributes": {
"location_to_id": 47,
"storage_unit_to_id": 18,
"confirmed_quantity": 10.0,
"serial_numbers": ["SN-001", "SN-002"]
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
location_to_id | Yes | Putaway location where the stock is received |
storage_unit_to_id | No | Storage unit the received stock lands in |
confirmed_quantity | No | Quantity actually received (>= 0). Defaults to the task’s start_quantity when omitted. |
serial_numbers | No | Serial numbers to assign to the received stock |
Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
FlowAuthorization Code
- Authorization URL
- https://clarus-api.com/oauth/authorize
- Token URL
- https://clarus-api.com/oauth/token
FlowClient Credentials
- Token URL
- https://clarus-api.com/oauth/token
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Path Parameters
The unique identifier of the receive task
Body
application/json
Show child attributes
Show child attributes
Response
Operation completed successfully with no content to return