iVendNextDevelopers Request a sandbox

Batch

A lot of an item, with its expiry date: what a recall or a markdown by expiry acts on.

Area: Batches and serial numbers · Why it is here: recipe expiry_markdown; recipe stock_alerts; sample S23; sample S40; retail core · Fields: 18

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/Batch?fields=%5B%22*%22%5D&limit_page_length=20" \
  -H "Authorization: token ⟨api key⟩:⟨api secret⟩"

Read one:

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

Create one (the required fields first), if your app's role may:

curl -s -X POST "https://⟨site⟩/api/resource/Batch" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"batch_id": …, "item": …}'

Change one with PUT /api/resource/Batch/⟨name⟩ and the fields you change; a table sent there replaces its rows, so send its existing rows too. All the record calls and their answers: the API reference.

Samples that use it

s19_unit_codes · s23_till_guard · s27_stock_alerts · s30_units_as_serials · s38_expiry_markdown · s40_expiry_recall

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
Disabled disabled Check
Use Batch-wise Valuation use_batchwise_valuation Check yes
Batch ID batch_id Data yes
Item item Link yes Item
Item Name item_name Data yes
image image Attach Image yes
Parent Batch parent_batch Link yes Batch
Manufacturing Date manufacturing_date Date
Batch Quantity batch_qty Float yes
Batch UOM stock_uom Link yes UOM
Expiry Date expiry_date Date
Supplier supplier Link yes Supplier
Source Document Type reference_doctype Link yes DocType
Source Document Name reference_name Dynamic Link yes
Batch Description description Small Text
Qty To Produce qty_to_produce Float yes
Produced Qty produced_qty Float yes
Barcode (added by iVendNext) custom_batch_barcode Data

All record types · What you can use

This record type in the kit