Item

A product the retailer sells, buys or keeps in stock: its code, name, group, unit, barcodes and whether it has serial numbers or lots.

Area: Items · Why it is here: openapi.yaml; api/README.md; contract fields; guide chapter 02; guide chapter 07; recipe age_check; recipe bulk_reads; recipe duty_free_allowance; recipe integration_user; recipe optical_prescriptions; recipe print_pack; recipe stock_alerts; recipe system_sync; sample S2; sample S23; sample S27; sample S36; sample S37; sample S39; sample S40; sample S42; sample S45; the MCP server; the kit's tool sign_in; the request collection; retail core · Fields: 104

iVendNext's own description: A Product or a Service that is bought, sold or kept in stock.

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

Read one, with its tables:

curl -s "https://⟨site⟩/api/resource/Item/⟨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/Item" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"item_code": …, "item_group": …, "stock_uom": …}'

Change one with PUT /api/resource/Item/⟨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

s1_warranty · s2_bins · s3_price_audit · s5_config_pack · s7_system_sync · s8_estate_rollout · s11_approvals · s14_approvals_stores · s16_pick_route · s18_rule_guard · s19_unit_codes · s23_till_guard · s25_gift_on_spend · s27_stock_alerts · s29_print_pack · s30_units_as_serials · s36_duty_free · s37_age_check · s38_expiry_markdown · s39_pharmacy_counter · s40_expiry_recall · s42_optical_prescriptions · s43_third_party_payer · s45_restaurant_back_office · s52_phone_plans

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.

Table: Cross Selling Product Detail

The rows of custom_cross_selling_product_details. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Barcode

The rows of barcodes. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Customer Detail

The rows of customer_items. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Default

The rows of item_defaults. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Reorder

The rows of reorder_levels. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Supplier

The rows of supplier_items. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Tax

The rows of taxes. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Item Variant Attribute

The rows of attributes. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Retail Item Option Group

The rows of custom_mpos_option_groups. Each row also has idx (its place), parent, parentfield and parenttype.

Table: Surcharge List

The rows of custom_surcharges. Each row also has idx (its place), parent, parentfield and parenttype.

Table: UOM Conversion Detail

The rows of uoms. Each row also has idx (its place), parent, parentfield and parenttype.

All record types · What you can use

This record type in the kit