Move stock to another location
curl --request POST \
--url https://clarus-api.com/api/stocks/{id}/move \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "stocks",
"attributes": {
"quantity": 1,
"to_location_id": 123,
"reason_code_id": 123
}
}
}
'import requests
url = "https://clarus-api.com/api/stocks/{id}/move"
payload = { "data": {
"type": "stocks",
"attributes": {
"quantity": 1,
"to_location_id": 123,
"reason_code_id": 123
}
} }
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: 'stocks',
attributes: {quantity: 1, to_location_id: 123, reason_code_id: 123}
}
})
};
fetch('https://clarus-api.com/api/stocks/{id}/move', 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
Move stock to another location
Move a quantity of stock from its current location to a different location within the same warehouse. Creates a transfer transaction for audit purposes.
POST
/
api
/
stocks
/
{id}
/
move
Move stock to another location
curl --request POST \
--url https://clarus-api.com/api/stocks/{id}/move \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "stocks",
"attributes": {
"quantity": 1,
"to_location_id": 123,
"reason_code_id": 123
}
}
}
'import requests
url = "https://clarus-api.com/api/stocks/{id}/move"
payload = { "data": {
"type": "stocks",
"attributes": {
"quantity": 1,
"to_location_id": 123,
"reason_code_id": 123
}
} }
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: 'stocks',
attributes: {quantity: 1, to_location_id: 123, reason_code_id: 123}
}
})
};
fetch('https://clarus-api.com/api/stocks/{id}/move', 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": {}
}
]
}🚧 A parsing error occured. Please contact the owner of this website. They can use the Mintlify CLI to test this website locally and see the errors that occur.
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.
Path Parameters
The unique identifier of the stock record to move
Body
application/json
Request body for moving stock to another location
Show child attributes
Show child attributes
Response
Stock moved successfully
Standard successful response wrapper following JSON:API format
The response payload
Show child attributes
Show child attributes

