@endora-commerce/mod-catalog 0.108.0 → 0.110.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/CopyToChannelsDialog.d.ts +37 -0
- package/dist/admin/components/CopyToChannelsDialog.d.ts.map +1 -0
- package/dist/admin/components/CopyToChannelsDialog.js +83 -0
- package/dist/admin/components/CopyToChannelsDialog.js.map +1 -0
- package/dist/admin/components/PackagingUnitsEditor.d.ts +16 -1
- package/dist/admin/components/PackagingUnitsEditor.d.ts.map +1 -1
- package/dist/admin/components/PackagingUnitsEditor.js +20 -14
- package/dist/admin/components/PackagingUnitsEditor.js.map +1 -1
- package/dist/admin/components/ProductAttachmentsSection.d.ts +3 -0
- package/dist/admin/components/ProductAttachmentsSection.d.ts.map +1 -0
- package/dist/admin/components/ProductAttachmentsSection.js +98 -0
- package/dist/admin/components/ProductAttachmentsSection.js.map +1 -0
- package/dist/admin/components/ProductAttributesTab.d.ts +1 -11
- package/dist/admin/components/ProductAttributesTab.d.ts.map +1 -1
- package/dist/admin/components/ProductAttributesTab.js +128 -119
- package/dist/admin/components/ProductAttributesTab.js.map +1 -1
- package/dist/admin/components/ProductContentCard.d.ts +41 -0
- package/dist/admin/components/ProductContentCard.d.ts.map +1 -0
- package/dist/admin/components/ProductContentCard.js +28 -0
- package/dist/admin/components/ProductContentCard.js.map +1 -0
- package/dist/admin/components/ProductGallerySection.d.ts +3 -0
- package/dist/admin/components/ProductGallerySection.d.ts.map +1 -0
- package/dist/admin/components/ProductGallerySection.js +129 -0
- package/dist/admin/components/ProductGallerySection.js.map +1 -0
- package/dist/admin/components/ProductOrderRulesCard.d.ts +11 -15
- package/dist/admin/components/ProductOrderRulesCard.d.ts.map +1 -1
- package/dist/admin/components/ProductOrderRulesCard.js +15 -140
- package/dist/admin/components/ProductOrderRulesCard.js.map +1 -1
- package/dist/admin/components/ProductScopeBar.d.ts +28 -0
- package/dist/admin/components/ProductScopeBar.d.ts.map +1 -0
- package/dist/admin/components/ProductScopeBar.js +70 -0
- package/dist/admin/components/ProductScopeBar.js.map +1 -0
- package/dist/admin/components/ProductScopeOverview.d.ts +38 -0
- package/dist/admin/components/ProductScopeOverview.d.ts.map +1 -0
- package/dist/admin/components/ProductScopeOverview.js +222 -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/ProductUrlRedirects.d.ts +15 -0
- package/dist/admin/components/ProductUrlRedirects.d.ts.map +1 -0
- package/dist/admin/components/ProductUrlRedirects.js +70 -0
- package/dist/admin/components/ProductUrlRedirects.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/editor/DetailsTab.d.ts +30 -0
- package/dist/admin/components/editor/DetailsTab.d.ts.map +1 -0
- package/dist/admin/components/editor/DetailsTab.js +59 -0
- package/dist/admin/components/editor/DetailsTab.js.map +1 -0
- package/dist/admin/components/editor/ImmediateBadge.d.ts +21 -0
- package/dist/admin/components/editor/ImmediateBadge.d.ts.map +1 -0
- package/dist/admin/components/editor/ImmediateBadge.js +21 -0
- package/dist/admin/components/editor/ImmediateBadge.js.map +1 -0
- package/dist/admin/components/editor/confirm-removal.d.ts +13 -0
- package/dist/admin/components/editor/confirm-removal.d.ts.map +1 -0
- package/dist/admin/components/editor/confirm-removal.js +33 -0
- package/dist/admin/components/editor/confirm-removal.js.map +1 -0
- package/dist/admin/components/editor/editor-context.d.ts +53 -0
- package/dist/admin/components/editor/editor-context.d.ts.map +1 -0
- package/dist/admin/components/editor/editor-context.js +88 -0
- package/dist/admin/components/editor/editor-context.js.map +1 -0
- package/dist/admin/components/editor/scoped-controls.d.ts +46 -0
- package/dist/admin/components/editor/scoped-controls.d.ts.map +1 -0
- package/dist/admin/components/editor/scoped-controls.js +64 -0
- package/dist/admin/components/editor/scoped-controls.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 +20 -0
- package/dist/admin/index.js.map +1 -1
- package/dist/admin/lib/attribute-scope.d.ts +23 -0
- package/dist/admin/lib/attribute-scope.d.ts.map +1 -0
- package/dist/admin/lib/attribute-scope.js +21 -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/editor-scope.d.ts +35 -0
- package/dist/admin/lib/editor-scope.d.ts.map +1 -0
- package/dist/admin/lib/editor-scope.js +114 -0
- package/dist/admin/lib/editor-scope.js.map +1 -0
- package/dist/admin/lib/order-minimum-input.d.ts +13 -0
- package/dist/admin/lib/order-minimum-input.d.ts.map +1 -0
- package/dist/admin/lib/order-minimum-input.js +16 -0
- package/dist/admin/lib/order-minimum-input.js.map +1 -0
- package/dist/admin/lib/product-labels.d.ts +12 -0
- package/dist/admin/lib/product-labels.d.ts.map +1 -0
- package/dist/admin/lib/product-labels.js +23 -0
- package/dist/admin/lib/product-labels.js.map +1 -0
- package/dist/admin/lib/product-scopes-api.d.ts +23 -0
- package/dist/admin/lib/product-scopes-api.d.ts.map +1 -0
- package/dist/admin/lib/product-scopes-api.js +57 -0
- package/dist/admin/lib/product-scopes-api.js.map +1 -0
- package/dist/admin/lib/product-url-keys-api.d.ts +23 -0
- package/dist/admin/lib/product-url-keys-api.d.ts.map +1 -0
- package/dist/admin/lib/product-url-keys-api.js +61 -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 +73 -0
- package/dist/admin/lib/scope-overview.d.ts.map +1 -0
- package/dist/admin/lib/scope-overview.js +178 -0
- package/dist/admin/lib/scope-overview.js.map +1 -0
- package/dist/admin/lib/scoped-editor-store.d.ts +81 -0
- package/dist/admin/lib/scoped-editor-store.d.ts.map +1 -0
- package/dist/admin/lib/scoped-editor-store.js +198 -0
- package/dist/admin/lib/scoped-editor-store.js.map +1 -0
- package/dist/admin/lib/scoped-values-api.d.ts +14 -0
- package/dist/admin/lib/scoped-values-api.d.ts.map +1 -0
- package/dist/admin/lib/scoped-values-api.js +55 -0
- package/dist/admin/lib/scoped-values-api.js.map +1 -0
- package/dist/admin/pages/AttributesManager.d.ts.map +1 -1
- package/dist/admin/pages/AttributesManager.js +186 -28
- 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/ProductContentPage.d.ts +27 -0
- package/dist/admin/pages/ProductContentPage.d.ts.map +1 -0
- package/dist/admin/pages/ProductContentPage.js +161 -0
- package/dist/admin/pages/ProductContentPage.js.map +1 -0
- package/dist/admin/pages/ProductCreateForm.d.ts +3 -0
- package/dist/admin/pages/ProductCreateForm.d.ts.map +1 -0
- package/dist/admin/pages/ProductCreateForm.js +87 -0
- package/dist/admin/pages/ProductCreateForm.js.map +1 -0
- 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 +878 -627
- 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 +111 -54
- package/dist/admin/pages/ProductsList.js.map +1 -1
- package/dist/backend/admin-search-provider.d.ts +3 -2
- package/dist/backend/admin-search-provider.d.ts.map +1 -1
- package/dist/backend/admin-search-provider.js +2 -3
- package/dist/backend/admin-search-provider.js.map +1 -1
- package/dist/backend/commands/attribute-commands.d.ts +4 -3
- package/dist/backend/commands/attribute-commands.d.ts.map +1 -1
- package/dist/backend/commands/attribute-commands.js +82 -21
- package/dist/backend/commands/attribute-commands.js.map +1 -1
- package/dist/backend/commands/product-content-commands.d.ts +31 -0
- package/dist/backend/commands/product-content-commands.d.ts.map +1 -0
- package/dist/backend/commands/product-content-commands.js +70 -0
- package/dist/backend/commands/product-content-commands.js.map +1 -0
- package/dist/backend/commands/scoped-values.commands.d.ts +95 -0
- package/dist/backend/commands/scoped-values.commands.d.ts.map +1 -0
- package/dist/backend/commands/scoped-values.commands.js +235 -0
- package/dist/backend/commands/scoped-values.commands.js.map +1 -0
- package/dist/backend/demo/reset.d.ts.map +1 -1
- package/dist/backend/demo/reset.js +2 -1
- package/dist/backend/demo/reset.js.map +1 -1
- package/dist/backend/demo/rows.d.ts +25 -0
- package/dist/backend/demo/rows.d.ts.map +1 -1
- package/dist/backend/demo/rows.js +35 -12
- package/dist/backend/demo/rows.js.map +1 -1
- package/dist/backend/demo/seed.d.ts +2 -1
- package/dist/backend/demo/seed.d.ts.map +1 -1
- package/dist/backend/demo/seed.js +22 -8
- 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-scope-override.entity.d.ts +30 -0
- package/dist/backend/entities/gallery-item-scope-override.entity.d.ts.map +1 -0
- package/dist/backend/entities/gallery-item-scope-override.entity.js +80 -0
- package/dist/backend/entities/gallery-item-scope-override.entity.js.map +1 -0
- package/dist/backend/entities/gallery-item.entity.d.ts +9 -1
- package/dist/backend/entities/gallery-item.entity.d.ts.map +1 -1
- package/dist/backend/entities/gallery-item.entity.js +16 -0
- package/dist/backend/entities/gallery-item.entity.js.map +1 -1
- package/dist/backend/entities/gallery-role-scope-override.entity.d.ts +28 -0
- package/dist/backend/entities/gallery-role-scope-override.entity.d.ts.map +1 -0
- package/dist/backend/entities/gallery-role-scope-override.entity.js +75 -0
- package/dist/backend/entities/gallery-role-scope-override.entity.js.map +1 -0
- package/dist/backend/entities/product-attachment-scope-override.entity.d.ts +30 -0
- package/dist/backend/entities/product-attachment-scope-override.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-attachment-scope-override.entity.js +80 -0
- package/dist/backend/entities/product-attachment-scope-override.entity.js.map +1 -0
- package/dist/backend/entities/product-attachment.entity.d.ts +6 -1
- package/dist/backend/entities/product-attachment.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-attachment.entity.js +9 -0
- package/dist/backend/entities/product-attachment.entity.js.map +1 -1
- package/dist/backend/entities/product-attribute.entity.d.ts +5 -9
- package/dist/backend/entities/product-attribute.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-attribute.entity.js +5 -13
- package/dist/backend/entities/product-attribute.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 +47 -0
- package/dist/backend/entities/product-channel-scope.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-channel-scope.entity.js +113 -0
- package/dist/backend/entities/product-channel-scope.entity.js.map +1 -0
- package/dist/backend/entities/product-content-value.entity.d.ts +39 -0
- package/dist/backend/entities/product-content-value.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-content-value.entity.js +81 -0
- package/dist/backend/entities/product-content-value.entity.js.map +1 -0
- package/dist/backend/entities/product-packaging-unit-scope-override.entity.d.ts +30 -0
- package/dist/backend/entities/product-packaging-unit-scope-override.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-packaging-unit-scope-override.entity.js +80 -0
- package/dist/backend/entities/product-packaging-unit-scope-override.entity.js.map +1 -0
- package/dist/backend/entities/product-url-key.entity.d.ts +27 -0
- package/dist/backend/entities/product-url-key.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-url-key.entity.js +70 -0
- package/dist/backend/entities/product-url-key.entity.js.map +1 -0
- package/dist/backend/entities/product-url-redirect.entity.d.ts +18 -0
- package/dist/backend/entities/product-url-redirect.entity.d.ts.map +1 -0
- package/dist/backend/entities/product-url-redirect.entity.js +57 -0
- package/dist/backend/entities/product-url-redirect.entity.js.map +1 -0
- package/dist/backend/entities/product-variant.entity.d.ts +8 -1
- package/dist/backend/entities/product-variant.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-variant.entity.js +13 -2
- package/dist/backend/entities/product-variant.entity.js.map +1 -1
- package/dist/backend/entities/product.entity.d.ts +48 -16
- package/dist/backend/entities/product.entity.d.ts.map +1 -1
- package/dist/backend/entities/product.entity.js +65 -35
- package/dist/backend/entities/product.entity.js.map +1 -1
- package/dist/backend/index.d.ts +29 -2
- package/dist/backend/index.d.ts.map +1 -1
- package/dist/backend/index.js +311 -29
- package/dist/backend/index.js.map +1 -1
- package/dist/backend/plugin.d.ts +79 -8
- package/dist/backend/plugin.d.ts.map +1 -1
- package/dist/backend/plugin.js +98 -17
- package/dist/backend/plugin.js.map +1 -1
- package/dist/backend/prompt-tools.d.ts +11 -0
- package/dist/backend/prompt-tools.d.ts.map +1 -1
- package/dist/backend/prompt-tools.js +124 -9
- package/dist/backend/prompt-tools.js.map +1 -1
- package/dist/backend/routes.admin.d.ts +42 -14
- package/dist/backend/routes.admin.d.ts.map +1 -1
- package/dist/backend/routes.admin.js +214 -134
- 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 +18 -3
- 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 +31 -7
- package/dist/backend/routes.public.d.ts.map +1 -1
- package/dist/backend/routes.public.js +114 -33
- 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.d.ts +12 -1
- package/dist/backend/services/asset-references.d.ts.map +1 -1
- package/dist/backend/services/asset-references.js +85 -32
- package/dist/backend/services/asset-references.js.map +1 -1
- package/dist/backend/services/attachment-packaging-scopes.d.ts +61 -0
- package/dist/backend/services/attachment-packaging-scopes.d.ts.map +1 -0
- package/dist/backend/services/attachment-packaging-scopes.js +98 -0
- package/dist/backend/services/attachment-packaging-scopes.js.map +1 -0
- package/dist/backend/services/attachment.service.d.ts +8 -1
- package/dist/backend/services/attachment.service.d.ts.map +1 -1
- package/dist/backend/services/attachment.service.js +105 -21
- package/dist/backend/services/attachment.service.js.map +1 -1
- package/dist/backend/services/attribute-filter-match.d.ts +14 -0
- package/dist/backend/services/attribute-filter-match.d.ts.map +1 -0
- package/dist/backend/services/attribute-filter-match.js +19 -0
- package/dist/backend/services/attribute-filter-match.js.map +1 -0
- package/dist/backend/services/attribute-scope-preview.d.ts +48 -0
- package/dist/backend/services/attribute-scope-preview.d.ts.map +1 -0
- package/dist/backend/services/attribute-scope-preview.js +76 -0
- package/dist/backend/services/attribute-scope-preview.js.map +1 -0
- package/dist/backend/services/attribute-set.service.d.ts +10 -1
- package/dist/backend/services/attribute-set.service.d.ts.map +1 -1
- package/dist/backend/services/attribute-set.service.js +30 -4
- package/dist/backend/services/attribute-set.service.js.map +1 -1
- package/dist/backend/services/attribute-type-mapping.d.ts +2 -2
- package/dist/backend/services/attribute-type-mapping.d.ts.map +1 -1
- package/dist/backend/services/attribute-type-mapping.js +6 -0
- package/dist/backend/services/attribute-type-mapping.js.map +1 -1
- package/dist/backend/services/attribute-usage.d.ts +31 -0
- package/dist/backend/services/attribute-usage.d.ts.map +1 -0
- package/dist/backend/services/attribute-usage.js +29 -0
- package/dist/backend/services/attribute-usage.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 +210 -37
- 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 +31 -3
- package/dist/backend/services/bundle.service.js.map +1 -1
- package/dist/backend/services/catalog-admin-search.service.d.ts +4 -3
- package/dist/backend/services/catalog-admin-search.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-admin-search.service.js +7 -7
- package/dist/backend/services/catalog-admin-search.service.js.map +1 -1
- package/dist/backend/services/catalog-admin.service.d.ts +171 -27
- package/dist/backend/services/catalog-admin.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-admin.service.js +634 -315
- package/dist/backend/services/catalog-admin.service.js.map +1 -1
- package/dist/backend/services/catalog-attribute-read.service.d.ts +14 -0
- package/dist/backend/services/catalog-attribute-read.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-attribute-read.service.js +7 -19
- package/dist/backend/services/catalog-attribute-read.service.js.map +1 -1
- package/dist/backend/services/catalog-bulk-import.service.d.ts +72 -3
- package/dist/backend/services/catalog-bulk-import.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-bulk-import.service.js +212 -38
- package/dist/backend/services/catalog-bulk-import.service.js.map +1 -1
- package/dist/backend/services/catalog-bulk-update.service.d.ts +35 -5
- package/dist/backend/services/catalog-bulk-update.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-bulk-update.service.js +123 -14
- 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 +11 -1
- package/dist/backend/services/catalog-product-read.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-product-read.service.js +40 -23
- package/dist/backend/services/catalog-product-read.service.js.map +1 -1
- package/dist/backend/services/catalog-query.service.d.ts +170 -42
- package/dist/backend/services/catalog-query.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-query.service.js +797 -430
- 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 +53 -21
- package/dist/backend/services/catalog-quick-search.service.js.map +1 -1
- package/dist/backend/services/catalog-write-ports.d.ts +16 -1
- package/dist/backend/services/catalog-write-ports.d.ts.map +1 -1
- package/dist/backend/services/catalog-write-ports.js +18 -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 +32 -3
- 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/content-attribute-rules.d.ts +49 -0
- package/dist/backend/services/content-attribute-rules.d.ts.map +1 -0
- package/dist/backend/services/content-attribute-rules.js +89 -0
- package/dist/backend/services/content-attribute-rules.js.map +1 -0
- package/dist/backend/services/effective-value.sql.d.ts +42 -0
- package/dist/backend/services/effective-value.sql.d.ts.map +1 -0
- package/dist/backend/services/effective-value.sql.js +61 -0
- package/dist/backend/services/effective-value.sql.js.map +1 -0
- package/dist/backend/services/gallery-scopes.d.ts +63 -0
- package/dist/backend/services/gallery-scopes.d.ts.map +1 -0
- package/dist/backend/services/gallery-scopes.js +158 -0
- package/dist/backend/services/gallery-scopes.js.map +1 -0
- package/dist/backend/services/gallery.service.d.ts +32 -4
- package/dist/backend/services/gallery.service.d.ts.map +1 -1
- package/dist/backend/services/gallery.service.js +182 -44
- package/dist/backend/services/gallery.service.js.map +1 -1
- package/dist/backend/services/grouped.service.d.ts.map +1 -1
- package/dist/backend/services/grouped.service.js +13 -1
- package/dist/backend/services/grouped.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 +73 -47
- package/dist/backend/services/packaging-unit.service.js.map +1 -1
- package/dist/backend/services/page-builder-content.d.ts +64 -0
- package/dist/backend/services/page-builder-content.d.ts.map +1 -0
- package/dist/backend/services/page-builder-content.js +113 -0
- package/dist/backend/services/page-builder-content.js.map +1 -0
- package/dist/backend/services/primary-asset-url.d.ts +12 -1
- package/dist/backend/services/primary-asset-url.d.ts.map +1 -1
- package/dist/backend/services/primary-asset-url.js +50 -14
- package/dist/backend/services/primary-asset-url.js.map +1 -1
- package/dist/backend/services/product-availability.service.d.ts +92 -0
- package/dist/backend/services/product-availability.service.d.ts.map +1 -0
- package/dist/backend/services/product-availability.service.js +260 -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-content.service.d.ts +62 -0
- package/dist/backend/services/product-content.service.d.ts.map +1 -0
- package/dist/backend/services/product-content.service.js +122 -0
- package/dist/backend/services/product-content.service.js.map +1 -0
- package/dist/backend/services/product-editor-preferences.service.d.ts +6 -0
- package/dist/backend/services/product-editor-preferences.service.d.ts.map +1 -1
- package/dist/backend/services/product-editor-preferences.service.js +12 -0
- package/dist/backend/services/product-editor-preferences.service.js.map +1 -1
- package/dist/backend/services/product-global-field-rules.d.ts +39 -0
- package/dist/backend/services/product-global-field-rules.d.ts.map +1 -0
- package/dist/backend/services/product-global-field-rules.js +84 -0
- package/dist/backend/services/product-global-field-rules.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 +44 -36
- package/dist/backend/services/product-link.service.js.map +1 -1
- package/dist/backend/services/product-list-view-service.d.ts.map +1 -1
- package/dist/backend/services/product-list-view-service.js +5 -8
- package/dist/backend/services/product-list-view-service.js.map +1 -1
- package/dist/backend/services/product-page-revalidation.d.ts +60 -0
- package/dist/backend/services/product-page-revalidation.d.ts.map +1 -0
- package/dist/backend/services/product-page-revalidation.js +165 -0
- package/dist/backend/services/product-page-revalidation.js.map +1 -0
- package/dist/backend/services/product-scopes.service.d.ts +221 -0
- package/dist/backend/services/product-scopes.service.d.ts.map +1 -0
- package/dist/backend/services/product-scopes.service.js +692 -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/product-value-resolver.service.d.ts +2 -2
- package/dist/backend/services/product-value-resolver.service.d.ts.map +1 -1
- package/dist/backend/services/product-value-resolver.service.js +4 -7
- package/dist/backend/services/product-value-resolver.service.js.map +1 -1
- package/dist/backend/services/publication-window-sweep.d.ts +131 -0
- package/dist/backend/services/publication-window-sweep.d.ts.map +1 -0
- package/dist/backend/services/publication-window-sweep.js +204 -0
- package/dist/backend/services/publication-window-sweep.js.map +1 -0
- package/dist/backend/services/scheduled-work-probe.d.ts +34 -0
- package/dist/backend/services/scheduled-work-probe.d.ts.map +1 -0
- package/dist/backend/services/scheduled-work-probe.js +30 -0
- package/dist/backend/services/scheduled-work-probe.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 +173 -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 +329 -0
- package/dist/backend/services/scope-overview.service.js.map +1 -0
- package/dist/backend/services/scoped-store-adapters.d.ts +58 -0
- package/dist/backend/services/scoped-store-adapters.d.ts.map +1 -0
- package/dist/backend/services/scoped-store-adapters.js +92 -0
- package/dist/backend/services/scoped-store-adapters.js.map +1 -0
- package/dist/backend/services/scoped-values-global-only.d.ts +36 -0
- package/dist/backend/services/scoped-values-global-only.d.ts.map +1 -0
- package/dist/backend/services/scoped-values-global-only.js +92 -0
- package/dist/backend/services/scoped-values-global-only.js.map +1 -0
- package/dist/backend/services/scoped-values-import.d.ts +86 -0
- package/dist/backend/services/scoped-values-import.d.ts.map +1 -0
- package/dist/backend/services/scoped-values-import.js +320 -0
- package/dist/backend/services/scoped-values-import.js.map +1 -0
- package/dist/backend/services/scoped-values-read.service.d.ts +56 -0
- package/dist/backend/services/scoped-values-read.service.d.ts.map +1 -0
- package/dist/backend/services/scoped-values-read.service.js +289 -0
- package/dist/backend/services/scoped-values-read.service.js.map +1 -0
- package/dist/backend/services/scoped-values-save.service.d.ts +79 -0
- package/dist/backend/services/scoped-values-save.service.d.ts.map +1 -0
- package/dist/backend/services/scoped-values-save.service.js +675 -0
- package/dist/backend/services/scoped-values-save.service.js.map +1 -0
- package/dist/backend/services/scoped-values-state.d.ts +94 -0
- package/dist/backend/services/scoped-values-state.d.ts.map +1 -0
- package/dist/backend/services/scoped-values-state.js +159 -0
- package/dist/backend/services/scoped-values-state.js.map +1 -0
- package/dist/backend/services/scoped-values.service.d.ts +36 -0
- package/dist/backend/services/scoped-values.service.d.ts.map +1 -0
- package/dist/backend/services/scoped-values.service.js +92 -0
- package/dist/backend/services/scoped-values.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/storefront-value-overrides.d.ts +7 -8
- package/dist/backend/services/storefront-value-overrides.d.ts.map +1 -1
- package/dist/backend/services/storefront-value-overrides.js +11 -14
- package/dist/backend/services/storefront-value-overrides.js.map +1 -1
- package/dist/backend/services/url-key-resolution.service.d.ts +70 -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 +123 -0
- package/dist/backend/services/url-key.service.d.ts.map +1 -0
- package/dist/backend/services/url-key.service.js +566 -0
- package/dist/backend/services/url-key.service.js.map +1 -0
- package/dist/manifest.d.ts +9 -1
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +204 -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/20261030T113855_catalog_scope_model_texts.d.ts +36 -0
- package/dist/migrations/20261030T113855_catalog_scope_model_texts.d.ts.map +1 -0
- package/dist/migrations/20261030T113855_catalog_scope_model_texts.js +225 -0
- package/dist/migrations/20261030T113855_catalog_scope_model_texts.js.map +1 -0
- package/dist/migrations/20261030T113859_catalog_scope_model_order_rules.d.ts +18 -0
- package/dist/migrations/20261030T113859_catalog_scope_model_order_rules.d.ts.map +1 -0
- package/dist/migrations/20261030T113859_catalog_scope_model_order_rules.js +39 -0
- package/dist/migrations/20261030T113859_catalog_scope_model_order_rules.js.map +1 -0
- package/dist/migrations/20261030T113904_catalog_scope_model_url_keys.d.ts +6 -0
- package/dist/migrations/20261030T113904_catalog_scope_model_url_keys.d.ts.map +1 -0
- package/dist/migrations/20261030T113904_catalog_scope_model_url_keys.js +119 -0
- package/dist/migrations/20261030T113904_catalog_scope_model_url_keys.js.map +1 -0
- package/dist/migrations/20261030T113908_catalog_scope_model_media.d.ts +6 -0
- package/dist/migrations/20261030T113908_catalog_scope_model_media.d.ts.map +1 -0
- package/dist/migrations/20261030T113908_catalog_scope_model_media.js +185 -0
- package/dist/migrations/20261030T113908_catalog_scope_model_media.js.map +1 -0
- package/dist/migrations/20261104T121504_catalog_product_content_values.d.ts +36 -0
- package/dist/migrations/20261104T121504_catalog_product_content_values.d.ts.map +1 -0
- package/dist/migrations/20261104T121504_catalog_product_content_values.js +53 -0
- package/dist/migrations/20261104T121504_catalog_product_content_values.js.map +1 -0
- package/dist/migrations/20261107T093126_catalog_sku_unique_among_live.d.ts +33 -0
- package/dist/migrations/20261107T093126_catalog_sku_unique_among_live.d.ts.map +1 -0
- package/dist/migrations/20261107T093126_catalog_sku_unique_among_live.js +58 -0
- package/dist/migrations/20261107T093126_catalog_sku_unique_among_live.js.map +1 -0
- package/dist/migrations/20261107T120008_catalog_product_created_at_milliseconds.d.ts +36 -0
- package/dist/migrations/20261107T120008_catalog_product_created_at_milliseconds.d.ts.map +1 -0
- package/dist/migrations/20261107T120008_catalog_product_created_at_milliseconds.js +40 -0
- package/dist/migrations/20261107T120008_catalog_product_created_at_milliseconds.js.map +1 -0
- package/dist/migrations/index.d.ts +13 -1
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +25 -1
- package/dist/migrations/index.js.map +1 -1
- package/docs/catalog/attachments.md +60 -8
- package/docs/catalog/attribute-sets.md +2 -2
- package/docs/catalog/attributes.md +68 -8
- package/docs/catalog/category-content.md +3 -0
- package/docs/catalog/composite-products.md +2 -2
- package/docs/catalog/editing-a-product-at-a-scope.md +95 -0
- package/docs/catalog/gallery-and-labels.md +68 -8
- package/docs/catalog/packaging-units.md +56 -10
- package/docs/catalog/per-channel-per-language-overrides.md +68 -237
- package/docs/catalog/product-content.md +180 -0
- package/docs/catalog/product-links.md +2 -2
- package/docs/catalog/url-keys-and-redirects.md +142 -0
- package/docs/catalog.md +241 -20
- package/i18n/en.json +977 -123
- package/i18n/pl.json +976 -122
- package/package.json +12 -12
- package/dist/admin/components/ProductScopeEditor.d.ts +0 -94
- package/dist/admin/components/ProductScopeEditor.d.ts.map +0 -1
- package/dist/admin/components/ProductScopeEditor.js +0 -395
- package/dist/admin/components/ProductScopeEditor.js.map +0 -1
- package/dist/backend/services/product-overrides.service.d.ts +0 -77
- package/dist/backend/services/product-overrides.service.d.ts.map +0 -1
- package/dist/backend/services/product-overrides.service.js +0 -204
- package/dist/backend/services/product-overrides.service.js.map +0 -1
- package/dist/backend/services/product-scope-context.service.d.ts +0 -36
- package/dist/backend/services/product-scope-context.service.d.ts.map +0 -1
- package/dist/backend/services/product-scope-context.service.js +0 -106
- package/dist/backend/services/product-scope-context.service.js.map +0 -1
|
@@ -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 follows the product scopes — Global, Channel
|
|
8
|
+
and Channel × language:
|
|
9
|
+
|
|
10
|
+
- **Global key** — the product's `slug`; it is the key wherever the product has no key of its own;
|
|
11
|
+
- **Channel key** — one per sales channel, in every language that channel offers;
|
|
12
|
+
- **Channel × language key** — one per channel and language, overriding the Channel key there.
|
|
13
|
+
|
|
14
|
+
There is no language-only key. The **effective key** at a sales channel and language is the
|
|
15
|
+
Channel × language key, else the Channel key, else the Global key. Every product URL the platform
|
|
16
|
+
emits — the storefront's canonical and alternate-language links, the sitemap, a redirect target,
|
|
17
|
+
the preview address in the admin — uses the effective key, under the language's path prefix.
|
|
18
|
+
|
|
19
|
+
A key text belongs to **at most one product per sales channel**, across all the channel's
|
|
20
|
+
languages; the same product may use it in several languages. A Global key equals no other
|
|
21
|
+
product's Global key, Channel key, Channel × language key or redirect anywhere. Changing a key
|
|
22
|
+
keeps the previous one as a permanent redirect at that channel and language, straight to the
|
|
23
|
+
product; redirects are kept until an operator deletes them. Redirects are served while the `seo`
|
|
24
|
+
module is switched on; with `seo` off an old key answers "not found", and the redirects come back
|
|
25
|
+
when `seo` is switched on. A product's other **current** keys are not redirects: with `seo` off too,
|
|
26
|
+
a request for its Channel or Global key where a narrower key overrides it still leads to its URL in
|
|
27
|
+
that channel.
|
|
28
|
+
|
|
29
|
+
## Managing keys
|
|
30
|
+
|
|
31
|
+
In the product editor the URL key is one field at the editor's scope, like the name: at Global it
|
|
32
|
+
is the Global key, at a channel or a channel and language it either shows "Use value from *parent
|
|
33
|
+
scope*" or holds the key of its own. It is saved with the rest of the scope by
|
|
34
|
+
`PUT …/products/:id/scoped-values` (`urlKey`). While the `seo` module is on the editor also lists
|
|
35
|
+
the redirects the old keys keep — at the editor's channel and language, at every language of the
|
|
36
|
+
channel, or all of them at Global.
|
|
37
|
+
|
|
38
|
+
For API clients, `GET /api/v1/admin/catalog/products/:id/url-keys` (`catalog:read`) answers every
|
|
39
|
+
key, the effective key and URL at each channel and language, and the redirects; `PUT` on the same
|
|
40
|
+
path (`catalog:write`) writes keys:
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"globalKey": "cordless-drill",
|
|
45
|
+
"channelKeys": [
|
|
46
|
+
{ "channelId": "<retail-uuid>", "key": "wiertarka" },
|
|
47
|
+
{ "channelId": "<retail-uuid>", "languageCode": "en-US", "key": { "inherit": true } }
|
|
48
|
+
]
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
An entry without `languageCode` (or with `null`) is the Channel key; one with a language is the
|
|
53
|
+
Channel × language key. A list or key left out is unchanged; `{ "inherit": true }` removes the key at
|
|
54
|
+
that scope, so the inherited key applies there again. `null` is refused: the URL key is required.
|
|
55
|
+
A key is lower-case kebab case, at most 160 characters. A key for a sales channel the product is not
|
|
56
|
+
in, or a language the channel does not offer, is refused with `422 SCOPE_INVALID`; a key left behind
|
|
57
|
+
by a channel the product has left is shown as **No longer applies** and can be removed.
|
|
58
|
+
|
|
59
|
+
- **A key another product holds** in that channel, in any of its languages, is refused with
|
|
60
|
+
`409 URL_KEY_TAKEN`, naming the product (`details.conflicts`). A deleted product's Global key
|
|
61
|
+
stays taken; its Channel and Channel × language keys are released.
|
|
62
|
+
- **A key that is another product's redirect** answers `409 URL_KEY_REDIRECT_TAKEOVER_REQUIRED`,
|
|
63
|
+
naming the product that would lose the redirect (`details.takeovers`). Sending the same request
|
|
64
|
+
again with the key in `confirmTakeover` takes it over. Only an operator can do this; an
|
|
65
|
+
integration never takes over a redirect.
|
|
66
|
+
- **A changed key stays as a redirect** at each channel and language where it was effective,
|
|
67
|
+
pointing at the product, not at a key, so redirects never chain. At most 50 are kept per product and
|
|
68
|
+
channel; the oldest is dropped and named in the audit entry. A redirect is kept until an operator deletes it:
|
|
69
|
+
`DELETE /api/v1/admin/catalog/products/:id/url-redirects/:redirectId` (`catalog:write`). Deleting
|
|
70
|
+
a product removes its redirects. While `seo` is off the answer leaves `redirects` out, but the
|
|
71
|
+
rows stay and keep reserving their keys.
|
|
72
|
+
|
|
73
|
+
A `PUT` is one audited Command, `product.url_keys.update`, whose before-state sent back through the
|
|
74
|
+
same route restores the keys; a redirect delete is `product.url_redirect.delete`. Both announce
|
|
75
|
+
`product.updated.v1` with `changedFields: ["urlKeys"]`. A `PUT` that changes nothing writes no audit
|
|
76
|
+
entry and leaves the product's version. A new or duplicated product's Global key is chosen free of
|
|
77
|
+
every live product's keys and redirects.
|
|
78
|
+
|
|
79
|
+
## On the storefront
|
|
80
|
+
|
|
81
|
+
`GET /api/v1/catalog/products/resolve/:key` resolves a key at the request's sales channel and
|
|
82
|
+
language:
|
|
83
|
+
|
|
84
|
+
- the product's effective key there answers `{ kind: "product", productId, key }`;
|
|
85
|
+
- another current key of the product at that channel and language (its Channel or Global key where
|
|
86
|
+
a narrower key overrides it), and — while `seo` is on — its redirects there, answer
|
|
87
|
+
`{ kind: "redirect", key, languageCode, path, permanent: true }`, `path` being the product's URL to
|
|
88
|
+
redirect to;
|
|
89
|
+
- a current key of the product in another language of the channel answers the same with
|
|
90
|
+
`permanent: false`: a key held in another language today may be another product's tomorrow;
|
|
91
|
+
- a key of no product there, and a product that is not available to the caller there, answer the
|
|
92
|
+
same `404 PRODUCT_NOT_FOUND`; an archived product answers `410 PRODUCT_ARCHIVED`.
|
|
93
|
+
|
|
94
|
+
`GET /api/v1/catalog/products/:idOrSlug` accepts an id, a current key at the request's channel and
|
|
95
|
+
language, or a product's Global key — never a redirect. The product detail carries
|
|
96
|
+
`paths: { canonical, alternates }`: the page's URL at the request's channel and language, and one
|
|
97
|
+
per channel language where the product is available to anonymous visitors. `slug` on the listing,
|
|
98
|
+
the product detail, grouped and bundle children and product-link tiles is the effective key at the
|
|
99
|
+
request's channel and language.
|
|
100
|
+
|
|
101
|
+
## Errors
|
|
102
|
+
|
|
103
|
+
| Code | Status | When |
|
|
104
|
+
| --- | --- | --- |
|
|
105
|
+
| `URL_KEY_TAKEN` | 409 | The key is another product's key in that channel (any language), or, for a Global key, anywhere |
|
|
106
|
+
| `URL_KEY_REDIRECT_TAKEOVER_REQUIRED` | 409 | The key is another product's redirect and the write did not confirm the takeover |
|
|
107
|
+
| `URL_REDIRECT_NOT_FOUND` | 404 | `:redirectId` is not a redirect of the product |
|
|
108
|
+
| `SCOPE_INVALID` | 422 | A key for a channel the product is not in, or a language the channel does not offer |
|
|
109
|
+
| `PRODUCT_NOT_FOUND` | 404 | The storefront resolve found no product available to the caller |
|
|
110
|
+
| `PRODUCT_ARCHIVED` | 410 | The storefront resolve found an archived product |
|
|
111
|
+
|
|
112
|
+
## Integrations
|
|
113
|
+
|
|
114
|
+
What a connector, a PIM synchronisation or a spreadsheet writes, and at which scope. An integration
|
|
115
|
+
writes only the scopes it names: writing a Global value never removes an operator's override at a
|
|
116
|
+
sales channel or a channel and language (FR-091).
|
|
117
|
+
|
|
118
|
+
Connectors write through `catalogProductScopeWritePort.applyScopes` (version 2): a list of cells,
|
|
119
|
+
each a scope (`{}`, `{ channelId }` or `{ channelId, languageCode }`), a field path and a value in
|
|
120
|
+
the write encoding — absent for no change, `null` for deliberately empty, `{ "inherit": true }` to
|
|
121
|
+
remove the own value. A connector may write the name, the description, attribute values, gallery
|
|
122
|
+
alt text, attachment names and descriptions, packaging-unit names, the status, the publication
|
|
123
|
+
window and the URL key. Every other field — the audience, Global-only product fields, SEO, gallery
|
|
124
|
+
roles, hidden flags, the minimum order quantity and returnable — is refused per cell with
|
|
125
|
+
`not_supported`; the rest of the call still applies. How a PIM's locales become scopes is the
|
|
126
|
+
import profile's mapping, described on the `import_export` and `pim_connector` pages.
|
|
127
|
+
|
|
128
|
+
**URL keys from an integration are never forced.** A key that is another product's key in that
|
|
129
|
+
channel, or another product's redirect, is not written: the product keeps its previous key at that
|
|
130
|
+
scope and the call reports, per key, `{ written: false, issue: { languageCode, channelId, key,
|
|
131
|
+
heldByProductId, kind } }` — `kind` is `current` or `redirect`. An integration never takes over
|
|
132
|
+
another product's redirect and is never asked to confirm one; only an operator can, in the product
|
|
133
|
+
editor (FR-093). An integration reserves at most 1 000 new keys per run; the rest are reported as
|
|
134
|
+
`limit_reached`.
|
|
135
|
+
|
|
136
|
+
**No completeness check runs** on an integration's write; the operator's warnings about missing
|
|
137
|
+
names and keys in a scope are an editor feature.
|
|
138
|
+
|
|
139
|
+
**The products CSV** writes the same scopes through column headers `<field>`, `<field>@<channel
|
|
140
|
+
code>` and `<field>@<channel code>/<language>`, with the cell tokens `NULL` and `INHERIT`; the
|
|
141
|
+
`import_export` page describes the grammar. Every write is audited and announced with
|
|
142
|
+
`product.updated.v1`, whose `changedFields` name what changed.
|
package/docs/catalog.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: Catalog
|
|
3
3
|
sidebar_label: Catalog
|
|
4
4
|
description: Products, variants, categories, attributes, sales channels
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# `catalog`
|
|
7
|
+
# Catalog (`catalog`)
|
|
8
8
|
|
|
9
9
|
The product catalog: Products, ProductVariants, Categories,
|
|
10
10
|
ProductAttributes, and SalesChannels. Owns all read paths the storefront
|
|
@@ -24,23 +24,26 @@ otherwise; every price names its currency either way. A malformed code is refuse
|
|
|
24
24
|
| Verb + Path | Audience | Purpose |
|
|
25
25
|
| --- | --- | --- |
|
|
26
26
|
| `GET /api/v1/catalog/products` | storefront / API key | List/search/filter products in the active Sales Channel |
|
|
27
|
-
| `GET /api/v1/catalog/products/:idOrSlug` | storefront | Product detail (price
|
|
27
|
+
| `GET /api/v1/catalog/products/:idOrSlug` | storefront | Product detail (no amount where the viewer's price display mode is *None*); `?include=content` adds the product's Page Builder content ([Product content](./catalog/product-content.md)) |
|
|
28
28
|
| `GET /api/v1/catalog/categories` | storefront | Nested category tree |
|
|
29
29
|
| `GET /api/v1/catalog/categories/:id/content` | storefront | One category's page content, resolved to the caller's language |
|
|
30
30
|
| `GET /api/v1/catalog/filters` | storefront | Filterable attributes for the active Sales Channel |
|
|
31
31
|
| `GET /api/v1/catalog/sitemap.xml` | crawlers | SEO sitemap |
|
|
32
|
-
| `GET /api/v1/admin/catalog/products?
|
|
32
|
+
| `GET /api/v1/admin/catalog/products?status&archived` | admin | Admin product list. `status` is `active` or `inactive` (any other value: `400 VALIDATION_FAILED`); `archived` is `exclude` (default), `include` or `only` — the legacy `includeArchived=1` means `include`. `counts` is `{ all, active, inactive, archived }` — see *Product status and archiving* |
|
|
33
33
|
| `GET /api/v1/admin/catalog/products/:id` | admin | Product detail |
|
|
34
34
|
| `POST /api/v1/admin/catalog/products` | admin | Create product (`type` immutable post-create; `sku` is editable) |
|
|
35
35
|
| `PATCH /api/v1/admin/catalog/products/:id` | admin | Update (incl. `sku`); writes an audit row with stateBefore / stateAfter; refuses with `409 sku_in_use` if the new SKU already belongs to another product |
|
|
36
|
-
| `DELETE /api/v1/admin/catalog/products/:id` | admin |
|
|
36
|
+
| `DELETE /api/v1/admin/catalog/products/:id` | admin | Delete (soft) — not the Archive action; frees the SKUs of the product and its variants ([below](#a-deleted-product-frees-its-sku)) |
|
|
37
|
+
| `POST /api/v1/admin/catalog/products/:id/archive` | admin (`catalog:write`) | Archive one product — see *Product status and archiving* |
|
|
38
|
+
| `POST /api/v1/admin/catalog/products/:id/restore` | admin (`catalog:write`) | Restore one archived product |
|
|
37
39
|
| `GET`, `POST /api/v1/admin/catalog/products/list-views`; `PATCH`, `DELETE …/list-views/:id` | admin | Saved views on the product list — see *Saved views* below |
|
|
38
40
|
| `GET /api/v1/admin/catalog/attributes` | admin | List attributes |
|
|
39
41
|
| `GET /api/v1/admin/catalog/attributes/by-flag?flag=isPromoRule\|isComparable\|...` | admin | Picker payload — every attribute carrying the requested flag |
|
|
40
42
|
| `GET /api/v1/admin/catalog/attributes/:idOrKey` | admin | Single attribute read |
|
|
41
43
|
| `POST /api/v1/admin/catalog/attributes` | admin | Create attribute (accepts the new flags + inline `options[]` for select-style types) |
|
|
42
44
|
| `PATCH /api/v1/admin/catalog/attributes/:key` | admin | Hot-toggle `isFilterable` / `isSearchable` / `isVariantAxis` / `isPromoRule` / `isPriceRule` / `isComparable` / `isVisibleOnProductPage` / `isRequired` / `filterPosition` (re-emits `attribute.updated.v1`) |
|
|
43
|
-
| `
|
|
45
|
+
| `GET /api/v1/admin/catalog/attributes/:idOrKey/usage` | admin | What deleting the attribute would meet — set memberships, product values, product content ([Attributes](./catalog/attributes.md#deleting-an-attribute)) |
|
|
46
|
+
| `DELETE /api/v1/admin/catalog/attributes/:idOrKey` | admin | Delete an attribute of any type; refused with `409` while an Attribute Set contains it or a live product holds a value for it (on the product, per sales channel or on a variant) |
|
|
44
47
|
| `GET /api/v1/admin/catalog/attributes/:idOrKey/options` | admin | List option-list rows for select/enum/multiselect attributes |
|
|
45
48
|
| `POST /api/v1/admin/catalog/attributes/:idOrKey/options` | admin | Append an option |
|
|
46
49
|
| `PATCH /api/v1/admin/catalog/attribute-options/:optionId` | admin | Patch label / labelDefault / isDefault / sortOrder (option `value` is immutable) |
|
|
@@ -52,7 +55,102 @@ otherwise; every price names its currency either way. A malformed code is refuse
|
|
|
52
55
|
| `DELETE /api/v1/admin/catalog/categories/:id` | admin | Soft-delete; rejects with 409 if any active child still references the row |
|
|
53
56
|
| `GET /api/v1/admin/catalog/categories/:id/content` | admin | The category's page content — one Page Builder document per language ([Category page content](./catalog/category-content.md)) |
|
|
54
57
|
| `PUT /api/v1/admin/catalog/categories/:id/content` | admin | Replace the category's page content; `null` clears it |
|
|
55
|
-
| `
|
|
58
|
+
| `GET /api/v1/admin/catalog/products/:id/content` | admin | The product's content attributes with a per-language summary ([Product content](./catalog/product-content.md)) |
|
|
59
|
+
| `GET /api/v1/admin/catalog/products/:id/content/:attributeKey` | admin | One content attribute's envelope — one Page Builder document per language |
|
|
60
|
+
| `PUT /api/v1/admin/catalog/products/:id/content/:attributeKey` | admin | Replace one content attribute's envelope; `null` clears it |
|
|
61
|
+
| `PUT /api/v1/catalog/products/by-sku/:sku` | API key | Idempotent upsert (PIM sync); an update is audited as `product.update` naming the key (`apiKeyId`) and is never checked for completeness |
|
|
62
|
+
|
|
63
|
+
## Product status and archiving
|
|
64
|
+
|
|
65
|
+
A product's **status** is `active` or `inactive`, globally and as an override per
|
|
66
|
+
Sales Channel and per channel × language. `inactive` at any scope is plain **off**
|
|
67
|
+
there: the product is not listed, not searchable, not orderable and its page answers as
|
|
68
|
+
a product that does not exist. Switching a product off never archives it. New and
|
|
69
|
+
duplicated products start `inactive`. Any other status value is refused with
|
|
70
|
+
`400 VALIDATION_FAILED` — on the admin API, the API-key upsert
|
|
71
|
+
`PUT /api/v1/catalog/products/by-sku/:sku` and an import; archiving is not a status.
|
|
72
|
+
|
|
73
|
+
**Archiving** is a separate, product-wide action, offered as **Archive** and
|
|
74
|
+
**Restore** (`POST …/products/:id/archive`, `…/restore`) and gated by `catalog:write`.
|
|
75
|
+
Archive sets the product's archived time and takes it out of every channel; Restore
|
|
76
|
+
clears it. Neither changes the status at any scope, and each writes one audit entry
|
|
77
|
+
with the archived time before and after. Archiving an archived product, or restoring
|
|
78
|
+
one that is not archived, answers `200` and changes nothing — no audit entry, no event.
|
|
79
|
+
|
|
80
|
+
- **Bulk.** `POST /api/v1/admin/catalog/products/bulk-update` with
|
|
81
|
+
`fields: { archived: true }` archives every selected product, `false` restores them,
|
|
82
|
+
each through the same action and audit entry. `archived` must be the only field of
|
|
83
|
+
its request. Large selections run as a background bulk operation, and the
|
|
84
|
+
operation's undo puts every product back as it was. A background operation audits
|
|
85
|
+
each product with the admin who requested it, as a direct one does. Archive and
|
|
86
|
+
Restore lock the product, so two concurrent Archives of one product archive it once.
|
|
87
|
+
- **Setting `active` never restores.** An archived product stays archived whatever its
|
|
88
|
+
status; only Restore brings it back. Restoring an `inactive` product leaves it off.
|
|
89
|
+
- **Products archived before this change.** Until this release a product was archived by
|
|
90
|
+
setting it `inactive`. Every product `inactive` at the upgrade therefore stays
|
|
91
|
+
archived (keeping its archived time, or its last-update time when it had none), and
|
|
92
|
+
**needs an explicit Restore** to come back — setting it `active` alone leaves it
|
|
93
|
+
archived.
|
|
94
|
+
- **The product page.** An archived product's page answers `410 PRODUCT_ARCHIVED`
|
|
95
|
+
("gone"), but only to a buyer who could otherwise see it there: the check takes the
|
|
96
|
+
archive away and reads the global status as `active`, while every channel and channel
|
|
97
|
+
× language status, the membership, the channel's languages, the publication window and
|
|
98
|
+
the audience still apply. Everywhere else, and for any product that is off without
|
|
99
|
+
being archived, the page answers `404` exactly as for a product that does not exist.
|
|
100
|
+
- **The admin list.** Archived products are hidden by default, whatever their status;
|
|
101
|
+
`archived=only` lists them and `archived=include` lists them beside the rest. The
|
|
102
|
+
`inactive` count and filter cover products that are off but not archived.
|
|
103
|
+
On the product list the **Archived** tab has its own address,
|
|
104
|
+
`/catalog/products/archived`, so the browser's Back button and a reload return to it, and
|
|
105
|
+
the command palette (⌘K / CTRL+K) opens it as **Archived products** — search for
|
|
106
|
+
"archived" or "archiwum".
|
|
107
|
+
With a selection, its bar offers Restore, Bulk edit and Delete; **Edit price** is shown
|
|
108
|
+
on the other tabs but disabled, because prices are set in price books.
|
|
109
|
+
- **From the admin assistant.** The assistant's `catalog.archive_product` and
|
|
110
|
+
`catalog.restore_product` tools (`catalog:write`) archive and restore products after
|
|
111
|
+
you confirm the plan it shows, through the same action and audit entry, with you as
|
|
112
|
+
the actor; larger selections run as the bulk operation above. Its status tool,
|
|
113
|
+
`catalog.set_product_status`, only switches products on or off and never archives or
|
|
114
|
+
restores, and its product search lists archived products and says which they are.
|
|
115
|
+
|
|
116
|
+
### Status per channel and language, in bulk
|
|
117
|
+
|
|
118
|
+
`POST /api/v1/admin/catalog/products/bulk-update` with
|
|
119
|
+
`fields: { scopedStatus: { channelId, languageCode, value } }` sets the status of every
|
|
120
|
+
selected product at one scope — the Sales Channel (`languageCode: null`) or one
|
|
121
|
+
channel × language — to `active` or `inactive`, or removes the override there with
|
|
122
|
+
`inherit`. Only that scope changes on each product; every other scope and the global
|
|
123
|
+
status stay as they were. A product that is not in the channel, or a language the
|
|
124
|
+
channel does not offer, is skipped and reported as `scope_invalid` — the product is
|
|
125
|
+
never added to the channel. `scopedStatus` cannot be combined with `status` in one
|
|
126
|
+
request. Each product's change is one audit entry naming the scope; large selections
|
|
127
|
+
run as a background bulk operation whose undo puts every scope back as it was and
|
|
128
|
+
reports any product changed since.
|
|
129
|
+
|
|
130
|
+
### Completeness check when switching a product on
|
|
131
|
+
|
|
132
|
+
When an operator's **status change** switches a product on for a sales channel and
|
|
133
|
+
language — the global status, a channel or channel × language status, single or in
|
|
134
|
+
bulk — the product must have, at that channel and language: a non-empty effective
|
|
135
|
+
**name** (Channel × language → Channel → Global; a deliberately empty override counts
|
|
136
|
+
as missing), a **URL key** (the Global key counts) and an effective value for every
|
|
137
|
+
**required** attribute of its attribute set. The setting **Completeness check when switching a
|
|
138
|
+
product on** (`catalog.scope_completeness_gate`, one value for the whole platform)
|
|
139
|
+
decides what happens when something is missing:
|
|
140
|
+
|
|
141
|
+
- **`warn`** (the default) — the change is saved and the answer lists what is missing
|
|
142
|
+
per channel and language (`warnings`, kind `completeness`).
|
|
143
|
+
- **`refuse`** — the change is not saved: `422 SCOPE_INCOMPLETE` names every channel and
|
|
144
|
+
language with what it lacks. A change that would switch the product on in several
|
|
145
|
+
places is refused as a whole if any of them fails. In a bulk edit the products that
|
|
146
|
+
pass are changed and the others are skipped as `completeness_gate`.
|
|
147
|
+
|
|
148
|
+
Only a status change is checked. A product that goes live because it joins a channel,
|
|
149
|
+
a channel gains a language, its publication window opens, its audience changes, or it
|
|
150
|
+
is restored is not checked; the **scope map** of the product editor shows what is
|
|
151
|
+
missing at every channel and language instead. Setting an archived product `active` is
|
|
152
|
+
checked like any status change, although the product stays archived. Imports, PIM
|
|
153
|
+
synchronisation and the API-key upsert are never checked.
|
|
56
154
|
|
|
57
155
|
## Prices
|
|
58
156
|
|
|
@@ -79,7 +177,34 @@ buyer pays is chosen.
|
|
|
79
177
|
change meanwhile; a product repriced during the walk may be met twice or not at all, as with any
|
|
80
178
|
cursor over a live price. A page may be short, or even empty, and still have more after it
|
|
81
179
|
(`hasMore: true`) when most of the rows it read are hidden from the viewer; follow its cursor.
|
|
82
|
-
|
|
180
|
+
The cursor of a price ordering or a price range is sealed: it cannot be read or altered, because
|
|
181
|
+
the position it continues from can be a product the viewer may not see. A cursor that does not
|
|
182
|
+
open — altered, issued by a release before the seal, or before the instance's session key was
|
|
183
|
+
changed — starts the listing again at its first page.
|
|
184
|
+
- **Paging and creation time** — the default ordering, and the order of the unpriced products that
|
|
185
|
+
follow a price ordering, is the product's creation time, newest first. It is stored to the
|
|
186
|
+
millisecond: a value written by SQL, such as an import's or a bulk insert's `now()`, is rounded
|
|
187
|
+
to the millisecond as it is stored. So a walk through the listing by its cursor meets every
|
|
188
|
+
product once, including products created within the same millisecond.
|
|
189
|
+
- **Reading named products** — `?ids=<id>,<id>,…` on `GET /api/v1/catalog/products` restricts the
|
|
190
|
+
listing to those products: at most 24 distinct ids, each a uuid, or `400 VALIDATION_FAILED`. The
|
|
191
|
+
answer is the subset the viewer may see, priced exactly as any listing card for that viewer, in
|
|
192
|
+
the listing's own order — a caller that cares about its order re-orders by id. It combines with the
|
|
193
|
+
other filters and is always answered from PostgreSQL. A blog post's related products are read this
|
|
194
|
+
way.
|
|
195
|
+
- **Where the viewer's price display mode is *None*** — for instance an anonymous visitor on a
|
|
196
|
+
channel that hides prices until sign-in — the listing and the product detail carry no amount, and
|
|
197
|
+
a price ordering or range is refused for that page. Sales channels have no price-visibility flag
|
|
198
|
+
of their own any more: the display mode decides, for each viewer.
|
|
199
|
+
- **Gross prices use each product's own VAT rate.** Every product on the listing and the product
|
|
200
|
+
detail carries `vatRate`, the VAT rate the viewer is charged for it, as a fraction (`0.08` = 8 %).
|
|
201
|
+
It is the rate the cart and the order apply: the product's tax class (its type) against the
|
|
202
|
+
viewer's organization — its VAT status and registered country. A VAT-exempt or reverse-charge
|
|
203
|
+
organization gets `0`; an anonymous visitor, or a buyer with no organization, is treated as a VAT
|
|
204
|
+
payer in Poland. The storefront derives every product's gross price — on the cards, the list rows
|
|
205
|
+
and the product page — from this rate. Where a reply carries no rate (`null` when the rate could
|
|
206
|
+
not be read, or no field from an older backend), the storefront shows the net price, labelled
|
|
207
|
+
net, and never a gross at an assumed rate.
|
|
83
208
|
|
|
84
209
|
For developers: the listing paths price a whole page in one batched call —
|
|
85
210
|
`resolveListingPrices`, or `resolveListingPriceDetails` where the page renders the split
|
|
@@ -93,6 +218,14 @@ category and attribute writes publish the events `price_lists` subscribes to, wh
|
|
|
93
218
|
pricing caches and mark on the price surface the products each event concerns, for the surface
|
|
94
219
|
worker to refresh.
|
|
95
220
|
|
|
221
|
+
`vatRate` is resolved per reply by `createProductTaxRateResolver` (`@endora-commerce/contracts`),
|
|
222
|
+
the rule the cart uses too, over `organizations`' `organizationTaxProfilePort` and `taxes`'
|
|
223
|
+
`taxService`. It depends on the viewer's organization and nothing else about the viewer, so it
|
|
224
|
+
follows the same cache rule as the price: a reply for a viewer naming an organization is
|
|
225
|
+
`Cache-Control: private, no-store`, and the shareable reply is the anonymous one, which carries the
|
|
226
|
+
guest's rate. A failed resolution answers `vatRate: null` on every product rather than refusing the
|
|
227
|
+
listing.
|
|
228
|
+
|
|
96
229
|
### Removed price fields (migration note)
|
|
97
230
|
|
|
98
231
|
The release that introduced price books removed the product's *Default unit price* (the
|
|
@@ -239,16 +372,19 @@ modules are present. The payload is sent whole; the strict schemas are
|
|
|
239
372
|
| Event | Sent when | Payload, beside `eventId` and `occurredAt` |
|
|
240
373
|
| --- | --- | --- |
|
|
241
374
|
| `product.created.v1` | A product is created — in the Admin UI, through the API-key upsert, by an import or a PIM synchronisation, or by duplicating another product. | `productId` (UUID), `sku` — the SKU it was created with; it can change later, `productId` cannot. |
|
|
242
|
-
| `product.updated.v1` | A product is written, or one of its variants is created, changed or deleted. | `productId`, `changedFields` — the names of the product fields the write
|
|
243
|
-
| `product.archived.v1` | A product
|
|
244
|
-
|
|
245
|
-
- **Order.**
|
|
246
|
-
`changedFields`) and then `product.archived.v1`,
|
|
247
|
-
|
|
248
|
-
- **
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
375
|
+
| `product.updated.v1` | A product is written, or one of its variants is created, changed or deleted. | `productId`, `changedFields` — the names of the product fields whose stored value the write changed (`name`, `status`, `categoryIds`, …; `variants` for a variant write). Names only, an open list, and it may be empty. A product update that changes nothing is not announced. |
|
|
376
|
+
| `product.archived.v1` | A product is archived by the Archive action — for one product or in bulk. Once per transition: archiving an archived product sends nothing. A status change never sends it: `inactive` is plain off. | `productId` |
|
|
377
|
+
|
|
378
|
+
- **Order.** Archive sends `product.updated.v1` (with `archivedAt` in
|
|
379
|
+
`changedFields`) and then `product.archived.v1`, for one product and for each
|
|
380
|
+
product of a bulk Archive.
|
|
381
|
+
- **Restore has no event of its own.** Restore sends `product.updated.v1` with
|
|
382
|
+
`archivedAt` in `changedFields` and nothing else. Switching a product on or
|
|
383
|
+
off sends `product.updated.v1` with `status`. To tell them apart, read the
|
|
384
|
+
product: its `status` and `archivedAt` are the answer.
|
|
385
|
+
- **Undo.** Undoing a bulk edit sends `product.updated.v1` for every product it
|
|
386
|
+
put back, naming the fields it restored, and `product.archived.v1` where it
|
|
387
|
+
archives a product again.
|
|
252
388
|
- **Deletion is not delivered.** Deleting a product emits `product.deleted.v1`
|
|
253
389
|
on the in-process event bus only; it is not offered to webhooks, and no
|
|
254
390
|
`product.archived.v1` is sent for it. A receiver that mirrors the catalogue
|
|
@@ -273,6 +409,9 @@ modules are present. The payload is sent whole; the strict schemas are
|
|
|
273
409
|
context, and every price it renders is resolved for that channel; new gating
|
|
274
410
|
(e.g. customer-segment-specific catalogs) is added by composing into
|
|
275
411
|
`catalog-query.service.ts`.
|
|
412
|
+
- **Product editor zones** — the editor mounts admin zones other modules contribute to;
|
|
413
|
+
`product.editor.seo.after`, at the end of the SEO tab (props: `productId`), is where the
|
|
414
|
+
SEO module puts its link to the meta-tag editor, so the catalog never names that module.
|
|
276
415
|
- **Slug uniqueness** — the slug is unique across all Sales Channels by
|
|
277
416
|
default; override the slugifier in `catalog-admin.service.ts` if locale
|
|
278
417
|
collisions become a concern.
|
|
@@ -340,6 +479,21 @@ order already placed. A line whose product could not be read at placement is
|
|
|
340
479
|
recorded as not returnable. What the Returns module does with the recorded
|
|
341
480
|
value is on its own page.
|
|
342
481
|
|
|
482
|
+
### Per sales channel
|
|
483
|
+
|
|
484
|
+
Both rules can be overridden for one sales channel — **Order rules** per channel in the
|
|
485
|
+
product's scopes — in the product editor at a channel, or through
|
|
486
|
+
`PUT /api/v1/admin/catalog/products/:id/scoped-values` (`minOrderQuantity`, `returnable`) or
|
|
487
|
+
`PATCH /api/v1/admin/catalog/products/:id/scopes` for API clients. `{ "inherit": true }` uses
|
|
488
|
+
the Global value again; `null` on the minimum stores "no minimum" for that channel. The channel's value
|
|
489
|
+
applies wherever a basket, an order or a quote request belongs to that channel: adding to
|
|
490
|
+
the basket, the basket view, submitting for approval, the checkout preview, placement, the
|
|
491
|
+
admin order preview, quote requests and the buyer's quick-order import. A channel minimum
|
|
492
|
+
of 1 means no minimum in that channel, whatever the global value. Placement records the
|
|
493
|
+
order channel's returnable flag on each line, so returns follow the channel the order was
|
|
494
|
+
placed in. The storefront product detail and listing report the minimum of the request's
|
|
495
|
+
channel.
|
|
496
|
+
|
|
343
497
|
### Audit and copies
|
|
344
498
|
|
|
345
499
|
Setting or clearing either rule is audited like any product edit, with the old
|
|
@@ -384,11 +538,55 @@ The catalog grew several capability surfaces, each with its own page:
|
|
|
384
538
|
- [Composite Products](./catalog/composite-products.md) — `grouped`
|
|
385
539
|
(fixed children), `bundle` (configurable slots), `virtual` (digital
|
|
386
540
|
delivery)
|
|
541
|
+
- [Product content](./catalog/product-content.md) — Page Builder documents
|
|
542
|
+
kept per product in content attributes and shown in the product page's
|
|
543
|
+
description tab
|
|
387
544
|
|
|
388
545
|
Five product types are now supported: `simple`, `configurable`,
|
|
389
546
|
`grouped`, `bundle`, `virtual`. `simple` and `configurable` are the
|
|
390
547
|
original pair; the other three were added later.
|
|
391
548
|
|
|
549
|
+
## Page Builder blocks
|
|
550
|
+
|
|
551
|
+
The catalog declares the Page Builder's product and category blocks. Their
|
|
552
|
+
data is read on the server, so the products are in the page's HTML.
|
|
553
|
+
|
|
554
|
+
**Product grid and product slider** (`catalog.ProductGrid`,
|
|
555
|
+
`catalog.ProductSlider`) keep every option they had — the product source
|
|
556
|
+
(picked products, a category, a search), the limit, columns, gap and view —
|
|
557
|
+
and add:
|
|
558
|
+
|
|
559
|
+
| Option | Meaning |
|
|
560
|
+
| --- | --- |
|
|
561
|
+
| Header | An optional heading, lead text and button (for example "See all") above the products. |
|
|
562
|
+
| Card style | Default, compact, horizontal, or **showcase**: the product image on a neutral backdrop, its name, a short summary and a "more" link — no price or SKU. |
|
|
563
|
+
| Text under the product name | The one line under each card's name: the card style's default (the SKU on the default, compact and horizontal cards, the short description on showcase), the **Short description** (the first words of the product's description, at most 160 characters), the SKU, or none. The page editor's preview shows the same line as the storefront. |
|
|
564
|
+
| Card title weight | The weight of each card's product name: **Default** (the card style's own) or 300–800. |
|
|
565
|
+
| Card image background | The colour of the box behind each card's image: a brand colour or a hex value. Empty keeps the card style's own light grey. |
|
|
566
|
+
| Divider under each card | **None** (as before) or **Line**: a 1 px line under each card, in the **Divider color** you pick or the neutral border colour. A bordered card's bottom edge becomes the line; a showcase card gets it 16 px below its text. |
|
|
567
|
+
| Card link label | The text of the showcase card's link; "More" when empty. |
|
|
568
|
+
| Gap (grid) | A spacing step or **Custom gap (px)**, per breakpoint. A grid saved with a gap in pixels opens on Custom with that number and looks as before. The category grid's gap works the same way. |
|
|
569
|
+
| Equal items height (grid) | Per breakpoint, next to the columns and the view, on the **Responsive** tab; a value saved before applies at every width. The category grid's works the same way. |
|
|
570
|
+
| Button below the products | An optional button under the grid or slider. |
|
|
571
|
+
|
|
572
|
+
The slider takes the Page Builder carousel's options: slides per view per
|
|
573
|
+
breakpoint, gap, slide or fade effect, arrow and dot placement, bleed to the
|
|
574
|
+
viewport edge and optional autoplay. A grid or slider saved before these
|
|
575
|
+
options existed renders as it did. To give any of these blocks an anchor, a
|
|
576
|
+
colour scheme, a background, spacing or a width, place it inside a **Section**
|
|
577
|
+
block (`cms.Section`). The header texts, the card
|
|
578
|
+
link label and the footer button label are translatable with the Page
|
|
579
|
+
Builder's **Translate** action.
|
|
580
|
+
|
|
581
|
+
**The product summary.** The storefront product list and product detail
|
|
582
|
+
(`GET /api/v1/catalog/products`, `GET /api/v1/catalog/products/:idOrSlug`)
|
|
583
|
+
return `summary`: the product description in the request language as plain
|
|
584
|
+
text, cut at a word boundary to at most 160 characters with `…`, or `null`
|
|
585
|
+
when the product has no description. It is derived from the description the
|
|
586
|
+
read already loads, so it costs no extra query per product (the module's
|
|
587
|
+
`src/backend/services/product-summary-text.ts`).
|
|
588
|
+
The showcase card shows it.
|
|
589
|
+
|
|
392
590
|
## Attribute extensions on the Catalog read paths
|
|
393
591
|
|
|
394
592
|
The Attributes work added the operational surface the storefront
|
|
@@ -437,6 +635,29 @@ UUID, which never changes. Updating the SKU writes an audit row and
|
|
|
437
635
|
refuses with `409 sku_in_use` if the new value already belongs to
|
|
438
636
|
another product.
|
|
439
637
|
|
|
638
|
+
### A deleted product frees its SKU
|
|
639
|
+
|
|
640
|
+
Deleting a product (`DELETE /api/v1/admin/catalog/products/:id`) frees its
|
|
641
|
+
SKU and the SKUs of its variants: a new product or variant can take them at
|
|
642
|
+
once — in the Admin UI, through `PUT /api/v1/catalog/products/by-sku/:sku`
|
|
643
|
+
(which then creates a new product rather than updating the deleted one), or
|
|
644
|
+
from an import or a PIM synchronisation. Products and variants share one SKU
|
|
645
|
+
namespace, so a deleted variant's SKU can be reused by a product and the
|
|
646
|
+
other way round. This also applies to products deleted before the change.
|
|
647
|
+
|
|
648
|
+
The deleted product keeps its real SKU, so the audit log and a reconciliation
|
|
649
|
+
with an ERP or PIM still show it, and orders, invoices and quotes keep the SKU
|
|
650
|
+
they recorded at the time. A deletion cannot be undone, and a deleted product
|
|
651
|
+
cannot be restored.
|
|
652
|
+
|
|
653
|
+
Every lookup by SKU addresses the live product. A product import and the CSV
|
|
654
|
+
stock import write the live product; on the catalogue's read port
|
|
655
|
+
(`catalogProductReadPort`), `findBySku`, `findBySkus` and `findVariantsBySkus`
|
|
656
|
+
answer the live product or variant when there is one, and otherwise the most
|
|
657
|
+
recently deleted one holding that SKU — at most one per SKU. Pass
|
|
658
|
+
`{ liveOnly: true }` to `findBySku` and `findBySkus` to ignore deleted
|
|
659
|
+
products altogether.
|
|
660
|
+
|
|
440
661
|
### Attribute Set swap
|
|
441
662
|
|
|
442
663
|
When an operator assigns a different Attribute Set to a Product, the
|
|
@@ -474,7 +695,7 @@ and ownership model is different:
|
|
|
474
695
|
catalog behaviour flags (`isSearchable`, `isFilterable`,
|
|
475
696
|
`isVariantAxis`, `displayAsSlider`, `isComparable`,
|
|
476
697
|
`quickSearchable`, `isPromoRule`, `isPriceRule`, `filterPosition`,
|
|
477
|
-
`isVisibleOnProductPage`, `
|
|
698
|
+
`isVisibleOnProductPage`, `scopable`,
|
|
478
699
|
`massEditable`) plus two presentation refinements (`selectDisplay`,
|
|
479
700
|
`numericKind`) that keep the legacy `enum`/`select` and
|
|
480
701
|
`number`/`price` distinctions lossless. **Flags stay catalog-owned**
|
|
@@ -524,4 +745,4 @@ The admin's global search (the command palette, ⌘K / Ctrl+K) finds products an
|
|
|
524
745
|
| Category: Name | yes |
|
|
525
746
|
| Category: URL key (slug) | yes |
|
|
526
747
|
|
|
527
|
-
Names match in every language and are shown in the admin's language.
|
|
748
|
+
Names match in every language and are shown in the admin's language. Inactive and archived products are found and show their status; deleted products and categories are not. A category result opens the category tree with that category highlighted. Both appear for a role holding `catalog:read`.
|