Skip to main content
POST
/
api
/
goods_in_receipts
/
{id}
/
receive
Receive a goods in receipt
curl --request POST \
  --url https://clarus-api.com/api/goods_in_receipts/{id}/receive \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "data": {
    "id": 1,
    "type": "goods_in_receipts",
    "attributes": {
      "account_id": 1,
      "warehouse_id": 1,
      "reference": "PO-2024-001",
      "status": "received"
    }
  }
}

​
Behavior

  • Receipt must be in PENDING status
  • Receipt must have at least one line item
  • Changes receipt status from PENDING to RCV
  • Creates AVAILABLE receive tasks for each line item (one per line for loose items, one per storage unit for containerised items)
  • Stock records are NOT created at this stage — they are created when individual receive tasks are completed via the receive tasks endpoint
  • Returns the updated receipt with RCV status

​
No Request Body Required

The receipt ID is provided in the URL path. No request body is needed.

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 goods in receipt to receive

Response

Receipt received successfully

​
data
object