Who works where
Options, option values and categories belong to the organization. Every company of the organization sees the same ones, whichever company created them. Listing categories can be narrowed to the categories of one company, but this only filters the list.Define an option and its values
Fifamè opens Create a product option and names it “size”. She must give at least one value at once, for example “33 cl” and “65 cl”. Exowpee stores the name and the values in lower case, so “Size” and “size” are the same option. When a new bottle arrives, she adds its value with Add an option value. To see what an option offers, she uses List option values or View an option value. All options are listed with List product options, and one option is read with View a product option.Correct names
A typo is corrected with Rename a product option or Edit an option value. Renaming an option does not touch its values: those are managed one by one.Remove what nobody uses
Fifamè created an option “colour” by mistake. Delete a product option removes it with all its values, but only if no product variant uses it. A single value is removed with Delete an option value, under the same condition.Create the categories
Next she builds the families. She uses Create a category with a title and a position in the list, and optionally a picture. The position is how she orders “Beers” before “Water” on the screens. If she gives no handle, Exowpee builds one from the title. Categories also carry tax settings. She can say whether the category is taxable and choose its VAT rate while creating it, or leave them for later and use Apply taxes to products and orders. When she gives no tax setting, the category is created as not taxable, with no VAT rate.Change or retire a category
Edit a category changes the title, the position, the picture, the taxable flag or the VAT rate. A new picture replaces the old one, and the old file is deleted. Changing the tax settings of a category changes how the items that follow it are taxed. When the depot stops selling water, she deletes the category with Delete a category. The category must be empty first: no product or bundle may still belong to it. Categories are found again with List categories and View a category.The rules
- The name of an option is required, unique in the organization, and stored in lower case.
- Creating an option needs at least one value. Values are strings of at most 255 characters, distinct from each other, stored trimmed and in lower case.
- A value is unique within its option, compared after trimming and lower-casing.
- Updating an option changes its name only. Values are not accepted there.
- An option or a value cannot be deleted while a product variant uses it. Deleting an option deletes its values. Nothing is kept as a deleted record.
- The handle of a category is unique in the organization. It is generated from the title when omitted.
- A category needs a title and a position on creation. On update every field is optional and omitted fields keep their value.
- The picture of a category is a jpeg, png, jpg, gif or svg file of at most 2048 KB.
- Creating or editing a category can set its taxable flag and VAT rate, which also needs the permission to update category taxes. Its other taxes are set with Set a category’s taxes.
- A category cannot be deleted while a product or a bundle belongs to it. Its picture file is deleted with it.
- A tax change on a category is refused when it would make a stored price of one of its items impossible to calculate.
All the actions of this topic
- List categories: Browse product categories, filtered by title or company.
- Create a category: Adds a product category with a title, order and optional image.
- View a category: Shows one product category.
- Edit a category: Changes a category’s title, order, image or tax settings.
- Delete a category: Deletes a category that is no longer used.
- List product options: Lists product options such as size or colour, filtered by name.
- Create a product option: Creates an option (for example size) together with its first values.
- View a product option: Shows one option such as size or colour.
- Rename a product option: Changes the name of an option.
- Delete a product option: Deletes an option and its values when no product uses it.
- List option values: Lists the values of an option, such as the sizes available.
- Add an option value: Adds a new value (for example “large”) to an option.
- View an option value: Shows one value of an option.
- Edit an option value: Changes the text of an option value.
- Delete an option value: Deletes an option value that no variant uses.