In this section · 4 articles

Product Catalog fields and permissions

Every field on the product, category, brand, collection, media and bundle forms, with their limits, the settings your server sets, and the permissions that control each screen and action.

Applies to
Product Catalog 1.3 and later
Who can do this
Platform owner, Administrator
Where
Catalog › Products
On this page

Product

Catalog › Products. See Add and publish a product.

CardFieldRules and notes
IdentityNameRequired. Up to 255 characters. Per language.
SlugRequired. Up to 191 characters. Unique. Can't be changed once the product has been published.
Short descriptionUp to 500 characters. Per language. Used as the description on CRM quote lines.
DescriptionDescriptionThe full description. Per language.
SpecificationsSpecificationsRows of a label (up to 120 characters, required) and a value (up to 500). Per language.
OrganisationTypeRequired. Physical, Digital, Service, Subscription, Bundle or Hybrid. A label for filtering and reports only.
BrandOptional. One of your brands.
StructureVariantsHas variants or Single SKU. Switches to Has variants when you generate variants.
BundleTurn on for a product made of other items. Needed before you can add Bundle contents.
CommerceTax classUp to 60 characters. A label, such as standard, carried onto CRM quote lines as the tax code. Billing 2.0.0 doesn't use it.
Search enginesMeta title, Meta descriptionUp to 255 and 500 characters. Per language.
Additional fieldsYour custom fieldsSee How custom fields work.

The list also shows Status (Draft, Active, Archived), and in the columns menu Published, Origin (where a copied product came from), Tax class, Variants, Bundle, Created At and who created it (headed general.created_by). Each row links to Variant matrix, Media and Bundle contents, and has Publish, Archive and Duplicate actions. In Product Catalog 1.4.0 those three answer 1 processed but don't change the product, and no copy is made.

Category

Catalog › Categories. See Set up categories and brands.

The Create Categories drawer, with the required Name and Slug fields, a Parent selector, an Image upload area, a Visibility switch and a Sort Order field, plus Cancel and Save.
FieldRules and notes
NameRequired. Up to 255 characters.
SlugRequired. Up to 191 characters.
ParentThe category this one sits under. Empty for a top-level category. Up to 6 levels deep.
ImageOptional.
VisibilityVisible or Hidden.
Sort orderA number. Lower comes first.

The list also shows Depth: 0 for a top-level category, 1 for one level down, and so on.

Brand

Catalog › Brands.

The Create Brands drawer, with the required Name, Slug and Status fields, a Logo upload area, Website and Sort Order fields, plus Cancel and Save.
FieldRules and notes
NameRequired. Up to 255 characters.
SlugRequired. Up to 191 characters.
LogoOptional.
WebsiteOptional. A full address, up to 255 characters.
StatusRequired. Active or Inactive.
Sort orderA number. Lower comes first.

Collection

Catalog › Collections. See Group products into collections.

The Create Collections drawer, with the required Name, Slug, Kind and Status fields, Rules key–value rows, Description, an Image upload area, the Visible toggle, Starts and Ends dates, and Sort Order.
FieldRules and notes
NameRequired. Up to 255 characters.
SlugRequired. Up to 191 characters.
KindRequired. Manual (products you pick) or Dynamic (products that match the rules).
RulesDynamic collections only. Keys: product_type, brand_id, category_id, capability, status, tax_class. All rules must match.
Description, ImageOptional.
StatusRequired. Active or Inactive.
VisibleOn or off.
Starts, EndsOptional dates. Ends can't be before Starts.
Sort orderA number. Lower comes first.

Media

The product's Media link. See Add images and files to a product.

