Skip to main content
POST
Create a stock check

Request Structure

Key Fields

Behavior

  • If a pending stock check already exists for the location, the existing one is returned and no new record is created.
  • Otherwise a new stock check is created in pending status together with an associated task.
  • The response returns both the stock check ID and the ID of the associated task.

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
data
object
required

Response

Stock check created, or existing pending stock check returned

stock_check_id
integer

ID of the stock check

task_id
integer

ID of the task associated with the stock check