Skip to main content
POST
/
api
/
stocks
/
hold
Place stocks on hold
curl --request POST \
  --url https://clarus-api.com/api/stocks/hold \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "ids": [
    123,
    456
  ],
  "description": "Quality check required"
}
'
{
  "data": {
    "id": 123,
    "type": "<string>",
    "attributes": {}
  }
}

​
Request Structure

{
  "ids": [123, 456],
  "description": "Quality check required",
  "reason_code_id": 1
}

​
Key Fields

FieldRequiredDescription
idsYesArray of stock IDs to place on hold
descriptionYesReason for placing stock on hold
reason_code_idNoReason code ID for audit trail

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.

Body

application/json

Request body for placing stocks on hold

​
ids
integer[]
required

Array of stock IDs to place on hold

​
description
string
required

Reason for placing stock on hold

​
reason_code_id
integer | null

Reason code ID for audit trail

Response

Stocks placed on hold successfully

Standard successful response wrapper following JSON:API format

​
data
object

The response payload