The Create Media drawer for a product, with File (up to 50 MB), Kind, Role, Alt text and Caption in several languages, and the Downloadable and Public switches.
FieldRules and notes
FileRequired. Up to 50 MB.
KindRequired. Image, Video, Document or Digital asset. Can't be changed after saving.
RoleRequired. Gallery, Thumbnail, Banner, Download, Manual or Spec sheet.
Alt text, CaptionUp to 255 and 500 characters. Per language.
DownloadableWhether the file is handed out through a download link.
PublicWhether the file has a public address. Always off for a Digital asset.
Original nameUp to 255 characters.
Sort orderThe order files are shown in.

The list can also show Type, Size and Downloads.

Bundle contents

The product's Bundle contents link. See Build a bundle.

The Create Bundle contents drawer, with Component, Source, Reference, Quantity, the Optional switch, Pricing set to Fixed amount, and Fixed price (minor units).
FieldRules and notes
ComponentThe name shown for the item. Filled in for you if you leave it empty.
SourceRequired. Where the item comes from, such as catalog.product. Can't be changed after saving.
ReferenceRequired. The item's id in that source. Can't be changed after saving.
QuantityRequired. More than 0.
OptionalWhether the customer may leave it out.
PricingRequired. Component price, Fixed amount or Included free.
Fixed price (minor units)Required with Fixed amount. In the currency's smallest unit: 1999 is 19.99.
CurrencyRequired with Fixed amount. A three-letter code, such as USD.
Sort orderThe order of the contents.

On Laramin Core 12.8.7 and earlier, the sort order fields, the bundle's currency field and the product list's created-by column show internal names, general.sort_order, general.currency and general.created_by, instead of the labels Sort Order, Currency and Created By.

Settings your server sets

These can't be changed on screen. Whoever manages your server can change them in your Laramin's environment file.

SettingDefaultWhat it does
CATALOG_DEFAULT_CURRENCYUSDThe currency used when a price is asked for without one.
CATALOG_MAX_VARIANT_MATRIX500The most variants one generation may create.
CATALOG_MAX_BUNDLE_DEPTH5How many levels bundles may nest inside each other.
CATALOG_CATEGORY_MAX_DEPTH6How deep the category tree may go.
CATALOG_DOWNLOAD_TTL900How long a download link works, in seconds.
CATALOG_SKU_PATTERNUppercase letters, digits, dots, dashes and underscores, 2 to 64 charactersWhat a valid SKU looks like.

Permissions

In the role editor, the permissions are grouped under Products, Taxonomy, Attributes, Pricing and Product Media. Each resource has List, View, Create, Edit, Delete, Restore and Remove permissions, such as Create Category (feature.pcat.category.create). Remove deletes forever.

The role editor's Product Catalog band, with permissions grouped under Attributes, Pricing, Product Media, Products and Taxonomy. Each resource has List to Remove columns, and all are set to None.
ResourceKey prefixExtra permissions
Productsfeature.pcat.productPublish Product (.publish), Archive Product (.archive), Duplicate Product (.duplicate), Export Products (.export), and (Own) versions of List, View, Edit, Delete, Restore and Remove
Variantsfeature.pcat.variantGenerate Variant Matrix (.bulk_generate)
Bundle contentsfeature.pcat.bundle
Categoriesfeature.pcat.category
Brandsfeature.pcat.brand
Collectionsfeature.pcat.collection
Attributesfeature.pcat.attribute, feature.pcat.attribute_value
Pricesfeature.pcat.priceBulk Update Prices (.bulk_update)
Mediafeature.pcat.mediaDownload Product Asset (.download), and (Own) versions as for products

What the screens check:

ToYou need
Open Catalog › ProductsList Product or List Product (Own)
Open the Variant matrixList Variant. To preview, View Variant. To create variants, Generate Variant Matrix.
Work with Bundle contentsCreate Bundle, Edit Bundle, Delete Bundle and so on
Work with MediaCreate Media, Edit Media (or its (Own) version) and so on
Download a digital assetDownload Product Asset, and being signed in

The Attributes and Prices permissions grant nothing in Product Catalog 1.4.0, because no screen manages attributes or prices.

To give these permissions, see Give someone a role.