Remove stocks from hold
curl --request POST \
--url https://clarus-api.com/api/stocks/offhold \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"ids": [
123,
456
],
"description": "Quality check passed"
}
'import requests
url = "https://clarus-api.com/api/stocks/offhold"
payload = {
"ids": [123, 456],
"description": "Quality check passed"
}
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({ids: [123, 456], description: 'Quality check passed'})
};
fetch('https://clarus-api.com/api/stocks/offhold', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "<string>",
"attributes": {}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Stocks
Remove stocks from hold
Release one or more stock records from hold, making them available for allocation to orders again.
POST
/
api
/
stocks
/
offhold
Remove stocks from hold
curl --request POST \
--url https://clarus-api.com/api/stocks/offhold \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"ids": [
123,
456
],
"description": "Quality check passed"
}
'import requests
url = "https://clarus-api.com/api/stocks/offhold"
payload = {
"ids": [123, 456],
"description": "Quality check passed"
}
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({ids: [123, 456], description: 'Quality check passed'})
};
fetch('https://clarus-api.com/api/stocks/offhold', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": {
"id": 123,
"type": "<string>",
"attributes": {}
}
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"ids": [123, 456],
"description": "Quality check passed",
"reason_code_id": 1
}
Key Fields
| Field | Required | Description |
|---|---|---|
ids | Yes | Array of stock IDs to release from hold |
description | Yes | Reason for releasing stock from hold |
reason_code_id | No | Reason code ID for audit trail |
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.
Body
application/json
Response
Stocks removed from hold successfully
Standard successful response wrapper following JSON:API format
The response payload
Show child attributes
Show child attributes

