Item Stock Quantities

The item stock quantities resource.

Base/itemStockQuantities

GET/itemStockQuantities

List item stock quantities

Retrieve a paginated list of item stock quantities. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/itemStockQuantities

curl --request GET \
  --url '<your-host>/itemStockQuantities?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "itemId": "xyz789",
    "companyId": "xyz789",
    "locationId": "xyz789",
    "quantityOnHand": 10
  }
]

GET/itemStockQuantities

Retrieve a item stock quantities

Fetch a single item stock quantities by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item stock quantities's `itemId`, e.g. `eq.{id}`.

GET/itemStockQuantities

curl --request GET \
  --url '<your-host>/itemStockQuantities?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "quantityOnHand": 10
}

POST/itemStockQuantities

Create a item stock quantities

Create a new item stock quantities.

Body parameters

quantityOnHandnumberrequired

POST/itemStockQuantities

curl --request POST \
  --url <your-host>/itemStockQuantities \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quantityOnHand":10}'

Response

{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "quantityOnHand": 10
}

PATCH/itemStockQuantities

Update a item stock quantities

Update an existing item stock quantities, matched on `itemId`.

Body parameters

quantityOnHandnumberrequired

PATCH/itemStockQuantities

curl --request PATCH \
  --url '<your-host>/itemStockQuantities?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quantityOnHand":10}'

Response

{
  "itemId": "xyz789",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "quantityOnHand": 10
}

DELETE/itemStockQuantities

Delete a item stock quantities

Delete a item stock quantities, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the item stock quantities to delete, e.g. `eq.{id}`.

DELETE/itemStockQuantities

curl --request DELETE \
  --url '<your-host>/itemStockQuantities?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content