Skip to main content
POST
/
api
/
goods_out_processes
/
trigger_replenishment
Trigger replenishment
curl --request POST \
  --url https://clarus-api.com/api/goods_out_processes/trigger_replenishment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "account_id": 1,
  "location_id": 42,
  "product_id": 123
}
'
{
  "error": "<string>"
}

Request Structure

{
  "account_id": 1,
  "location_id": 42,
  "product_id": 123
}

Key Fields

FieldRequiredDescription
account_idYesStock account ID
location_idYesPickface location ID to replenish
product_idYesProduct ID to replenish

Behavior

  • Initiates replenishment from bulk storage to the specified pickface location
  • Creates replenishment tasks for warehouse operators
  • Used to maintain stock levels in picking areas

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 triggering pickface replenishment

account_id
integer
required

Stock account ID

location_id
integer
required

Pickface location ID to replenish

product_id
integer
required

Product ID to replenish

Response

Replenishment triggered successfully