iVendNextDevelopers Request a sandbox

Bin

The stock of one item in one warehouse: the quantity on hand, ordered and reserved, kept by iVendNext itself.

Area: Stock and stores · Why it is here: openapi.yaml; recipe connected_app; recipe restaurant_back_office; recipe stock_alerts; the MCP server; the request collection; retail core · Fields: 15

Read and write it

Every call runs as your app's own user, with its key in one header, at the retailer's own address. The user reads and writes only what its role allows: your app's user, and the rights the retailer gives it.

Read a list (only name unless you ask for fields):

curl -s "https://⟨site⟩/api/resource/Bin?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one:

curl -s "https://⟨site⟩/api/resource/Bin/⟨name⟩" -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Your app reads it; it does not write it here: iVendNext keeps it from every stock document; move stock with a Stock Entry. All the record calls and their answers: the API reference.

Samples that use it

s2_bins · s7_system_sync · s27_stock_alerts · s45_restaurant_back_office

Fields

Read from the product at POS 2.1.0.667 (till app 60147699c): its own fields, the fields iVendNext adds to it, and iVendNext's changes to any of them. Read-only fields are set by iVendNext; a hidden one is not on the form but can be read. Every record also has name (its id, in the address), owner, creation, modified, modified_by and docstatus (0 a draft, 1 submitted, 2 cancelled), all read-only.

Field Field name Type Required Read-only Hidden Links to
Item Code item_code Link yes yes Item
Warehouse warehouse Link yes yes Warehouse
Actual Qty actual_qty Float yes
Planned Qty planned_qty Float yes
Requested Qty indented_qty Float yes
Ordered Qty ordered_qty Float yes
Projected Qty projected_qty Float yes
Reserved Qty reserved_qty Float yes
Reserved Qty for Production reserved_qty_for_production Float yes
Reserved Qty for Subcontract reserved_qty_for_sub_contract Float yes
Reserved Qty for Production Plan reserved_qty_for_production_plan Float yes
Reserved Stock reserved_stock Float yes
UOM stock_uom Link yes UOM
Valuation Rate valuation_rate Float yes
Stock Value stock_value Float yes

All record types · What you can use

This record type in the kit