Item
Staff guide for searching, creating, updating, and archiving catalog items.
What Is An Item?
An item is the main catalog record for a product. Staff use items when they need to look up product names, barcodes, codes, brands, units, tax flags, scale-label details, bundle relationships, or archived products.
Items are used across purchasing, warehouse, sales, retail, labels, and reporting, so item changes should be made carefully.
Where To Find It
Open Catalog > Items in the Web client.
| Screen | Route | Use it to |
|---|---|---|
| All Items | /v2/item/all | Search normal active items. |
| Scale Items | /v2/item/scale | Search items sold through a scale. |
| Fixed Items | /v2/item/fixed | Search non-scale fixed barcode items. |
| Bundle Items | /v2/item/bundle | Search parent items that have bundle child items. |
| Archived Items | /v2/item/archived | Search archived items. |
| New Item | /v2/item/:filter/new | Create a new item from an active item list. |
| Edit Item | /v2/item/:filter/:id | Update item details or archive an item. |
Required Fields
| Field | Required? | Notes |
|---|---|---|
| Name (Eng) | Yes | English item name. |
| Name (Kor) | Yes | Korean item name. |
| Barcode | Yes | Must be checked before saving. |
| UOM | No | Unit of measure. Defaults to EA when left blank. |
| Default RFD | Yes | Refrigerated, frozen, or dry. |
| Invoice Name | No | Uses the English name when left blank. |
Optional Fields
| Field | Notes |
|---|---|
| Image | Uploads the item thumbnail. |
| Code | Internal or supplier-facing item code. |
| Brand | Select an existing brand. |
| Retail Taxable | Marks the item as taxable for retail. |
| Wholesale Taxable | Marks the item as taxable for wholesale. |
| Point Excluded | Excludes the item from point earning. |
| Parent Item | Connects this item as a bundle child of another item. |
| Bundle Qty | Required when a parent item is selected. Must be at least 2. |
| Scale Item | Enables scale-label settings. |
| Fixed Weight | For scale items that use a fixed printed weight. |
| Used By | Number of days until expiry for scale-label use. |
| Ingredients | Optional scale-label ingredients text. |
| Archived | Edit only. Hides the item from normal active item lists. |
Category Placeholder
Category is pending redesign
The Item form currently shows the number of selected categories, but category selection is disabled. Do not treat category assignment as part of this Item role slice. Category behavior will be designed separately.
Create An Item
- Open an active item list such as
Catalog > Items > All Items. - Click
New item. - Enter the required names and barcode.
- Click
Checknext to the barcode. - Fill in optional fields such as code, brand, tax flags, bundle, or scale details.
- Save.
After saving, the page returns to the item list.
Update An Item
- Open an item list.
- Search for the item.
- Open the item.
- Update the details.
- If the barcode changed, click
Checkagain. - Save.
Archive An Item
Use Archived when an item should no longer appear in normal active item lists.
- Open the item.
- Turn on
Archived. - Save.
Archived items remain searchable from Archived Items.
Search Items
Use the search box on the item list. Search checks item names, invoice name, barcode, code, brand name, and bundle child item details.
When the search has multiple words, every word must match somewhere in the item or its bundle child items.
Item Types And Badges
| Badge | Meaning |
|---|---|
| Scale | The item is sold through a scale. |
| Fixed | The item is a fixed barcode item. |
| Bundle | The item is a bundle child item. |
| Parent | The item is its own parent/base item. |
| Temp | The item was created as a temporary item and still needs review. |
| Archived | The item is hidden from normal active lists. |
Required Roles
Item read access is public to authenticated company users. There is no separate item.read role.
| Action | Required role |
|---|---|
| Search items | Authenticated company user |
| View an item | Authenticated company user |
| Create an item | item.manage |
| Update an item | item.manage |
| Archive or unarchive an item | item.manage |
Common Problems
| Problem | What it means |
|---|---|
Please validate the barcode first | The barcode has not been checked yet, or it changed after the last check. |
Barcode already exists | Another item already uses the same barcode. |
Scale barcode must be 7 digits | Scale items must use a 7 digit product barcode. |
Name (Eng) is required | The English item name is empty. |
Name (Kor) is required | The Korean item name is empty. |
Parent item is required | Bundle settings are on, but no parent item is selected. |
Bundle qty must be at least 2 | Bundle child quantity must be 2 or more. |