Manage Categories
- Kian Stack
- Andrew Schmitt
- Ryan Northfield (Deactivated)
To perform administration actions on Categories, navigate to Project Settings > Checkout > Categories.
Only users with the Administrators project role can view and edit the Categories administration page in Checkout.
Categories are used in Checkout to help organize Items and Bundles. Each Item and Bundle created requires a Category in order to be created. On the customer portal, customers can use Categories to filter the Items and Bundles they see.
Add Categories
Adding Categories is easy to do. To add a Category, click on Add Category and fill out the form.
Creating a Category requires the following attributes:
Category Name
Short Description
You can optionally set the following:
Icon
By creating a Category, a corresponding Asset Type will also be created.
Edit Categories
Categories can be modified by clicking on the Edit icon.
Administrators can use the edit screen to modify the name and description, icon, configured fields, visibility, and add additional items to the Category.
Be sure to click Save Changes to propagate changes to the Category.
Configure Fields
Each category has configured fields that set the base fields required on any items in the category.
If you uncheck a field, it will not appear in the form for adding a new item or editing an existing item, even if that field has a value.
The “Display in Catalog” toggle determines if checked fields display in the portal catalog.
These fields will appear in the Add Item and Edit Item dialogs.
If you would like to add fields of your own, you can select the “Custom” tab and select previously created custom fields, or create a new one from the drop-down list.
The Add Category Field dialog will appear, where you can enter the Name, Description, and Field Type for your new Custom Field.
This page allows you to add a new custom field directly, or edit or delete previously created custom fields.
Custom category fields will appear in the “Extra attributes” tab on the Add or Edit Item dialogs of Items or Bundles within that category.
The custom category fields will also appear in the portal catalog when the customer selects an item in the catalog.
If the “Edit in Catalog” toggle show in the Add or Edit Item dialog is toggled, then the customer will be able to edit the field, whatever type it may be, in the catalog as they add it to the cart.
The Agent then will be able to see this attribute in the Order ticket between the item image and the quantity.
If the Agent selects the item in the Order ticket, the attribute information will appear there as well.
As the Agent assigns inventory to the Order, or receives the item into inventory (after submitting the Order), the Agent will be able to set the attribute to the correct option so that the Asset will likewise have the attribute.
The resulting Asset, when viewed by an Agent in the Checkout hub, will have the attribute thus set.
Delete Categories
Categories can be removed from use by deleting them out of the administration section.
In order to delete a Category, it must not be tied to any existing Items or Bundles.
To quickly see the Items or Bundles tied to a Category, click on the Edit icon for the Category, and look under the Associate Items to Category heading.
There are two ways to change the Category of an existing item:
Open up one of the other Categories and use the Associate Items to Category to add and existing Item to the Category.
Navigate into the Items tab and edit an Item.
Categories can be deleted by clicking on the delete button, or by using the Batch Delete functionality.
To Batch delete navigate to … > Batch Delete
Import Categories
To import categories, follow the instructions in the Importing Configurations into Checkout page.
Export Categories
To export the Categories, select … > Export. This will generate a CSV file of the current Categories with the columns ID,Name,Description.
This export file could be used to import into other Checkout projects.