Skip to content
Bottle

Save a reviewed yard stock take

POST
/stock-takes
curl --request POST \
  --url https://example.com/stock-takes \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "locationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "lines": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "expectedFull": 1, "expectedEmpty": 1, "full": 1, "empty": 1, "damagedFull": 0, "damagedEmpty": 0 } ], "note": "example" }'

Counts exclude damaged cylinders. Damage and other adjustments are saved together. Blank counts otherwise leave stock unchanged. Refuses stale figures so they can be reviewed again. The client-generated id makes retrying safe even after a lost response.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
locationId
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
lines
required
Array<object>
>= 1 items <= 1000 items
object
productId
required

UUID v7

string format: uuid

Example 

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
expectedFull
required
integer
expectedEmpty
required
integer
full
required
integer | null
<= 1000000
empty
required
integer | null
<= 1000000
damagedFull
integer
0 <= 1000000
damagedEmpty
integer
0 <= 1000000
note
string | null
<= 500 characters

Responses

Section titled “Responses”

201

Section titled “201”

Saved

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
locationId
required

UUID v7

string format: uuid
locationName
required
string
byUserId
required
string | null
byName
required
string | null
createdAt
required
string format: date-time
note
required
string | null
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
shortCode
required
string | null
expectedFull
required
integer
expectedEmpty
required
integer
full
required
integer | null
<= 1000000
empty
required
integer | null
<= 1000000
damagedFull
integer
0 <= 1000000
damagedEmpty
integer
0 <= 1000000

Example 

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "locationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "lines": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "damagedFull": 0,
      "damagedEmpty": 0
    }
  ]
}

401

Section titled “401”

Sign in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not allowed to take stock in this business

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Yard or product unavailable

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Stock changed since counting began

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Check the counts

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}