POST /stock-takes.json

application/json

Body Required

notes string | null

Notes
reference string Required

Reference
status string Required

Status

Values are pending, approved, cancelled, committing, or committed. Default value is pending.
userId integer(int32) | null

User
warehouseId integer(int32) Required

Warehouse

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- createdAt string(date-time)
  
  Created at
- id integer(int32)
  
  Id
- notes string | null
  
  Notes
- reference string Required
  
  Reference
- status string Required
  
  Status
  
  Values are pending, approved, cancelled, committing, or committed. Default value is pending.
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- warehouseId integer(int32) Required
  
  Warehouse

POST /stock-takes.json

curl \
 --request POST 'http://api.example.com/v1/stock-takes.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"notes":"string","reference":"string","status":"pending","userId":42,"warehouseId":42}'

Request examples

{
  "notes": "string",
  "reference": "string",
  "status": "pending",
  "userId": 42,
  "warehouseId": 42
}

Response examples (200)

{
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "notes": "string",
  "reference": "string",
  "status": "pending",
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42,
  "warehouseId": 42
}