Item Group
A branch of the retailer's product tree, such as Beverages under Food, which rules and reports use to treat many items at once.
Area: Items · Why it is here: recipe age_check; recipe duty_free_allowance; recipe optical_prescriptions; sample S31; sample S36; sample S37; sample S38; sample S39; sample S42; retail core · Fields: 12
iVendNext's own description: An Item Group is a way to classify items based on types.
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%20Group?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%20Group/⟨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%20Group" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"item_group_name": …}'
Change one with PUT /api/resource/Item%20Group/⟨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 · s18_rule_guard · s31_parent_groups · s36_duty_free · s37_age_check · s38_expiry_markdown · s39_pharmacy_counter · s42_optical_prescriptions · s43_third_party_payer · 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.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Item Group Name | item_group_name |
Data | yes | |||
| Parent Item Group | parent_item_group |
Link | Item Group | |||
| Is Group | is_group |
Check | ||||
| Excluded From Staff Rate (added by iVendNext) | custom_mpos_staff_rate_excluded |
Check | ||||
| Image | image |
Attach Image | yes | |||
| Item Group Defaults | item_group_defaults |
Table | Item Default | |||
| Taxes | taxes |
Table | Item Tax | |||
| lft | lft |
Int | yes | |||
| old_parent | old_parent |
Link | yes | Item Group | ||
| rgt | rgt |
Int | yes | |||
| Kitchen Station (added by iVendNext) | custom_mpos_kitchen_station |
Link | Retail Kitchen Station | |||
| POS: Sell Only When Connected (added by iVendNext) | custom_mpos_online_only |
Check |
Table: Item Default
The rows of item_group_defaults. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Company | company |
Link | yes | Company | ||
| Default Warehouse | default_warehouse |
Link | Warehouse | |||
| Default Price List | default_price_list |
Link | Price List | |||
| Default Discount Account | default_discount_account |
Link | Account | |||
| Default Buying Cost Center | buying_cost_center |
Link | Cost Center | |||
| Default Supplier | default_supplier |
Link | Supplier | |||
| Default Expense Account | expense_account |
Link | Account | |||
| Default Provisional Account | default_provisional_account |
Link | Account | |||
| Default Selling Cost Center | selling_cost_center |
Link | Cost Center | |||
| Default Income Account | income_account |
Link | Account | |||
| Deferred Expense Account | deferred_expense_account |
Link | Account | |||
| Deferred Revenue Account | deferred_revenue_account |
Link | Account |
Table: Item Tax
The rows of taxes. Each row also has idx (its place), parent, parentfield and parenttype.
| Field | Field name | Type | Required | Read-only | Hidden | Links to |
|---|---|---|---|---|---|---|
| Item Tax Template | item_tax_template |
Link | yes | Item Tax Template | ||
| Tax Category | tax_category |
Link | Tax Category | |||
| Valid From | valid_from |
Date | ||||
| Minimum Net Rate | minimum_net_rate |
Float | ||||
| Maximum Net Rate | maximum_net_rate |
Float | ||||
| Warehouse (added by iVendNext) | custom_warehouse |
Link | Warehouse |