Skip to main content
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
    }
  }
}
'
{
  "data": {
    "id": 123,
    "type": "<string>",
    "attributes": {}
  }
}
🚧 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

​
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 stock record to move

Body

application/json

Request body for moving stock to another location

​
data
object
required

Response

Stock moved successfully

Standard successful response wrapper following JSON:API format

​
data
object

The response payload