iVendNextDevelopers Request a sandbox

Item Label Printing

A list of item labels waiting to be printed, filled by a handheld and printed from the back office.

Area: Items · Why it is here: guide chapter 12 · Fields: 5

iVendNext's own description: Print labels with item information, prices, and barcodes.

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%20Label%20Printing?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%20Label%20Printing/⟨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%20Label%20Printing" -H "Authorization: token ⟨api key⟩:⟨api secret⟩" \
  -H "Content-Type: application/json" -d '{"format": …, "warehouse": …}'

Change one with PUT /api/resource/Item%20Label%20Printing/⟨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.

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
Format format Link yes Thermal Label
Source source Select yes one of: None, Stock Entry, Purchase Receipt
Store warehouse Link yes Warehouse
Preview image_url Attach Image
table_printing_detail table_printing_detail Table Item Label Printing Detail

Table: Item Label Printing Detail

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

Field Field name Type Required Read-only Hidden Links to
Item item Link Item
Description description Data
Quantity To Print quantity_to_print Int
Price price Currency
Serial / Batch Number serial_batch_number Dynamic Link
Bar Code bar_code Data
Weight weight Float
UOM uom Link UOM
Store store Data yes
Serial / Batch DocType serial_batch_doctype Select yes one of: Serial No, Batch

All record types · What you can use

This record type in the kit