Serial No
One unit of an item with its own number, such as a phone's IMEI.
Area: Batches and serial numbers · Why it is here: openapi.yaml; recipe units_as_serials; the MCP server; the request collection; retail core · Fields: 24
iVendNext's own description: Distinct unit of an Item
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/Serial%20No?fields=%5B%22*%22%5D&limit_page_length=20" \
-H "Authorization: token ⟨api key⟩:⟨api secret⟩"
Read one:
curl -s "https://⟨site⟩/api/resource/Serial%20No/⟨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/Serial%20No" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
-H "Content-Type: application/json" -d '{"serial_no": …, "item_code": …, "company": …}'
Change one with PUT /api/resource/Serial%20No/⟨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
s5_config_pack · s30_units_as_serials
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 |
|---|---|---|---|---|---|---|
| Serial No | serial_no |
Data | yes | |||
| Item Code | item_code |
Link | yes | Item | ||
| Batch No | batch_no |
Link | yes | Batch | ||
| Warehouse | warehouse |
Link | yes | Warehouse | ||
| Incoming Rate | purchase_rate |
Float | yes | |||
| Status | status |
Select | yes | one of: Active, Inactive, Consumed, Delivered, Expired | ||
| POS Sold Via (claim) (added by iVendNext) | custom_mpos_sold_via |
Data | yes | |||
| Item Name | item_name |
Data | yes | |||
| Description | description |
Text | yes | |||
| Item Group | item_group |
Link | yes | Item Group | ||
| Brand | brand |
Link | yes | Brand | ||
| Asset | asset |
Link | yes | Asset | ||
| Asset Status | asset_status |
Select | yes | one of: Issue, Receipt, Transfer | ||
| Location | location |
Link | yes | Location | ||
| Employee | employee |
Link | yes | Employee | ||
| Warranty Expiry Date | warranty_expiry_date |
Date | ||||
| AMC Expiry Date | amc_expiry_date |
Date | ||||
| Maintenance Status | maintenance_status |
Select | yes | one of: Under Warranty, Out of Warranty, Under AMC, Out of AMC | ||
| Warranty Period (Days) | warranty_period |
Int | yes | |||
| Company | company |
Link | yes | Company | ||
| Work Order | work_order |
Link | Work Order | |||
| Creation Document No | purchase_document_no |
Data | yes | |||
| Barcode (added by iVendNext) | custom_serial_barcode |
Data | ||||
| Serial Expiry Date (added by iVendNext) | custom_serial_expiry_date |
Date |