Receive stock against a receive task

curl --request POST \
  --url https://clarus-api.com/api/receive_tasks/{id}/receive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "tasks",
    "attributes": {
      "location_to_id": 25,
      "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"

payload = { "data": {
        "type": "tasks",
        "attributes": {
            "location_to_id": 25,
            "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: 25,
        storage_unit_to_id: 18,
        confirmed_quantity: 10,
        serial_numbers: ['SN-001', 'SN-002']
      }
    }
  })
};

fetch('https://clarus-api.com/api/receive_tasks/{id}/receive', 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 against a receive task

Complete a receive task by recording that the inbound stock has been physically received into the receiving area. The task is updated, the inbound item’s quantity_received is incremented, a follow-on putaway task is generated, and a receive transaction is recorded. Use this endpoint when stock first lands at the receiving location; use /api/receive_tasks/{id}/receive_to_putaway_location when receiving directly into a putaway location instead.

POST

api

receive_tasks

{id}

receive

Receive stock against a receive task

curl --request POST \
  --url https://clarus-api.com/api/receive_tasks/{id}/receive \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "tasks",
    "attributes": {
      "location_to_id": 25,
      "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"

payload = { "data": {
        "type": "tasks",
        "attributes": {
            "location_to_id": 25,
            "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: 25,
        storage_unit_to_id: 18,
        confirmed_quantity: 10,
        serial_numbers: ['SN-001', 'SN-002']
      }
    }
  })
};

fetch('https://clarus-api.com/api/receive_tasks/{id}/receive', 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": 25,
      "storage_unit_to_id": 18,
      "confirmed_quantity": 10.0,
      "serial_numbers": ["SN-001", "SN-002"]
    }
  }
}

Key Fields

Field	Required	Description
`location_to_id`	No	Location into which 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
`base_storage_unit_type_id`	No	Base storage unit type for the received stock, when relevant

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

integer

required

The unique identifier of the receive task

Body

application/json

data

object

required

Show child attributes

Response

Operation completed successfully with no content to return

⌘I

​Request Structure

​Key Fields

Authorizations

Path Parameters

Body

Response

Request Structure

Key Fields