Skip to main content

catalog — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module idcatalog
NameCatalog
Version1.6.0
Ships from@endora-commerce/mod-catalog
LicenceMIT

Activation​

This module cannot be switched off. Products, variants and categories. A commerce platform without a catalogue is a different product, not a reduced one.

Dependencies​

ModuleBindingWhat it means
_i18nyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
admin_rolesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
admin_usersyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
assets_libraryyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
audit_logsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
custom_fieldsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
emailyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
sales_channelsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
taxesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
organizationsgating onlyresolves organizationDetailsPort; withheld from dependencies because the install order cannot carry the edge
organizationsgating onlyresolves organizationTaxProfilePort; withheld from dependencies because the install order cannot carry the edge
price_listsgating onlyresolves pricingService; withheld from dependencies because the install order cannot carry the edge
admin_notificationsnodegrades-without adminNotificationRecordPort — bulk edits and search reindexes still run and still report on the Bulk actions page; only the bell entry is missing — the completion e-mail to the admin still goes out
admin_searchnocontributes-to adminSearchProviderRegistry
api_keysnodegrades-without requireApiKey — the external catalog namespace stops accepting machine-to-machine callers
api_keysnodegrades-without requireBoundApiKey — the external catalog namespace stops accepting machine-to-machine callers
inventorynodegrades-without inventoryAvailabilityPort — product listings and the external catalog namespace stop carrying an availability band
inventorynodegrades-without inventoryProductThresholdWritePort — a duplicated product does not inherit the source’s per-warehouse low-stock thresholds
prompt_actionsnocontributes-to promptActionBulkProgressRegistry
prompt_actionsnocontributes-to promptActionToolRegistry
searchnodegrades-without searchQueryPort — the storefront product listing is served from PostgreSQL instead of the search index
searchnodegrades-without searchReindexPort — an attribute’s searchable flip rebuilds no search index
seonodegrades-without seoProductMetaPort — product pages show metadata derived from the name and description, and old URL keys answer not-found
seonorefuses-without seoProductMetaWritePort — a product save that changes SEO fields is refused while SEO is off; saves without SEO changes, and duplicates, are unaffected
webhooksnocontributes-to webhookEventRegistry

Permissions​

CodeLabelAlso needs
catalog:writeEdit catalogcatalog:read

Command palette​

ActionOpensPermission
new-product/catalog/products/newcatalog:write
open-archived-products/catalog/products/archivedcatalog:read
open-attachment-types/catalog/attachment-typescatalog:read
open-attribute-sets/catalog/attribute-setscatalog:read
open-attributes/catalog/attributescatalog:read
open-bulk-operations/catalog/bulk-operationscatalog:read
open-categories/catalog/categoriescatalog:read
open-products/catalog/productscatalog:read

Settings​

CodeNameType
catalog.scope_completeness_gateCompleteness check when switching a product onstring

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

None.