@endora-commerce/mod-catalog 0.108.0 → 0.109.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/admin/components/AttachmentScopesDialog.d.ts +22 -0
- package/dist/admin/components/AttachmentScopesDialog.d.ts.map +1 -0
- package/dist/admin/components/AttachmentScopesDialog.js +70 -0
- package/dist/admin/components/AttachmentScopesDialog.js.map +1 -0
- package/dist/admin/components/PackagingUnitsEditor.d.ts +7 -1
- package/dist/admin/components/PackagingUnitsEditor.d.ts.map +1 -1
- package/dist/admin/components/PackagingUnitsEditor.js +82 -11
- package/dist/admin/components/PackagingUnitsEditor.js.map +1 -1
- package/dist/admin/components/ProductAttachmentsSection.d.ts +5 -0
- package/dist/admin/components/ProductAttachmentsSection.d.ts.map +1 -0
- package/dist/admin/components/ProductAttachmentsSection.js +137 -0
- package/dist/admin/components/ProductAttachmentsSection.js.map +1 -0
- package/dist/admin/components/ProductGallerySection.d.ts +14 -0
- package/dist/admin/components/ProductGallerySection.d.ts.map +1 -0
- package/dist/admin/components/ProductGallerySection.js +385 -0
- package/dist/admin/components/ProductGallerySection.js.map +1 -0
- package/dist/admin/components/ProductOrderRulesCard.d.ts.map +1 -1
- package/dist/admin/components/ProductOrderRulesCard.js +134 -6
- package/dist/admin/components/ProductOrderRulesCard.js.map +1 -1
- package/dist/admin/components/ProductScopeControls.d.ts +31 -0
- package/dist/admin/components/ProductScopeControls.d.ts.map +1 -0
- package/dist/admin/components/ProductScopeControls.js +243 -0
- package/dist/admin/components/ProductScopeControls.js.map +1 -0
- package/dist/admin/components/ProductScopeEditor.d.ts +12 -18
- package/dist/admin/components/ProductScopeEditor.d.ts.map +1 -1
- package/dist/admin/components/ProductScopeEditor.js +5 -4
- package/dist/admin/components/ProductScopeEditor.js.map +1 -1
- package/dist/admin/components/ProductScopeOverview.d.ts +26 -0
- package/dist/admin/components/ProductScopeOverview.d.ts.map +1 -0
- package/dist/admin/components/ProductScopeOverview.js +207 -0
- package/dist/admin/components/ProductScopeOverview.js.map +1 -0
- package/dist/admin/components/ProductStatusPills.d.ts +17 -0
- package/dist/admin/components/ProductStatusPills.d.ts.map +1 -0
- package/dist/admin/components/ProductStatusPills.js +23 -0
- package/dist/admin/components/ProductStatusPills.js.map +1 -0
- package/dist/admin/components/ProductUrlKeysPanel.d.ts +17 -0
- package/dist/admin/components/ProductUrlKeysPanel.d.ts.map +1 -0
- package/dist/admin/components/ProductUrlKeysPanel.js +215 -0
- package/dist/admin/components/ProductUrlKeysPanel.js.map +1 -0
- package/dist/admin/components/ProductsBulkEditDialog.d.ts +30 -0
- package/dist/admin/components/ProductsBulkEditDialog.d.ts.map +1 -1
- package/dist/admin/components/ProductsBulkEditDialog.js +288 -133
- package/dist/admin/components/ProductsBulkEditDialog.js.map +1 -1
- package/dist/admin/components/ScopedDialogParts.d.ts +23 -0
- package/dist/admin/components/ScopedDialogParts.d.ts.map +1 -0
- package/dist/admin/components/ScopedDialogParts.js +16 -0
- package/dist/admin/components/ScopedDialogParts.js.map +1 -0
- package/dist/admin/index.d.ts +2 -2
- package/dist/admin/index.d.ts.map +1 -1
- package/dist/admin/index.js +9 -0
- package/dist/admin/index.js.map +1 -1
- package/dist/admin/lib/attribute-scope.d.ts +20 -0
- package/dist/admin/lib/attribute-scope.d.ts.map +1 -0
- package/dist/admin/lib/attribute-scope.js +18 -0
- package/dist/admin/lib/attribute-scope.js.map +1 -0
- package/dist/admin/lib/bulk-operation-log-text.d.ts +9 -0
- package/dist/admin/lib/bulk-operation-log-text.d.ts.map +1 -0
- package/dist/admin/lib/bulk-operation-log-text.js +13 -0
- package/dist/admin/lib/bulk-operation-log-text.js.map +1 -0
- package/dist/admin/lib/media-scopes.d.ts +41 -0
- package/dist/admin/lib/media-scopes.d.ts.map +1 -0
- package/dist/admin/lib/media-scopes.js +66 -0
- package/dist/admin/lib/media-scopes.js.map +1 -0
- package/dist/admin/lib/product-labels.d.ts +14 -0
- package/dist/admin/lib/product-labels.d.ts.map +1 -0
- package/dist/admin/lib/product-labels.js +27 -0
- package/dist/admin/lib/product-labels.js.map +1 -0
- package/dist/admin/lib/product-scope-drafts.d.ts +77 -0
- package/dist/admin/lib/product-scope-drafts.d.ts.map +1 -0
- package/dist/admin/lib/product-scope-drafts.js +133 -0
- package/dist/admin/lib/product-scope-drafts.js.map +1 -0
- package/dist/admin/lib/product-scopes-api.d.ts +40 -0
- package/dist/admin/lib/product-scopes-api.d.ts.map +1 -0
- package/dist/admin/lib/product-scopes-api.js +101 -0
- package/dist/admin/lib/product-scopes-api.js.map +1 -0
- package/dist/admin/lib/product-url-keys-api.d.ts +46 -0
- package/dist/admin/lib/product-url-keys-api.d.ts.map +1 -0
- package/dist/admin/lib/product-url-keys-api.js +110 -0
- package/dist/admin/lib/product-url-keys-api.js.map +1 -0
- package/dist/admin/lib/resolve-product-selection.d.ts +29 -1
- package/dist/admin/lib/resolve-product-selection.d.ts.map +1 -1
- package/dist/admin/lib/resolve-product-selection.js +42 -6
- package/dist/admin/lib/resolve-product-selection.js.map +1 -1
- package/dist/admin/lib/scope-overview.d.ts +74 -0
- package/dist/admin/lib/scope-overview.d.ts.map +1 -0
- package/dist/admin/lib/scope-overview.js +173 -0
- package/dist/admin/lib/scope-overview.js.map +1 -0
- package/dist/admin/pages/AttributesManager.d.ts.map +1 -1
- package/dist/admin/pages/AttributesManager.js +84 -7
- package/dist/admin/pages/AttributesManager.js.map +1 -1
- package/dist/admin/pages/BulkOperationDetailPage.d.ts.map +1 -1
- package/dist/admin/pages/BulkOperationDetailPage.js +4 -19
- package/dist/admin/pages/BulkOperationDetailPage.js.map +1 -1
- package/dist/admin/pages/ProductEditor.d.ts +0 -4
- package/dist/admin/pages/ProductEditor.d.ts.map +1 -1
- package/dist/admin/pages/ProductEditor.js +214 -346
- package/dist/admin/pages/ProductEditor.js.map +1 -1
- package/dist/admin/pages/ProductsList.d.ts +12 -0
- package/dist/admin/pages/ProductsList.d.ts.map +1 -1
- package/dist/admin/pages/ProductsList.js +105 -38
- package/dist/admin/pages/ProductsList.js.map +1 -1
- package/dist/backend/admin-search-provider.d.ts +1 -1
- package/dist/backend/admin-search-provider.d.ts.map +1 -1
- package/dist/backend/admin-search-provider.js +1 -2
- package/dist/backend/admin-search-provider.js.map +1 -1
- package/dist/backend/demo/rows.d.ts +7 -0
- package/dist/backend/demo/rows.d.ts.map +1 -1
- package/dist/backend/demo/rows.js +17 -12
- package/dist/backend/demo/rows.js.map +1 -1
- package/dist/backend/demo/seed.js +2 -2
- package/dist/backend/demo/seed.js.map +1 -1
- package/dist/backend/entities/bulk-operation.entity.d.ts +10 -0
- package/dist/backend/entities/bulk-operation.entity.d.ts.map +1 -1
- package/dist/backend/entities/bulk-operation.entity.js.map +1 -1
- package/dist/backend/entities/gallery-item-channel-hidden.entity.d.ts +14 -0
- package/dist/backend/entities/gallery-item-channel-hidden.entity.d.ts.map +1 -0
- package/dist/backend/entities/gallery-item-channel-hidden.entity.js +42 -0
- package/dist/backend/entities/gallery-item-channel-hidden.entity.js.map +1 -0
- package/dist/backend/entities/gallery-item-channel-label.entity.d.ts +18 -0
- package/dist/backend/entities/gallery-item-channel-label.entity.d.ts.map +1 -0
- package/dist/backend/entities/gallery-item-channel-label.entity.js +49 -0
- package/dist/backend/entities/gallery-item-channel-label.entity.js.map +1 -0
- package/dist/backend/entities/gallery-item.entity.d.ts +8 -1
- package/dist/backend/entities/gallery-item.entity.d.ts.map +1 -1
- package/dist/backend/entities/gallery-item.entity.js +11 -0
- package/dist/backend/entities/gallery-item.entity.js.map +1 -1
- package/dist/backend/entities/product-attachment-channel-hidden.entity.d.ts +13 -0
- package/dist/backend/entities/product-attachment-channel-hidden.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-attachment-channel-hidden.entity.js +41 -0
- package/dist/backend/entities/product-attachment-channel-hidden.entity.js.map +1 -0
- package/dist/backend/entities/product-attachment.entity.d.ts +8 -1
- package/dist/backend/entities/product-attachment.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-attachment.entity.js +15 -0
- package/dist/backend/entities/product-attachment.entity.js.map +1 -1
- package/dist/backend/entities/product-channel-language-scope.entity.d.ts +23 -0
- package/dist/backend/entities/product-channel-language-scope.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-channel-language-scope.entity.js +61 -0
- package/dist/backend/entities/product-channel-language-scope.entity.js.map +1 -0
- package/dist/backend/entities/product-channel-scope.entity.d.ts +42 -0
- package/dist/backend/entities/product-channel-scope.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-channel-scope.entity.js +104 -0
- package/dist/backend/entities/product-channel-scope.entity.js.map +1 -0
- package/dist/backend/entities/product-packaging-unit.entity.d.ts +7 -1
- package/dist/backend/entities/product-packaging-unit.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-packaging-unit.entity.js +10 -0
- package/dist/backend/entities/product-packaging-unit.entity.js.map +1 -1
- package/dist/backend/entities/product-url-key.entity.d.ts +32 -0
- package/dist/backend/entities/product-url-key.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-url-key.entity.js +75 -0
- package/dist/backend/entities/product-url-key.entity.js.map +1 -0
- package/dist/backend/entities/product-url-redirect.entity.d.ts +23 -0
- package/dist/backend/entities/product-url-redirect.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-url-redirect.entity.js +58 -0
- package/dist/backend/entities/product-url-redirect.entity.js.map +1 -0
- package/dist/backend/entities/product.entity.d.ts +17 -2
- package/dist/backend/entities/product.entity.d.ts.map +1 -1
- package/dist/backend/entities/product.entity.js +24 -1
- package/dist/backend/entities/product.entity.js.map +1 -1
- package/dist/backend/index.d.ts +24 -2
- package/dist/backend/index.d.ts.map +1 -1
- package/dist/backend/index.js +206 -11
- package/dist/backend/index.js.map +1 -1
- package/dist/backend/plugin.d.ts +44 -3
- package/dist/backend/plugin.d.ts.map +1 -1
- package/dist/backend/plugin.js +67 -9
- package/dist/backend/plugin.js.map +1 -1
- package/dist/backend/prompt-tools.d.ts +10 -0
- package/dist/backend/prompt-tools.d.ts.map +1 -1
- package/dist/backend/prompt-tools.js +108 -4
- package/dist/backend/prompt-tools.js.map +1 -1
- package/dist/backend/routes.admin.d.ts +29 -0
- package/dist/backend/routes.admin.d.ts.map +1 -1
- package/dist/backend/routes.admin.js +123 -54
- package/dist/backend/routes.admin.js.map +1 -1
- package/dist/backend/routes.admin.url-keys.d.ts +23 -0
- package/dist/backend/routes.admin.url-keys.d.ts.map +1 -0
- package/dist/backend/routes.admin.url-keys.js +14 -0
- package/dist/backend/routes.admin.url-keys.js.map +1 -0
- package/dist/backend/routes.api-key.d.ts.map +1 -1
- package/dist/backend/routes.api-key.js +14 -1
- package/dist/backend/routes.api-key.js.map +1 -1
- package/dist/backend/routes.external.d.ts.map +1 -1
- package/dist/backend/routes.external.js +6 -1
- package/dist/backend/routes.external.js.map +1 -1
- package/dist/backend/routes.public.d.ts +24 -7
- package/dist/backend/routes.public.d.ts.map +1 -1
- package/dist/backend/routes.public.js +55 -26
- package/dist/backend/routes.public.js.map +1 -1
- package/dist/backend/routes.public.url-keys.d.ts +26 -0
- package/dist/backend/routes.public.url-keys.d.ts.map +1 -0
- package/dist/backend/routes.public.url-keys.js +17 -0
- package/dist/backend/routes.public.url-keys.js.map +1 -0
- package/dist/backend/services/asset-references.js +43 -30
- package/dist/backend/services/asset-references.js.map +1 -1
- package/dist/backend/services/attachment-packaging-scopes.d.ts +43 -0
- package/dist/backend/services/attachment-packaging-scopes.d.ts.map +1 -0
- package/dist/backend/services/attachment-packaging-scopes.js +115 -0
- package/dist/backend/services/attachment-packaging-scopes.js.map +1 -0
- package/dist/backend/services/attachment.service.d.ts +12 -1
- package/dist/backend/services/attachment.service.d.ts.map +1 -1
- package/dist/backend/services/attachment.service.js +119 -21
- package/dist/backend/services/attachment.service.js.map +1 -1
- package/dist/backend/services/attribute-scope-preview.d.ts +38 -0
- package/dist/backend/services/attribute-scope-preview.d.ts.map +1 -0
- package/dist/backend/services/attribute-scope-preview.js +66 -0
- package/dist/backend/services/attribute-scope-preview.js.map +1 -0
- package/dist/backend/services/bulk-operation.service.d.ts +36 -0
- package/dist/backend/services/bulk-operation.service.d.ts.map +1 -1
- package/dist/backend/services/bulk-operation.service.js +203 -36
- package/dist/backend/services/bulk-operation.service.js.map +1 -1
- package/dist/backend/services/bundle.service.d.ts +9 -1
- package/dist/backend/services/bundle.service.d.ts.map +1 -1
- package/dist/backend/services/bundle.service.js +12 -2
- package/dist/backend/services/bundle.service.js.map +1 -1
- package/dist/backend/services/catalog-admin-search.service.d.ts +1 -1
- package/dist/backend/services/catalog-admin-search.service.js +1 -1
- package/dist/backend/services/catalog-admin.service.d.ts +111 -18
- package/dist/backend/services/catalog-admin.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-admin.service.js +298 -142
- package/dist/backend/services/catalog-admin.service.js.map +1 -1
- package/dist/backend/services/catalog-bulk-import.service.d.ts +24 -2
- package/dist/backend/services/catalog-bulk-import.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-bulk-import.service.js +132 -6
- package/dist/backend/services/catalog-bulk-import.service.js.map +1 -1
- package/dist/backend/services/catalog-bulk-update.service.d.ts +32 -4
- package/dist/backend/services/catalog-bulk-update.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-bulk-update.service.js +107 -11
- package/dist/backend/services/catalog-bulk-update.service.js.map +1 -1
- package/dist/backend/services/catalog-org-price-decorator.d.ts +12 -25
- package/dist/backend/services/catalog-org-price-decorator.d.ts.map +1 -1
- package/dist/backend/services/catalog-org-price-decorator.js +48 -13
- package/dist/backend/services/catalog-org-price-decorator.js.map +1 -1
- package/dist/backend/services/catalog-product-filter.service.d.ts +16 -2
- package/dist/backend/services/catalog-product-filter.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-product-filter.service.js +80 -3
- package/dist/backend/services/catalog-product-filter.service.js.map +1 -1
- package/dist/backend/services/catalog-product-read.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-product-read.service.js +5 -8
- package/dist/backend/services/catalog-product-read.service.js.map +1 -1
- package/dist/backend/services/catalog-query.service.d.ts +135 -38
- package/dist/backend/services/catalog-query.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-query.service.js +683 -354
- package/dist/backend/services/catalog-query.service.js.map +1 -1
- package/dist/backend/services/catalog-quick-search.service.d.ts +18 -2
- package/dist/backend/services/catalog-quick-search.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-quick-search.service.js +52 -20
- package/dist/backend/services/catalog-quick-search.service.js.map +1 -1
- package/dist/backend/services/catalog-write-ports.d.ts +18 -1
- package/dist/backend/services/catalog-write-ports.d.ts.map +1 -1
- package/dist/backend/services/catalog-write-ports.js +77 -0
- package/dist/backend/services/catalog-write-ports.js.map +1 -1
- package/dist/backend/services/category-admin.service.d.ts +12 -1
- package/dist/backend/services/category-admin.service.d.ts.map +1 -1
- package/dist/backend/services/category-admin.service.js +23 -2
- package/dist/backend/services/category-admin.service.js.map +1 -1
- package/dist/backend/services/channel-url-facts.d.ts +17 -0
- package/dist/backend/services/channel-url-facts.d.ts.map +1 -0
- package/dist/backend/services/channel-url-facts.js +20 -0
- package/dist/backend/services/channel-url-facts.js.map +1 -0
- package/dist/backend/services/effective-value.sql.d.ts +56 -0
- package/dist/backend/services/effective-value.sql.d.ts.map +1 -0
- package/dist/backend/services/effective-value.sql.js +111 -0
- package/dist/backend/services/effective-value.sql.js.map +1 -0
- package/dist/backend/services/gallery-scopes.d.ts +40 -0
- package/dist/backend/services/gallery-scopes.d.ts.map +1 -0
- package/dist/backend/services/gallery-scopes.js +151 -0
- package/dist/backend/services/gallery-scopes.js.map +1 -0
- package/dist/backend/services/gallery.service.d.ts +46 -4
- package/dist/backend/services/gallery.service.d.ts.map +1 -1
- package/dist/backend/services/gallery.service.js +308 -46
- package/dist/backend/services/gallery.service.js.map +1 -1
- package/dist/backend/services/linkable-asset.d.ts +21 -0
- package/dist/backend/services/linkable-asset.d.ts.map +1 -0
- package/dist/backend/services/linkable-asset.js +31 -0
- package/dist/backend/services/linkable-asset.js.map +1 -0
- package/dist/backend/services/packaging-unit.service.d.ts.map +1 -1
- package/dist/backend/services/packaging-unit.service.js +76 -45
- package/dist/backend/services/packaging-unit.service.js.map +1 -1
- package/dist/backend/services/primary-asset-url.d.ts +7 -1
- package/dist/backend/services/primary-asset-url.d.ts.map +1 -1
- package/dist/backend/services/primary-asset-url.js +45 -14
- package/dist/backend/services/primary-asset-url.js.map +1 -1
- package/dist/backend/services/product-availability.service.d.ts +79 -0
- package/dist/backend/services/product-availability.service.d.ts.map +1 -0
- package/dist/backend/services/product-availability.service.js +223 -0
- package/dist/backend/services/product-availability.service.js.map +1 -0
- package/dist/backend/services/product-availability.sql.d.ts +71 -0
- package/dist/backend/services/product-availability.sql.d.ts.map +1 -0
- package/dist/backend/services/product-availability.sql.js +77 -0
- package/dist/backend/services/product-availability.sql.js.map +1 -0
- package/dist/backend/services/product-link.service.d.ts +10 -9
- package/dist/backend/services/product-link.service.d.ts.map +1 -1
- package/dist/backend/services/product-link.service.js +32 -22
- package/dist/backend/services/product-link.service.js.map +1 -1
- package/dist/backend/services/product-overrides.service.d.ts +9 -2
- package/dist/backend/services/product-overrides.service.d.ts.map +1 -1
- package/dist/backend/services/product-overrides.service.js +13 -6
- package/dist/backend/services/product-overrides.service.js.map +1 -1
- package/dist/backend/services/product-page-revalidation.d.ts +51 -0
- package/dist/backend/services/product-page-revalidation.d.ts.map +1 -0
- package/dist/backend/services/product-page-revalidation.js +146 -0
- package/dist/backend/services/product-page-revalidation.js.map +1 -0
- package/dist/backend/services/product-scope-context.service.d.ts.map +1 -1
- package/dist/backend/services/product-scope-context.service.js +3 -2
- package/dist/backend/services/product-scope-context.service.js.map +1 -1
- package/dist/backend/services/product-scopes.service.d.ts +212 -0
- package/dist/backend/services/product-scopes.service.d.ts.map +1 -0
- package/dist/backend/services/product-scopes.service.js +638 -0
- package/dist/backend/services/product-scopes.service.js.map +1 -0
- package/dist/backend/services/product-summary-text.d.ts +8 -0
- package/dist/backend/services/product-summary-text.d.ts.map +1 -0
- package/dist/backend/services/product-summary-text.js +8 -0
- package/dist/backend/services/product-summary-text.js.map +1 -0
- package/dist/backend/services/publication-window-sweep.d.ts +77 -0
- package/dist/backend/services/publication-window-sweep.d.ts.map +1 -0
- package/dist/backend/services/publication-window-sweep.js +117 -0
- package/dist/backend/services/publication-window-sweep.js.map +1 -0
- package/dist/backend/services/scope-completeness.d.ts +107 -0
- package/dist/backend/services/scope-completeness.d.ts.map +1 -0
- package/dist/backend/services/scope-completeness.js +180 -0
- package/dist/backend/services/scope-completeness.js.map +1 -0
- package/dist/backend/services/scope-overview.service.d.ts +112 -0
- package/dist/backend/services/scope-overview.service.d.ts.map +1 -0
- package/dist/backend/services/scope-overview.service.js +372 -0
- package/dist/backend/services/scope-overview.service.js.map +1 -0
- package/dist/backend/services/sql-id-arrays.d.ts +16 -0
- package/dist/backend/services/sql-id-arrays.d.ts.map +1 -0
- package/dist/backend/services/sql-id-arrays.js +24 -0
- package/dist/backend/services/sql-id-arrays.js.map +1 -0
- package/dist/backend/services/url-key-resolution.service.d.ts +76 -0
- package/dist/backend/services/url-key-resolution.service.d.ts.map +1 -0
- package/dist/backend/services/url-key-resolution.service.js +179 -0
- package/dist/backend/services/url-key-resolution.service.js.map +1 -0
- package/dist/backend/services/url-key.service.d.ts +171 -0
- package/dist/backend/services/url-key.service.d.ts.map +1 -0
- package/dist/backend/services/url-key.service.js +738 -0
- package/dist/backend/services/url-key.service.js.map +1 -0
- package/dist/manifest.d.ts +3 -1
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +170 -10
- package/dist/manifest.js.map +1 -1
- package/dist/migrations/20261022T035133_catalog_product_scopes.d.ts +28 -0
- package/dist/migrations/20261022T035133_catalog_product_scopes.d.ts.map +1 -0
- package/dist/migrations/20261022T035133_catalog_product_scopes.js +92 -0
- package/dist/migrations/20261022T035133_catalog_product_scopes.js.map +1 -0
- package/dist/migrations/20261022T054223_catalog_product_url_keys.d.ts +32 -0
- package/dist/migrations/20261022T054223_catalog_product_url_keys.d.ts.map +1 -0
- package/dist/migrations/20261022T054223_catalog_product_url_keys.js +81 -0
- package/dist/migrations/20261022T054223_catalog_product_url_keys.js.map +1 -0
- package/dist/migrations/20261025T222634_catalog_product_status_drop_draft.d.ts +34 -0
- package/dist/migrations/20261025T222634_catalog_product_status_drop_draft.d.ts.map +1 -0
- package/dist/migrations/20261025T222634_catalog_product_status_drop_draft.js +57 -0
- package/dist/migrations/20261025T222634_catalog_product_status_drop_draft.js.map +1 -0
- package/dist/migrations/20261026T033453_catalog_product_media_scopes.d.ts +26 -0
- package/dist/migrations/20261026T033453_catalog_product_media_scopes.d.ts.map +1 -0
- package/dist/migrations/20261026T033453_catalog_product_media_scopes.js +54 -0
- package/dist/migrations/20261026T033453_catalog_product_media_scopes.js.map +1 -0
- package/dist/migrations/20261026T084533_catalog_attachment_packaging_translations.d.ts +27 -0
- package/dist/migrations/20261026T084533_catalog_attachment_packaging_translations.d.ts.map +1 -0
- package/dist/migrations/20261026T084533_catalog_attachment_packaging_translations.js +45 -0
- package/dist/migrations/20261026T084533_catalog_attachment_packaging_translations.js.map +1 -0
- package/dist/migrations/index.d.ts +6 -1
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +11 -1
- package/dist/migrations/index.js.map +1 -1
- package/docs/catalog/attachments.md +46 -4
- package/docs/catalog/gallery-and-labels.md +63 -4
- package/docs/catalog/packaging-units.md +42 -5
- package/docs/catalog/per-channel-per-language-overrides.md +166 -8
- package/docs/catalog/url-keys-and-redirects.md +142 -0
- package/docs/catalog.md +182 -15
- package/i18n/en.json +903 -49
- package/i18n/pl.json +902 -48
- package/package.json +10 -10
|
@@ -24,7 +24,9 @@ typed conflict error rather than silent data corruption.
|
|
|
24
24
|
| `GET /api/v1/admin/catalog/products/:id/gallery` | admin | List the Product's gallery |
|
|
25
25
|
| `POST /api/v1/admin/catalog/products/:id/gallery` | admin | Attach an existing image/video Asset with optional labels |
|
|
26
26
|
| `POST .../gallery?replace=true` | admin | Atomic-swap: remove conflicting labels from other items in this Product, then assign |
|
|
27
|
-
| `PATCH /api/v1/admin/catalog/products/:id/gallery/:itemId` | admin | Update labels (same `?replace=true` toggle) |
|
|
27
|
+
| `PATCH /api/v1/admin/catalog/products/:id/gallery/:itemId` | admin | Update labels (same `?replace=true` toggle), alt text per language, channels the item is hidden in |
|
|
28
|
+
| `GET /api/v1/admin/catalog/products/:id/gallery/channel-roles` | admin | Each sales channel's own role holders |
|
|
29
|
+
| `PUT /api/v1/admin/catalog/products/:id/gallery/channel-roles` | admin | Set or clear a sales channel's own role holders |
|
|
28
30
|
| `DELETE /api/v1/admin/catalog/products/:id/gallery/:itemId` | admin | Remove from gallery (Asset row survives) |
|
|
29
31
|
| `PUT /api/v1/admin/catalog/products/:id/gallery/order` | admin | Reorder by id list |
|
|
30
32
|
|
|
@@ -36,6 +38,56 @@ service drops the conflicting assignments first then inserts the new
|
|
|
36
38
|
one — all in a single transaction, so concurrent admins never see a
|
|
37
39
|
half-applied state.
|
|
38
40
|
|
|
41
|
+
## Per sales channel and per language
|
|
42
|
+
|
|
43
|
+
The set of images is the same in every sales channel: a channel cannot add an image
|
|
44
|
+
of its own or reorder the gallery. What a channel can change is which image holds
|
|
45
|
+
each role and which images it shows. The alt text can be set per language.
|
|
46
|
+
|
|
47
|
+
- **Role per channel.** `PUT …/gallery/channel-roles` with
|
|
48
|
+
`{ "channelId": "…", "roles": { "baseImage": "<itemId>", "smallImage": null } }`
|
|
49
|
+
gives the channel its own holder of a role. `null` returns the role to the global
|
|
50
|
+
holder; a role left out is unchanged. The keys are `baseImage`, `smallImage` and
|
|
51
|
+
`thumbnail`. Each role has at most one holder per channel. `GET` lists the
|
|
52
|
+
channels that have an override of their own.
|
|
53
|
+
- **Hidden per channel.** `PATCH …/gallery/:itemId` with
|
|
54
|
+
`{ "hiddenInChannels": ["…"] }` replaces the set of channels the image is hidden
|
|
55
|
+
in. A hidden image is not served in that channel: not in the product page's
|
|
56
|
+
gallery, not as the listing card's image, not as the Open Graph image, not in a
|
|
57
|
+
product feed of that channel and not in a comparison seen in it. A role whose
|
|
58
|
+
holder is hidden in a channel has no holder there, so the listing card moves on to
|
|
59
|
+
the next image in its chain.
|
|
60
|
+
- **Alt text per language.** `PATCH …/gallery/:itemId` with
|
|
61
|
+
`{ "altText": { "pl-PL": "…", "de-DE": "" } }` sets the product's own alt text of
|
|
62
|
+
the image in each named language. An empty string removes that language, and a
|
|
63
|
+
language left out is unchanged. The product page serves the text in the request's
|
|
64
|
+
language, else the asset's own alt text.
|
|
65
|
+
|
|
66
|
+
You can hide an image or give it a role only in a channel the product is in;
|
|
67
|
+
otherwise the request answers `422 SCOPE_INVALID`. Removing an override is always
|
|
68
|
+
allowed, even after the product has left the channel.
|
|
69
|
+
|
|
70
|
+
Hiding is presentation, not access control. A hidden image is not shown in the
|
|
71
|
+
channel, but its file keeps its stable URL, and anyone who has that URL can still
|
|
72
|
+
fetch it. Do not rely on hiding to keep an image confidential: a file that must
|
|
73
|
+
not be public must not be in the product's gallery.
|
|
74
|
+
|
|
75
|
+
Each of these writes is recorded once in the audit log as
|
|
76
|
+
`product.media.update`, with the item's (or the channel's roles') state before and
|
|
77
|
+
after. Sending the recorded before-state back through the same route restores it.
|
|
78
|
+
The write announces `product.updated.v1` with `changedFields: ["media"]`. A request
|
|
79
|
+
that changes nothing writes nothing and announces nothing.
|
|
80
|
+
|
|
81
|
+
The same holds for an item's labels and for the gallery's order. A `PATCH` that
|
|
82
|
+
changes labels records them (`labels`) in the item's state; the labels are
|
|
83
|
+
replaced in the same transaction as the rest of the item, so a refused label leaves
|
|
84
|
+
the item untouched. With `?replace=true` the entry restores this item only: a label
|
|
85
|
+
taken from another item is not handed back by re-sending it. `PUT …/gallery/order`
|
|
86
|
+
records `orderedGalleryItemIds` before and after, and runs in one transaction.
|
|
87
|
+
Deleting an item is recorded once, as `gallery_item.delete`.
|
|
88
|
+
|
|
89
|
+
With no override, every channel shows the global gallery, as before.
|
|
90
|
+
|
|
39
91
|
## Errors
|
|
40
92
|
|
|
41
93
|
| Code | Status | When |
|
|
@@ -43,12 +95,15 @@ half-applied state.
|
|
|
43
95
|
| `GALLERY_LABEL_ALREADY_TAKEN` | 409 | Label conflict without `?replace=true` |
|
|
44
96
|
| `GALLERY_LABEL_LIMIT_EXCEEDED` | 400 | More than 3 labels on a single item |
|
|
45
97
|
| `ASSET_KIND_NOT_SUPPORTED` | 400 | Asset kind ∉ `{image, video}` |
|
|
46
|
-
| `GALLERY_ITEM_NOT_FOUND` | 404 | `:itemId` missing |
|
|
98
|
+
| `GALLERY_ITEM_NOT_FOUND` | 404 | `:itemId` missing, or a channel role names an item of another product |
|
|
99
|
+
| `SCOPE_INVALID` | 422 | Hiding an image or giving a role in a channel the product is not in |
|
|
47
100
|
| `PRODUCT_NOT_FOUND` | 404 | `:id` missing |
|
|
48
101
|
|
|
49
102
|
## Storefront integration
|
|
50
103
|
|
|
51
|
-
`productDetail.gallery[]` carries `{id, position, labels[], asset{id, kind, url}}
|
|
104
|
+
`productDetail.gallery[]` carries `{id, position, labels[], asset{id, kind, url}, altText}`,
|
|
105
|
+
as the request's sales channel shows it: hidden items are left out, `labels` are the
|
|
106
|
+
channel's roles, and `altText` is in the request's language.
|
|
52
107
|
The `<GallerySwitcher>` component renders the Base Image as the primary
|
|
53
108
|
`<img>` (or the first item if no Base Image is set) and emits a thumbnail
|
|
54
109
|
strip with the Small Image marked via `data-small-image="true"` for
|
|
@@ -70,4 +125,8 @@ over the listing thumbnail so social shares get the marketer's hero shot.
|
|
|
70
125
|
`gallery_items` (id, product_id FK CASCADE, asset_id FK RESTRICT,
|
|
71
126
|
position, timestamps) + `gallery_item_labels` (composite PK on
|
|
72
127
|
(gallery_item_id, label), `UNIQUE (product_id, label)`, CHECK label IN
|
|
73
|
-
('base_image', 'small_image', 'thumbnail')).
|
|
128
|
+
('base_image', 'small_image', 'thumbnail')). `gallery_items.alt_text` holds the alt
|
|
129
|
+
text per language. `gallery_item_channel_labels` holds a channel's own role holder
|
|
130
|
+
(primary key (product_id, sales_channel_id, label)) and `gallery_item_channel_hidden`
|
|
131
|
+
an item hidden in a channel (primary key (gallery_item_id, sales_channel_id)); both
|
|
132
|
+
cascade on the product's, the item's and the channel's delete.
|
|
@@ -15,6 +15,7 @@ Manage packaging units in the **Inventory** section of the product card
|
|
|
15
15
|
(simple and configurable products only). Each unit has:
|
|
16
16
|
|
|
17
17
|
- a **name** (operator text, e.g. `Paleta`, `Karton`) — unique within the product,
|
|
18
|
+
optionally translated per language (see *Name per language* below),
|
|
18
19
|
- a **base quantity** (whole number ≥ 1) — how many base pieces the unit holds,
|
|
19
20
|
- a **default** flag — the unit pre-selected on the storefront,
|
|
20
21
|
- a **position** — the order units appear in,
|
|
@@ -46,6 +47,40 @@ match one of the product's units. Anything else is refused with
|
|
|
46
47
|
`422 PACKAGING_UNIT_MISMATCH` — an id that is unknown, deleted or another
|
|
47
48
|
product's unit all give the same reason.
|
|
48
49
|
|
|
50
|
+
**For API clients:** a name sent without an id is matched against the unit's
|
|
51
|
+
**global** name only, never against its translations (see *Name per language*).
|
|
52
|
+
A line that sends the name a buyer saw in a translated storefront — `Pallet`
|
|
53
|
+
where the global name is `Paleta` — is refused with
|
|
54
|
+
`422 PACKAGING_UNIT_MISMATCH` (reason `name_unknown`). Send the
|
|
55
|
+
`packagingUnitId`, or the global name.
|
|
56
|
+
|
|
57
|
+
## Name per language
|
|
58
|
+
|
|
59
|
+
A unit's name can be translated: `nameTranslations` maps a language to a name, e.g.
|
|
60
|
+
`{ "en-GB": "Pallet", "de-DE": "" }`. A named language is set, an empty string
|
|
61
|
+
removes it, and a language left out is unchanged; each name is at most 160
|
|
62
|
+
characters. The unit's own `name` stays the global name: it is the one that must be
|
|
63
|
+
unique within the product, the one a quote line sent without an id is matched
|
|
64
|
+
against, and the one minimum refusals name.
|
|
65
|
+
|
|
66
|
+
Where a buyer sees the unit, its name is the translation in the request's language,
|
|
67
|
+
else the global name:
|
|
68
|
+
|
|
69
|
+
- the product page's `packagingUnits[].name`;
|
|
70
|
+
- the name a basket line snapshots — in the basket's language on its channel. When
|
|
71
|
+
an administrator names the channel on a customer's behalf, the name is taken in
|
|
72
|
+
that channel's default language, like the product name beside it;
|
|
73
|
+
- the name a buyer's quote-request line snapshots — in the request's language on the
|
|
74
|
+
channel it is raised on.
|
|
75
|
+
|
|
76
|
+
Creating or updating a unit is recorded once in the audit log, as
|
|
77
|
+
`packaging_unit.create` or `packaging_unit.update`, with the unit's state before and
|
|
78
|
+
after (its product, name, `nameTranslations`, base quantity, default flag and
|
|
79
|
+
minimum). Sending the recorded before-state back through the same route (without
|
|
80
|
+
`productId`) restores it. The write announces `product.updated.v1` with
|
|
81
|
+
`changedFields: ["packagingUnits"]`. A request that changes nothing writes nothing
|
|
82
|
+
and announces nothing.
|
|
83
|
+
|
|
49
84
|
## For buyers
|
|
50
85
|
|
|
51
86
|
On the product page a selector offers the available units plus a *single piece*
|
|
@@ -57,7 +92,7 @@ line of the same product stay separate.
|
|
|
57
92
|
## How the label travels
|
|
58
93
|
|
|
59
94
|
The unit name and base quantity are **snapshotted** on the line when it is
|
|
60
|
-
created, so later edits to (or deletion of) a product's packaging units never
|
|
95
|
+
created — the name in the line's language, as above — so later edits to (or deletion of) a product's packaging units never
|
|
61
96
|
change historical carts, orders, or quote requests.
|
|
62
97
|
|
|
63
98
|
- **Cart** — `cart_items` snapshot the unit; the cart serializer composes a
|
|
@@ -81,14 +116,14 @@ count.
|
|
|
81
116
|
- Admin CRUD: `GET/POST /api/v1/admin/catalog/products/:id/packaging-units`,
|
|
82
117
|
`PATCH/DELETE …/:unitId`, `PATCH …/packaging-units/reorder`
|
|
83
118
|
(gated by `catalog:read` / `catalog:write`). Create and update accept an
|
|
84
|
-
optional `minOrderUnits` (`1…1000000`, or `null` to clear); the response
|
|
119
|
+
optional `nameTranslations` and an optional `minOrderUnits` (`1…1000000`, or `null` to clear); the response
|
|
85
120
|
always carries it. The in-process `CatalogPackagingPort`, used by PIM
|
|
86
121
|
connectors, accepts the same optional field and refuses an out-of-range
|
|
87
122
|
value with `422 VALIDATION_FAILED`; a writer that never sends it keeps
|
|
88
123
|
working.
|
|
89
124
|
- Public: the product detail (`GET /api/v1/catalog/products/:idOrSlug`)
|
|
90
|
-
includes an optional `packagingUnits` array; each unit carries
|
|
91
|
-
`minOrderUnits` (`null` when none).
|
|
125
|
+
includes an optional `packagingUnits` array; each unit carries its name in
|
|
126
|
+
the request's language and `minOrderUnits` (`null` when none).
|
|
92
127
|
- Cart: `POST /api/v1/cart/items` accepts an optional `packagingUnitId`; the
|
|
93
128
|
resulting line quantity is `baseQuantity × quantity`.
|
|
94
129
|
|
|
@@ -99,7 +134,9 @@ Table `product_packaging_units` (migration
|
|
|
99
134
|
(FK → `products`, cascade delete), `name`, `base_quantity`
|
|
100
135
|
(`CHECK >= 1`), `position`, `is_default`, timestamps; `UNIQUE (product_id,
|
|
101
136
|
name)`. Migration `20261016T082008_catalog_order_rules.ts` adds
|
|
102
|
-
`min_order_units` (nullable, `CHECK` 1–1 000 000)
|
|
137
|
+
`min_order_units` (nullable, `CHECK` 1–1 000 000), and
|
|
138
|
+
`20261026T084533_catalog_attachment_packaging_translations.ts` adds
|
|
139
|
+
`name_translations` (jsonb, `{}` by default). Additive snapshot columns, each added by its owning module:
|
|
103
140
|
`cart_items` (`20260611T140413_carts_cart_item_packaging.ts`), `order_items`
|
|
104
141
|
(`20260611T140414_orders_order_item_packaging.ts`), `quote_request_items`
|
|
105
142
|
(`20260611T140415_quote_requests_qr_item_packaging.ts`; its
|
|
@@ -20,6 +20,13 @@ language-scoped via a backend constant
|
|
|
20
20
|
(`SYSTEM_ATTRIBUTE_SCOPES`). User-defined attributes default to
|
|
21
21
|
global-only and opt in via the attribute editor.
|
|
22
22
|
|
|
23
|
+
The same scopes also decide **where a product is available**: its status,
|
|
24
|
+
publication window, audience and order rules can differ per Sales Channel,
|
|
25
|
+
and its status per channel × language. That is described in
|
|
26
|
+
*Availability per sales channel and language* below. A product's URL keys per
|
|
27
|
+
language and per channel × language have their own page,
|
|
28
|
+
[URL Keys and Redirects](./url-keys-and-redirects.md).
|
|
29
|
+
|
|
23
30
|
## Why
|
|
24
31
|
|
|
25
32
|
A B2B catalog routinely needs to overlay channel-specific marketing
|
|
@@ -187,8 +194,13 @@ These consumers go through the resolver:
|
|
|
187
194
|
no channel-default leg, and walk the override slots over it, so a
|
|
188
195
|
tile can show the `en-US` baseline where the listing card shows the
|
|
189
196
|
channel default's override. A product without overrides shows exactly what
|
|
190
|
-
it showed before.
|
|
191
|
-
|
|
197
|
+
it showed before. On the listing's Postgres path, `sort=name` orders by
|
|
198
|
+
the effective name at the request's channel and language (ties by id),
|
|
199
|
+
free text `q` matches the effective name and the effective values of
|
|
200
|
+
searchable attributes, and `filter[attr.*]` and the facet counts use the
|
|
201
|
+
channel's effective values at the request language. When the `search`
|
|
202
|
+
module answers the listing, it sorts by the name indexed in the channel's
|
|
203
|
+
default language (see the `search` module's page).
|
|
192
204
|
- **Search indexer (Meilisearch)** — builds one document per
|
|
193
205
|
`(product, channel)` pair. Each document's `name` and `description`
|
|
194
206
|
fields are run through the resolver with `channel.defaultLanguage`
|
|
@@ -219,7 +231,7 @@ The product edit page's **Details** tab gains a
|
|
|
219
231
|
source badge per field — `channel + language override` / `channel
|
|
220
232
|
override` / `global baseline (language)` / `global baseline
|
|
221
233
|
(fallback)` / `no value`.
|
|
222
|
-
4. Offers "Add override" / "Edit override" / "
|
|
234
|
+
4. Offers "Add override" / "Edit override" / "Use inherited"
|
|
223
235
|
affordances per field. Edits go through `PATCH /value-overrides`
|
|
224
236
|
with optimistic refresh.
|
|
225
237
|
5. Persists the editor's `(channel, language)` selection back via
|
|
@@ -230,6 +242,157 @@ Edit affordances are gated on a specific channel being selected.
|
|
|
230
242
|
Under Global / no channel, the panel is read-only and a help string
|
|
231
243
|
explains that overrides only apply per-channel.
|
|
232
244
|
|
|
245
|
+
## Availability per sales channel and language
|
|
246
|
+
|
|
247
|
+
A product is **available** to a buyer at a sales channel C and language L when
|
|
248
|
+
all of these hold:
|
|
249
|
+
|
|
250
|
+
1. it is a member of C and not archived;
|
|
251
|
+
2. its effective **status** at (C, L) is `active`;
|
|
252
|
+
3. now is inside its effective **publication window** (both ends included);
|
|
253
|
+
4. its effective **audience** admits the buyer.
|
|
254
|
+
|
|
255
|
+
L is the first `Accept-Language` tag of the request matched to C's languages,
|
|
256
|
+
else C's default language. Every buyer-facing read asks this one rule — the
|
|
257
|
+
listing and its price range, facet and category counts, the product page,
|
|
258
|
+
product links, grouped children and bundle options, the quick search, search,
|
|
259
|
+
the sitemap, product feeds — and so do the places a product is acquired: the
|
|
260
|
+
basket, checkout and placement, quote requests, quick order and the external
|
|
261
|
+
order intake. A product that is not available answers exactly as a product
|
|
262
|
+
that does not exist (`404 PRODUCT_NOT_FOUND`); whether one exists, is off, is
|
|
263
|
+
outside its window or is restricted cannot be told apart. An archived product
|
|
264
|
+
is the exception described under *Product status and archiving* on the
|
|
265
|
+
[Catalog](../catalog.md#product-status-and-archiving) page.
|
|
266
|
+
|
|
267
|
+
### Scopes and inheritance
|
|
268
|
+
|
|
269
|
+
| Field | Global | Sales channel | Channel × language |
|
|
270
|
+
| --- | --- | --- | --- |
|
|
271
|
+
| Status (`active` / `inactive`) | `products.status` | yes | yes |
|
|
272
|
+
| Publication window | `products.publish_from` / `publish_until` | yes | — |
|
|
273
|
+
| Audience (visibility and organisations) | `products.visibility` / `allowed_organization_ids` | yes | — |
|
|
274
|
+
| Minimum order quantity, returnable | `products` | yes | — |
|
|
275
|
+
|
|
276
|
+
Each field takes the value of the most specific scope that sets one: for the
|
|
277
|
+
status, channel × language, then channel, then global; for the others,
|
|
278
|
+
channel, then global. An unset scope **inherits** — there is no "empty"
|
|
279
|
+
value that switches something off. A product with no overrides behaves
|
|
280
|
+
exactly as before.
|
|
281
|
+
|
|
282
|
+
- **Status.** `inactive` at any scope is plain off there, and archiving is not a
|
|
283
|
+
status — see *Product status and archiving* on the
|
|
284
|
+
[Catalog](../catalog.md#product-status-and-archiving) page. A product off
|
|
285
|
+
globally and `active` in one channel is available in that channel only.
|
|
286
|
+
- **Publication window.** `from` and `until`, each optional (an open side);
|
|
287
|
+
both ends are included. A channel window replaces the global window as a
|
|
288
|
+
pair, even when both its sides are open. A window that does not start before
|
|
289
|
+
it ends is refused with `422 VALIDATION_FAILED` (`details.field = 'window'`).
|
|
290
|
+
The window is evaluated when a request is answered; nothing is written when
|
|
291
|
+
it opens or closes. A sweep (`catalog.publication-window.sweep`, every five
|
|
292
|
+
minutes) announces `product.updated.v1` with
|
|
293
|
+
`changedFields: ["publicationWindow"]` for each product whose window bound
|
|
294
|
+
was crossed, so caches and the search index catch up.
|
|
295
|
+
- **Audience.** The visibility mode and the organisation list are one value:
|
|
296
|
+
a channel's audience replaces the global rule whole, never merged with it.
|
|
297
|
+
Naming organisations that are not members of the channel is allowed and
|
|
298
|
+
answered with an `audience_non_members` warning.
|
|
299
|
+
- **Order rules.** See *Per sales channel* under *Order rules* on the
|
|
300
|
+
[Catalog](../catalog.md#per-sales-channel) page.
|
|
301
|
+
|
|
302
|
+
An override is honoured only where it can apply: one for a channel the product
|
|
303
|
+
has left, or for a language the channel no longer offers, is kept but ignored,
|
|
304
|
+
and listed as an orphan (below) until it is removed.
|
|
305
|
+
|
|
306
|
+
### Writing the scopes
|
|
307
|
+
|
|
308
|
+
`GET /api/v1/admin/catalog/products/:id/scopes` (`catalog:read`) answers the
|
|
309
|
+
global values and, per channel, the overrides, the channel's languages and
|
|
310
|
+
whether the product is still a member. `PATCH` on the same path
|
|
311
|
+
(`catalog:write`) writes them:
|
|
312
|
+
|
|
313
|
+
```json
|
|
314
|
+
{
|
|
315
|
+
"channels": [
|
|
316
|
+
{
|
|
317
|
+
"channelId": "<retail-uuid>",
|
|
318
|
+
"status": "active",
|
|
319
|
+
"window": { "from": "2026-11-01T00:00:00Z", "until": null },
|
|
320
|
+
"audience": null,
|
|
321
|
+
"languageStatuses": [{ "languageCode": "de-DE", "status": "inactive" }]
|
|
322
|
+
}
|
|
323
|
+
],
|
|
324
|
+
"global": { "publishUntil": "2026-12-31T23:59:59Z" }
|
|
325
|
+
}
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
An absent key is left as it is; `null` removes the override (use inherited).
|
|
329
|
+
A value for a channel the product is not in, or a language the channel does not
|
|
330
|
+
offer, is refused with `422 SCOPE_INVALID`; removing such an override is always
|
|
331
|
+
allowed. The global window can also be written with the product `PATCH`
|
|
332
|
+
(`publishFrom`, `publishUntil`).
|
|
333
|
+
|
|
334
|
+
Each request is one audited Command, `product.scopes.update`; sending its
|
|
335
|
+
before-state back through the same route restores it. The write announces
|
|
336
|
+
`product.updated.v1` with `changedFields` among `scopedStatus`,
|
|
337
|
+
`publicationWindow`, `audience` and `orderRules`. A status change that switches
|
|
338
|
+
the product on is subject to the completeness check — see the
|
|
339
|
+
[Catalog](../catalog.md#completeness-check-when-switching-a-product-on) page —
|
|
340
|
+
and `warnings` carries what it found. Imports and connectors write the same
|
|
341
|
+
scopes through `catalogProductScopeWritePort`, unchecked; the field-by-field
|
|
342
|
+
table is on the [URL Keys and Redirects](./url-keys-and-redirects.md#integrations)
|
|
343
|
+
page. Setting one channel's status on many products at once is the bulk edit's
|
|
344
|
+
*Status per channel and language* — see the
|
|
345
|
+
[Catalog](../catalog.md#status-per-channel-and-language-in-bulk) page.
|
|
346
|
+
|
|
347
|
+
In the product editor these are the **scope controls** under the channel
|
|
348
|
+
switcher on the Details tab (status per channel and per language, window,
|
|
349
|
+
audience) and **Order rules per channel** on the Inventory tab; all are
|
|
350
|
+
read-only without `catalog:write`.
|
|
351
|
+
|
|
352
|
+
### Scope overview
|
|
353
|
+
|
|
354
|
+
`GET /api/v1/admin/catalog/products/:id/scope-overview` (`catalog:read`) lays a
|
|
355
|
+
product out as its channels × languages, and the product editor's **Scopes**
|
|
356
|
+
tab shows it. Each cell carries:
|
|
357
|
+
|
|
358
|
+
- the effective status and where it comes from (`channel_language`,
|
|
359
|
+
`channel` or `global`);
|
|
360
|
+
- whether the product is available there now — a member, the language offered,
|
|
361
|
+
on, inside its window, not archived; the audience is shown as a rule, not
|
|
362
|
+
evaluated for anybody;
|
|
363
|
+
- every field overridden at that cell and the level it comes from — `status`,
|
|
364
|
+
`window`, `audience`, `minOrderQuantity`, `returnable`, `name`,
|
|
365
|
+
`description`, `attribute:<key>`, `urlKey`, and the media, attachment,
|
|
366
|
+
packaging-unit and SEO fields set per channel or language;
|
|
367
|
+
- `missing` — what the completeness check would report there, whatever the
|
|
368
|
+
cell's status.
|
|
369
|
+
|
|
370
|
+
Overrides that no longer apply are listed under `orphans` with a reason:
|
|
371
|
+
`not_a_member`, `language_not_offered` or `attribute_scope_changed`. On the
|
|
372
|
+
Scopes tab a scope value, a value override or a URL key is returned to the
|
|
373
|
+
inherited value with **Use inherited** where it is set — a channel's own values
|
|
374
|
+
in its "Whole channel" column, a language's own values in the "Every channel"
|
|
375
|
+
row — and an orphan (listed under **No longer applies**) is deleted; the tab
|
|
376
|
+
calls the endpoint that owns the value (`…/scopes`, `…/value-overrides` or
|
|
377
|
+
`…/url-keys`). Resetting a text value (a name, a description, a URL key, an SEO
|
|
378
|
+
field) and deleting an orphan ask first, naming the field and the scope; other
|
|
379
|
+
values reset in one click. A product in no sales channel answers no channels and
|
|
380
|
+
every active platform language.
|
|
381
|
+
|
|
382
|
+
Before an attribute's `channelScoped` or `languageScoped` flag is turned off,
|
|
383
|
+
`GET /api/v1/admin/catalog/attributes/:idOrKey/scope-change-preview?channelScoped=&languageScoped=`
|
|
384
|
+
answers how many value overrides would stop applying, in total and per
|
|
385
|
+
channel. The change keeps the rows; they become orphans.
|
|
386
|
+
|
|
387
|
+
### Storage
|
|
388
|
+
|
|
389
|
+
`product_channel_scopes` holds one row per product and channel with the status,
|
|
390
|
+
window, audience, minimum order quantity and returnable flag (`NULL` inherits);
|
|
391
|
+
`product_channel_language_scopes` holds the status per channel × language.
|
|
392
|
+
Both cascade on the product's and the channel's delete
|
|
393
|
+
(`20261022T035133_catalog_product_scopes.ts`, with the global window columns
|
|
394
|
+
`products.publish_from` and `publish_until`; no backfill).
|
|
395
|
+
|
|
233
396
|
## Migration
|
|
234
397
|
|
|
235
398
|
One migration `20260611T140346_catalog_product_value_overrides_init.ts` ships everything:
|
|
@@ -250,11 +413,6 @@ exact inverse — drop the two tables and the two columns.
|
|
|
250
413
|
surfaces only the system Name + Description today. User attribute
|
|
251
414
|
overrides are accepted by the PATCH endpoint and resolved on read,
|
|
252
415
|
but the admin SPA does not yet expose a write affordance for them.
|
|
253
|
-
- **Override-aware listing filters and sorting** — the public catalog
|
|
254
|
-
endpoint returns `name` and `description` as the resolved string for
|
|
255
|
-
the request's sales channel and language (see *Read paths* above), but
|
|
256
|
-
listing filters, attribute filters and name sorting still read the
|
|
257
|
-
baseline values. Making them follow the overrides is a follow-up.
|
|
258
416
|
- **Channel-aware reindex enqueue** — the PATCH endpoint does not
|
|
259
417
|
yet enqueue a Meilisearch reindex job per touched channel; the
|
|
260
418
|
next per-product upsert (driven by any catalog mutation) picks it
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: URL Keys and Redirects
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# URL Keys and Redirects
|
|
6
|
+
|
|
7
|
+
A product's storefront address is `/p/<key>`. The key can differ per language, and per sales
|
|
8
|
+
channel and language:
|
|
9
|
+
|
|
10
|
+
- **global key** — the product's `slug`; it is the key in every language where the product has no
|
|
11
|
+
key of its own;
|
|
12
|
+
- **language key** — one per language, for every sales channel;
|
|
13
|
+
- **sales channel × language key** — one per channel and language, overriding the language key there.
|
|
14
|
+
|
|
15
|
+
The **effective key** at a sales channel and language is the channel × language key, else the
|
|
16
|
+
language key, else the global key. Every product URL the platform emits — the storefront's
|
|
17
|
+
canonical and alternate-language links, the sitemap, a redirect target, the preview address in the
|
|
18
|
+
admin — uses the effective key, with `?lang=<language>` when the language is not the channel's
|
|
19
|
+
default.
|
|
20
|
+
|
|
21
|
+
A key is valid only in its own language, and is unique per language across all sales channels:
|
|
22
|
+
no two products share a key in one language. Changing a key keeps the previous one as a permanent
|
|
23
|
+
redirect in its language, straight to the current key; redirects are kept until an operator deletes
|
|
24
|
+
them. Redirects are served while the `seo` module is switched on; with `seo` off an old key answers
|
|
25
|
+
"not found", and the redirects come back when `seo` is switched on. A product's other **current** keys
|
|
26
|
+
are not redirects: with `seo` off too, a request for its language or global key where a channel ×
|
|
27
|
+
language key overrides it, or for another channel's key, still leads to its URL in that channel.
|
|
28
|
+
|
|
29
|
+
## Managing keys
|
|
30
|
+
|
|
31
|
+
In the product editor, the **URL keys** panel on the SEO tab shows the global key, a key per
|
|
32
|
+
language and a key per sales channel and language — an empty field uses the inherited key — and the
|
|
33
|
+
storefront URL each channel and language ends up with. While the `seo` module is on it also lists
|
|
34
|
+
the redirects the old keys keep.
|
|
35
|
+
|
|
36
|
+
`GET /api/v1/admin/catalog/products/:id/url-keys` (`catalog:read`) answers the same, and `PUT` on
|
|
37
|
+
the same path (`catalog:write`) writes it:
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{
|
|
41
|
+
"globalKey": "cordless-drill",
|
|
42
|
+
"languageKeys": [{ "languageCode": "de-DE", "key": "akku-bohrschrauber" }],
|
|
43
|
+
"channelKeys": [{ "channelId": "<retail-uuid>", "languageCode": "pl-PL", "key": null }]
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
A list or key left out is unchanged; `key: null` removes the key at that scope, so the inherited
|
|
48
|
+
key applies there again. A key is lower-case kebab case, at most 160 characters. A key for a sales
|
|
49
|
+
channel the product is not in, or a language the channel does not offer, is refused with
|
|
50
|
+
`422 SCOPE_INVALID`; a key left behind by a channel the product has left is shown as **No longer applies**
|
|
51
|
+
and can be removed.
|
|
52
|
+
|
|
53
|
+
- **A key another product holds** in that language is refused with `409 URL_KEY_TAKEN`, naming the
|
|
54
|
+
product (`details.conflicts`). A deleted product's global key stays taken; its language and
|
|
55
|
+
channel keys are released.
|
|
56
|
+
- **A key that is another product's redirect** answers `409 URL_KEY_REDIRECT_TAKEOVER_REQUIRED`,
|
|
57
|
+
naming the product that would lose the redirect (`details.takeovers`). Sending the same request
|
|
58
|
+
again with the key in `confirmTakeover` takes it over. Only an operator can do this; an
|
|
59
|
+
integration never takes over a redirect.
|
|
60
|
+
- **A changed key stays as a redirect** in its language, pointing at the product, not at a key, so
|
|
61
|
+
redirects never chain. A redirect is kept until an operator deletes it:
|
|
62
|
+
`DELETE /api/v1/admin/catalog/products/:id/url-redirects/:redirectId` (`catalog:write`). Deleting
|
|
63
|
+
a product removes its redirects. While `seo` is off the answer leaves `redirects` out, but the
|
|
64
|
+
rows stay and keep reserving their keys.
|
|
65
|
+
|
|
66
|
+
A `PUT` is one audited Command, `product.url_keys.update`, whose before-state sent back through the
|
|
67
|
+
same route restores the keys; a redirect delete is `product.url_redirect.delete`. Both announce
|
|
68
|
+
`product.updated.v1` with `changedFields: ["urlKeys"]`. A new or duplicated product's global key is
|
|
69
|
+
chosen free of every live product's language, channel and redirect keys.
|
|
70
|
+
|
|
71
|
+
## On the storefront
|
|
72
|
+
|
|
73
|
+
`GET /api/v1/catalog/products/resolve/:key` resolves a key at the request's sales channel and
|
|
74
|
+
language:
|
|
75
|
+
|
|
76
|
+
- the product's effective key there answers `{ kind: "product", productId, key }`;
|
|
77
|
+
- any other current key of the product in that language, and its redirects there (a former global
|
|
78
|
+
key counts in every language), answer `{ kind: "redirect", key, languageCode, path }`, `path`
|
|
79
|
+
being the product's URL to redirect to permanently;
|
|
80
|
+
- a key of no product, a key of another language, and a product that is not available to the caller
|
|
81
|
+
there all answer the same `404 PRODUCT_NOT_FOUND`; an archived product answers
|
|
82
|
+
`410 PRODUCT_ARCHIVED`.
|
|
83
|
+
|
|
84
|
+
`GET /api/v1/catalog/products/:idOrSlug` accepts an id, a current key in the request's language, or
|
|
85
|
+
a product's global key — never a redirect. The product detail carries
|
|
86
|
+
`paths: { canonical, alternates }`: the page's URL at the request's channel and language, and one
|
|
87
|
+
per channel language where the product is available to anonymous visitors. `slug` on the listing,
|
|
88
|
+
the product detail, grouped and bundle children and product-link tiles is the effective key at the
|
|
89
|
+
request's channel and language.
|
|
90
|
+
|
|
91
|
+
## Errors
|
|
92
|
+
|
|
93
|
+
| Code | Status | When |
|
|
94
|
+
| --- | --- | --- |
|
|
95
|
+
| `URL_KEY_TAKEN` | 409 | The key is another product's key in that language |
|
|
96
|
+
| `URL_KEY_REDIRECT_TAKEOVER_REQUIRED` | 409 | The key is another product's redirect and the write did not confirm the takeover |
|
|
97
|
+
| `URL_REDIRECT_NOT_FOUND` | 404 | `:redirectId` is not a redirect of the product |
|
|
98
|
+
| `SCOPE_INVALID` | 422 | A key for a channel the product is not in, or a language the channel does not offer |
|
|
99
|
+
| `PRODUCT_NOT_FOUND` | 404 | The storefront resolve found no product available to the caller |
|
|
100
|
+
| `PRODUCT_ARCHIVED` | 410 | The storefront resolve found an archived product |
|
|
101
|
+
|
|
102
|
+
## Integrations
|
|
103
|
+
|
|
104
|
+
What a connector, a PIM synchronisation or a spreadsheet writes, and at which scope. An integration
|
|
105
|
+
writes only the scopes it names: writing a global value never removes an operator's override at a
|
|
106
|
+
sales channel or language (FR-091).
|
|
107
|
+
|
|
108
|
+
| Field | Scope it is written at | Through |
|
|
109
|
+
| --- | --- | --- |
|
|
110
|
+
| Status | sales channel, or sales channel × language | `catalogProductScopeWritePort.applyScopes` `status`; the products CSV columns `status@<channel code>` and `status@<channel code>/<language>` |
|
|
111
|
+
| Global status, visibility, name, description | global (name and description per language) | `catalogProductWritePort`; the products CSV's `status`, `visibility`, `name_en`, `description_en` |
|
|
112
|
+
| Publication window | global, or sales channel | `applyScopes` `window` (`channelId: null` is the global window) |
|
|
113
|
+
| Audience (visibility and organisations) | sales channel | `applyScopes` `audience` |
|
|
114
|
+
| Minimum order quantity, returnable | sales channel | `applyScopes` `orderRules` |
|
|
115
|
+
| URL key | language, or sales channel × language | `applyScopes` `urlKeys` (`channelId: null` is the language key) |
|
|
116
|
+
| Channel- or language-scoped attribute values | sales channel, language, or both | `catalogProductValueOverrideWritePort` |
|
|
117
|
+
| SEO title and description | language | `seoMetaWritePort` — sales channel SEO overrides are the operator's |
|
|
118
|
+
|
|
119
|
+
`null` as a value means "use inherited": the override at that scope is removed. A field the input
|
|
120
|
+
does not name is left as it is.
|
|
121
|
+
|
|
122
|
+
**URL keys from an integration are never forced.** A key that is another product's key in that
|
|
123
|
+
language, or another product's redirect, is not written: the product keeps its previous key at that
|
|
124
|
+
scope and the call reports, per key, `{ written: false, issue: { languageCode, channelId, key,
|
|
125
|
+
heldByProductId, kind } }` — `kind` is `current` or `redirect`. An integration never takes over
|
|
126
|
+
another product's redirect and is never asked to confirm one; only an operator can, in the product
|
|
127
|
+
editor (FR-093). A key for a sales channel the product is not in, or a language the channel does not
|
|
128
|
+
offer, refuses the whole call.
|
|
129
|
+
|
|
130
|
+
**No completeness check runs** on an integration's write; the operator's warnings about missing
|
|
131
|
+
names and keys in a scope are an editor feature.
|
|
132
|
+
|
|
133
|
+
**The products CSV round-trips.** The export carries one `status@<channel code>` column per sales
|
|
134
|
+
channel and one `status@<channel code>/<language>` column per channel language — the override at
|
|
135
|
+
that scope, empty where the scope inherits. Importing the exported file unchanged changes nothing;
|
|
136
|
+
an edited cell writes that scope, and an emptied one removes the override. A file without these
|
|
137
|
+
columns leaves every scope as it is. One invalid cell — an unknown channel code, a value for a
|
|
138
|
+
channel the product is not in or a language the channel does not offer, a value that is not a
|
|
139
|
+
status — rejects the whole file, as any other invalid row does.
|
|
140
|
+
|
|
141
|
+
Every write is audited and announced with `product.updated.v1`, whose `changedFields` name what
|
|
142
|
+
changed (`scopedStatus`, `publicationWindow`, `audience`, `orderRules`, `urlKeys`).
|