Skip to content
Bottle

Get stock levels

GET
/stock
curl --request GET \
  --url 'https://example.com/stock?yardId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Every yard and every vehicle, with what is on each, full and empty counted apart. Summed from the movements rather than kept beside them, so a count and its workings cannot drift. Also what the whole business holds, and anything at or under the figure somebody set for it. Give yardId to see one yard and the vehicles based there; yards always lists every yard with how many of its products are low. What customers hold, and what is promised to orders, are always for the whole business.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
yardId

UUID v7

string format: uuid

Example 

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

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

Where the stock is

Media typeapplication/json
object
insights
object
from
required
string format: date
to
required
string format: date
periodDays
required
integer
> 0
costValuePence
required
integer
pricedFull
required
integer
unpricedFull
required
integer
products
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
delivered
required
integer
availableFull
required
integer
daysLeft
required
number | null
yardId
required

UUID v7

string | null format: uuid
yards
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
low
required
integer
holders
required
Array<object>
object
kind
required
string
Allowed values: place vehicle
id
required

UUID v7

string format: uuid
name
required
string
out
required
boolean
yardId
required

UUID v7

string | null format: uuid
counts
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
shortCode
required
string | null
full
required
integer
empty
required
integer
totals
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
shortCode
required
string | null
full
required
integer
empty
required
integer
notCounted
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
shortCode
required
string | null
withCustomers
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
shortCode
required
string | null
quantity
required
integer
unaccounted
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
promised
required
Array<object>
object
productId
required

UUID v7

string format: uuid
quantity
required
integer
reserved
required
Array<object>
object
locationId
required

UUID v7

string format: uuid
productId
required

UUID v7

string format: uuid
condition
required
string
Allowed values: full empty
quantity
required
integer
> 0
inTransit
required
Array<object>
object
transferId
required

UUID v7

string format: uuid
fromLocationId
required

UUID v7

string format: uuid
fromName
required
string
toLocationId
required

UUID v7

string format: uuid
toName
required
string
carrierName
required
string | null
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
condition
required
string
Allowed values: full empty
quantity
required
integer
> 0
incoming
required
Array<object>
object
orderId
required

UUID v7

string format: uuid
supplierName
required
string
locationId
required

UUID v7

string format: uuid
locationName
required
string
expectedOn
required
string format: date
late
required
boolean
lines
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
quantity
required
integer
> 0
low
required
Array<object>
object
productId
required

UUID v7

string format: uuid
productName
required
string
locationId
required

UUID v7

string | null format: uuid
locationName
required
string | null
full
required
integer
minimumFull
required
integer

Example 

{
  "insights": {
    "products": [
      {
        "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      }
    ]
  },
  "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "yards": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "holders": [
    {
      "kind": "place",
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "yardId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "counts": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ],
  "totals": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "notCounted": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "withCustomers": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "unaccounted": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "promised": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "reserved": [
    {
      "locationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "condition": "full"
    }
  ],
  "inTransit": [
    {
      "transferId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "fromLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "toLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "lines": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "condition": "full"
        }
      ]
    }
  ],
  "incoming": [
    {
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "locationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "lines": [
        {
          "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
        }
      ]
    }
  ],
  "low": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "locationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

422

Section titled “422”

Validation failed

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"
    }
  ]
}