Skip to main content
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"
      ]
    }
  }
}
'
{
  "error": "<string>"
}

​
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

FieldRequiredDescription
location_to_idYesPutaway location where the stock is received
storage_unit_to_idNoStorage unit the received stock lands in
confirmed_quantityNoQuantity actually received (>= 0). Defaults to the task’s start_quantity when omitted.
serial_numbersNoSerial numbers to assign to the received stock

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.

Path Parameters

​
id
integer
required

The unique identifier of the receive task

Body

application/json
​
data
object
required

Response

Operation completed successfully with no content to return