@endora-commerce/mod-catalog 0.109.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 +13 -4
- package/dist/admin/components/PackagingUnitsEditor.d.ts.map +1 -1
- package/dist/admin/components/PackagingUnitsEditor.js +20 -85
- package/dist/admin/components/PackagingUnitsEditor.js.map +1 -1
- package/dist/admin/components/ProductAttachmentsSection.d.ts +1 -3
- package/dist/admin/components/ProductAttachmentsSection.d.ts.map +1 -1
- package/dist/admin/components/ProductAttachmentsSection.js +59 -98
- package/dist/admin/components/ProductAttachmentsSection.js.map +1 -1
- 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 +2 -13
- package/dist/admin/components/ProductGallerySection.d.ts.map +1 -1
- package/dist/admin/components/ProductGallerySection.js +98 -354
- package/dist/admin/components/ProductGallerySection.js.map +1 -1
- 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 -268
- 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 +13 -1
- package/dist/admin/components/ProductScopeOverview.d.ts.map +1 -1
- package/dist/admin/components/ProductScopeOverview.js +51 -36
- package/dist/admin/components/ProductScopeOverview.js.map +1 -1
- 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/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 +1 -1
- package/dist/admin/index.d.ts.map +1 -1
- package/dist/admin/index.js +11 -0
- package/dist/admin/index.js.map +1 -1
- package/dist/admin/lib/attribute-scope.d.ts +17 -14
- package/dist/admin/lib/attribute-scope.d.ts.map +1 -1
- package/dist/admin/lib/attribute-scope.js +12 -9
- package/dist/admin/lib/attribute-scope.js.map +1 -1
- 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 +0 -2
- package/dist/admin/lib/product-labels.d.ts.map +1 -1
- package/dist/admin/lib/product-labels.js +1 -5
- package/dist/admin/lib/product-labels.js.map +1 -1
- package/dist/admin/lib/product-scopes-api.d.ts +5 -22
- package/dist/admin/lib/product-scopes-api.d.ts.map +1 -1
- package/dist/admin/lib/product-scopes-api.js +1 -45
- package/dist/admin/lib/product-scopes-api.js.map +1 -1
- package/dist/admin/lib/product-url-keys-api.d.ts +4 -27
- package/dist/admin/lib/product-url-keys-api.d.ts.map +1 -1
- package/dist/admin/lib/product-url-keys-api.js +0 -49
- package/dist/admin/lib/product-url-keys-api.js.map +1 -1
- package/dist/admin/lib/scope-overview.d.ts +13 -14
- package/dist/admin/lib/scope-overview.d.ts.map +1 -1
- package/dist/admin/lib/scope-overview.js +36 -31
- package/dist/admin/lib/scope-overview.js.map +1 -1
- 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 +119 -38
- package/dist/admin/pages/AttributesManager.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.map +1 -1
- package/dist/admin/pages/ProductEditor.js +840 -457
- package/dist/admin/pages/ProductEditor.js.map +1 -1
- package/dist/admin/pages/ProductsList.d.ts.map +1 -1
- package/dist/admin/pages/ProductsList.js +9 -19
- package/dist/admin/pages/ProductsList.js.map +1 -1
- package/dist/backend/admin-search-provider.d.ts +2 -1
- package/dist/backend/admin-search-provider.d.ts.map +1 -1
- package/dist/backend/admin-search-provider.js +1 -1
- 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 +18 -0
- package/dist/backend/demo/rows.d.ts.map +1 -1
- package/dist/backend/demo/rows.js +18 -0
- 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 +20 -6
- package/dist/backend/demo/seed.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 +7 -6
- package/dist/backend/entities/gallery-item.entity.d.ts.map +1 -1
- package/dist/backend/entities/gallery-item.entity.js +11 -6
- 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 +4 -6
- package/dist/backend/entities/product-attachment.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-attachment.entity.js +6 -12
- 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-scope.entity.d.ts +7 -2
- package/dist/backend/entities/product-channel-scope.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-channel-scope.entity.js +10 -1
- package/dist/backend/entities/product-channel-scope.entity.js.map +1 -1
- 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-packaging-unit.entity.d.ts +1 -7
- package/dist/backend/entities/product-packaging-unit.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-packaging-unit.entity.js +0 -10
- package/dist/backend/entities/product-packaging-unit.entity.js.map +1 -1
- package/dist/backend/entities/product-url-key.entity.d.ts +14 -19
- package/dist/backend/entities/product-url-key.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-url-key.entity.js +17 -22
- package/dist/backend/entities/product-url-key.entity.js.map +1 -1
- package/dist/backend/entities/product-url-redirect.entity.d.ts +8 -13
- package/dist/backend/entities/product-url-redirect.entity.d.ts.map +1 -1
- package/dist/backend/entities/product-url-redirect.entity.js +13 -14
- package/dist/backend/entities/product-url-redirect.entity.js.map +1 -1
- 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 +31 -14
- package/dist/backend/entities/product.entity.d.ts.map +1 -1
- package/dist/backend/entities/product.entity.js +41 -34
- package/dist/backend/entities/product.entity.js.map +1 -1
- package/dist/backend/index.d.ts +8 -3
- package/dist/backend/index.d.ts.map +1 -1
- package/dist/backend/index.js +136 -49
- package/dist/backend/index.js.map +1 -1
- package/dist/backend/plugin.d.ts +36 -6
- package/dist/backend/plugin.d.ts.map +1 -1
- package/dist/backend/plugin.js +36 -13
- package/dist/backend/plugin.js.map +1 -1
- package/dist/backend/prompt-tools.d.ts +3 -2
- package/dist/backend/prompt-tools.d.ts.map +1 -1
- package/dist/backend/prompt-tools.js +18 -7
- package/dist/backend/prompt-tools.js.map +1 -1
- package/dist/backend/routes.admin.d.ts +15 -16
- package/dist/backend/routes.admin.d.ts.map +1 -1
- package/dist/backend/routes.admin.js +110 -99
- package/dist/backend/routes.admin.js.map +1 -1
- package/dist/backend/routes.api-key.d.ts.map +1 -1
- package/dist/backend/routes.api-key.js +4 -2
- package/dist/backend/routes.api-key.js.map +1 -1
- package/dist/backend/routes.public.d.ts +8 -1
- package/dist/backend/routes.public.d.ts.map +1 -1
- package/dist/backend/routes.public.js +60 -8
- package/dist/backend/routes.public.js.map +1 -1
- 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 +42 -2
- package/dist/backend/services/asset-references.js.map +1 -1
- package/dist/backend/services/attachment-packaging-scopes.d.ts +38 -20
- package/dist/backend/services/attachment-packaging-scopes.d.ts.map +1 -1
- package/dist/backend/services/attachment-packaging-scopes.js +58 -75
- package/dist/backend/services/attachment-packaging-scopes.js.map +1 -1
- package/dist/backend/services/attachment.service.d.ts +4 -8
- package/dist/backend/services/attachment.service.d.ts.map +1 -1
- package/dist/backend/services/attachment.service.js +35 -49
- 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 +17 -7
- package/dist/backend/services/attribute-scope-preview.d.ts.map +1 -1
- package/dist/backend/services/attribute-scope-preview.js +30 -20
- package/dist/backend/services/attribute-scope-preview.js.map +1 -1
- 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.map +1 -1
- package/dist/backend/services/bulk-operation.service.js +12 -6
- package/dist/backend/services/bulk-operation.service.js.map +1 -1
- package/dist/backend/services/bundle.service.d.ts.map +1 -1
- package/dist/backend/services/bundle.service.js +19 -1
- package/dist/backend/services/bundle.service.js.map +1 -1
- package/dist/backend/services/catalog-admin-search.service.d.ts +3 -2
- package/dist/backend/services/catalog-admin-search.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-admin-search.service.js +6 -6
- package/dist/backend/services/catalog-admin-search.service.js.map +1 -1
- package/dist/backend/services/catalog-admin.service.d.ts +63 -12
- package/dist/backend/services/catalog-admin.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-admin.service.js +352 -189
- 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 +52 -5
- package/dist/backend/services/catalog-bulk-import.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-bulk-import.service.js +190 -142
- package/dist/backend/services/catalog-bulk-import.service.js.map +1 -1
- package/dist/backend/services/catalog-bulk-update.service.d.ts +5 -3
- package/dist/backend/services/catalog-bulk-update.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-bulk-update.service.js +21 -8
- package/dist/backend/services/catalog-bulk-update.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 +37 -17
- package/dist/backend/services/catalog-product-read.service.js.map +1 -1
- package/dist/backend/services/catalog-query.service.d.ts +39 -8
- package/dist/backend/services/catalog-query.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-query.service.js +154 -116
- package/dist/backend/services/catalog-query.service.js.map +1 -1
- package/dist/backend/services/catalog-quick-search.service.d.ts.map +1 -1
- package/dist/backend/services/catalog-quick-search.service.js +5 -5
- package/dist/backend/services/catalog-quick-search.service.js.map +1 -1
- package/dist/backend/services/catalog-write-ports.d.ts +14 -16
- package/dist/backend/services/catalog-write-ports.d.ts.map +1 -1
- package/dist/backend/services/catalog-write-ports.js +11 -70
- package/dist/backend/services/catalog-write-ports.js.map +1 -1
- package/dist/backend/services/category-admin.service.d.ts.map +1 -1
- package/dist/backend/services/category-admin.service.js +9 -1
- package/dist/backend/services/category-admin.service.js.map +1 -1
- 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 +24 -38
- package/dist/backend/services/effective-value.sql.d.ts.map +1 -1
- package/dist/backend/services/effective-value.sql.js +37 -87
- package/dist/backend/services/effective-value.sql.js.map +1 -1
- package/dist/backend/services/gallery-scopes.d.ts +45 -22
- package/dist/backend/services/gallery-scopes.d.ts.map +1 -1
- package/dist/backend/services/gallery-scopes.js +116 -109
- package/dist/backend/services/gallery-scopes.js.map +1 -1
- package/dist/backend/services/gallery.service.d.ts +13 -27
- package/dist/backend/services/gallery.service.d.ts.map +1 -1
- package/dist/backend/services/gallery.service.js +75 -199
- 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/packaging-unit.service.d.ts.map +1 -1
- package/dist/backend/services/packaging-unit.service.js +7 -12
- 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 +6 -1
- package/dist/backend/services/primary-asset-url.d.ts.map +1 -1
- package/dist/backend/services/primary-asset-url.js +9 -4
- package/dist/backend/services/primary-asset-url.js.map +1 -1
- package/dist/backend/services/product-availability.service.d.ts +16 -3
- package/dist/backend/services/product-availability.service.d.ts.map +1 -1
- package/dist/backend/services/product-availability.service.js +58 -21
- package/dist/backend/services/product-availability.service.js.map +1 -1
- 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.map +1 -1
- package/dist/backend/services/product-link.service.js +14 -16
- 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 +9 -0
- package/dist/backend/services/product-page-revalidation.d.ts.map +1 -1
- package/dist/backend/services/product-page-revalidation.js +19 -0
- package/dist/backend/services/product-page-revalidation.js.map +1 -1
- package/dist/backend/services/product-scopes.service.d.ts +15 -6
- package/dist/backend/services/product-scopes.service.d.ts.map +1 -1
- package/dist/backend/services/product-scopes.service.js +87 -33
- package/dist/backend/services/product-scopes.service.js.map +1 -1
- 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 +61 -7
- package/dist/backend/services/publication-window-sweep.d.ts.map +1 -1
- package/dist/backend/services/publication-window-sweep.js +106 -19
- package/dist/backend/services/publication-window-sweep.js.map +1 -1
- 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 +11 -11
- package/dist/backend/services/scope-completeness.d.ts.map +1 -1
- package/dist/backend/services/scope-completeness.js +26 -33
- package/dist/backend/services/scope-completeness.js.map +1 -1
- package/dist/backend/services/scope-overview.service.d.ts +24 -24
- package/dist/backend/services/scope-overview.service.d.ts.map +1 -1
- package/dist/backend/services/scope-overview.service.js +33 -76
- package/dist/backend/services/scope-overview.service.js.map +1 -1
- 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/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 +12 -18
- package/dist/backend/services/url-key-resolution.service.d.ts.map +1 -1
- package/dist/backend/services/url-key-resolution.service.js +43 -43
- package/dist/backend/services/url-key-resolution.service.js.map +1 -1
- package/dist/backend/services/url-key.service.d.ts +87 -135
- package/dist/backend/services/url-key.service.d.ts.map +1 -1
- package/dist/backend/services/url-key.service.js +447 -619
- package/dist/backend/services/url-key.service.js.map +1 -1
- package/dist/manifest.d.ts +7 -1
- package/dist/manifest.d.ts.map +1 -1
- package/dist/manifest.js +34 -0
- package/dist/manifest.js.map +1 -1
- 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 +8 -1
- package/dist/migrations/index.d.ts.map +1 -1
- package/dist/migrations/index.js +15 -1
- package/dist/migrations/index.js.map +1 -1
- package/docs/catalog/attachments.md +53 -43
- 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 +61 -60
- package/docs/catalog/packaging-units.md +43 -34
- package/docs/catalog/per-channel-per-language-overrides.md +83 -410
- package/docs/catalog/product-content.md +180 -0
- package/docs/catalog/product-links.md +2 -2
- package/docs/catalog/url-keys-and-redirects.md +79 -79
- package/docs/catalog.md +68 -14
- package/i18n/en.json +270 -270
- package/i18n/pl.json +272 -272
- package/package.json +11 -11
- package/dist/admin/components/AttachmentScopesDialog.d.ts +0 -22
- package/dist/admin/components/AttachmentScopesDialog.d.ts.map +0 -1
- package/dist/admin/components/AttachmentScopesDialog.js +0 -70
- package/dist/admin/components/AttachmentScopesDialog.js.map +0 -1
- package/dist/admin/components/ProductScopeControls.d.ts +0 -31
- package/dist/admin/components/ProductScopeControls.d.ts.map +0 -1
- package/dist/admin/components/ProductScopeControls.js +0 -243
- package/dist/admin/components/ProductScopeControls.js.map +0 -1
- package/dist/admin/components/ProductScopeEditor.d.ts +0 -88
- package/dist/admin/components/ProductScopeEditor.d.ts.map +0 -1
- package/dist/admin/components/ProductScopeEditor.js +0 -396
- package/dist/admin/components/ProductScopeEditor.js.map +0 -1
- package/dist/admin/components/ProductUrlKeysPanel.d.ts +0 -17
- package/dist/admin/components/ProductUrlKeysPanel.d.ts.map +0 -1
- package/dist/admin/components/ProductUrlKeysPanel.js +0 -215
- package/dist/admin/components/ProductUrlKeysPanel.js.map +0 -1
- package/dist/admin/components/ScopedDialogParts.d.ts +0 -23
- package/dist/admin/components/ScopedDialogParts.d.ts.map +0 -1
- package/dist/admin/components/ScopedDialogParts.js +0 -16
- package/dist/admin/components/ScopedDialogParts.js.map +0 -1
- package/dist/admin/lib/media-scopes.d.ts +0 -41
- package/dist/admin/lib/media-scopes.d.ts.map +0 -1
- package/dist/admin/lib/media-scopes.js +0 -66
- package/dist/admin/lib/media-scopes.js.map +0 -1
- package/dist/admin/lib/product-scope-drafts.d.ts +0 -77
- package/dist/admin/lib/product-scope-drafts.d.ts.map +0 -1
- package/dist/admin/lib/product-scope-drafts.js +0 -133
- package/dist/admin/lib/product-scope-drafts.js.map +0 -1
- package/dist/backend/entities/gallery-item-channel-hidden.entity.d.ts +0 -14
- package/dist/backend/entities/gallery-item-channel-hidden.entity.d.ts.map +0 -1
- package/dist/backend/entities/gallery-item-channel-hidden.entity.js +0 -42
- package/dist/backend/entities/gallery-item-channel-hidden.entity.js.map +0 -1
- package/dist/backend/entities/gallery-item-channel-label.entity.d.ts +0 -18
- package/dist/backend/entities/gallery-item-channel-label.entity.d.ts.map +0 -1
- package/dist/backend/entities/gallery-item-channel-label.entity.js +0 -49
- package/dist/backend/entities/gallery-item-channel-label.entity.js.map +0 -1
- package/dist/backend/entities/product-attachment-channel-hidden.entity.d.ts +0 -13
- package/dist/backend/entities/product-attachment-channel-hidden.entity.d.ts.map +0 -1
- package/dist/backend/entities/product-attachment-channel-hidden.entity.js +0 -41
- package/dist/backend/entities/product-attachment-channel-hidden.entity.js.map +0 -1
- package/dist/backend/services/product-overrides.service.d.ts +0 -84
- package/dist/backend/services/product-overrides.service.d.ts.map +0 -1
- package/dist/backend/services/product-overrides.service.js +0 -211
- 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 -107
- package/dist/backend/services/product-scope-context.service.js.map +0 -1
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Product content
|
|
3
|
+
description: Page Builder documents kept per product in content attributes and rendered on the product page's description tab.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Product content
|
|
7
|
+
|
|
8
|
+
A **content attribute** holds one Page Builder document per language for each
|
|
9
|
+
product — a buying guide, a feature banner, a size chart. The product page shows
|
|
10
|
+
it in the description tab (**Opis**), below the plain description. Anything the
|
|
11
|
+
Page Builder offers can go into it, including formatted text written in its
|
|
12
|
+
rich-text block.
|
|
13
|
+
|
|
14
|
+
## Defining a content attribute
|
|
15
|
+
|
|
16
|
+
On **Catalog → Attributes**, create an attribute with the type **Page Builder
|
|
17
|
+
content**. The type comes with fixed settings:
|
|
18
|
+
|
|
19
|
+
- it is always kept **per language**;
|
|
20
|
+
- it cannot be searchable, filterable, comparable, a variant axis, a
|
|
21
|
+
promotion or price-list rule, mass-editable, quick-searchable, required,
|
|
22
|
+
shown in the **Parametry** tab, or set per sales channel. The form does not
|
|
23
|
+
offer those settings, the list shows them locked, and the API refuses each one
|
|
24
|
+
with `400 VALIDATION_FAILED`, naming the setting;
|
|
25
|
+
- it has no options;
|
|
26
|
+
- its type cannot be changed later, and no other attribute can be changed into
|
|
27
|
+
it (`409`).
|
|
28
|
+
|
|
29
|
+
Then add the attribute to an [attribute set](./attribute-sets.md). Its position
|
|
30
|
+
in the set is the order in which the product page shows the set's content
|
|
31
|
+
attributes. The type is offered for products only — the generic custom-field
|
|
32
|
+
screens of other records do not offer it.
|
|
33
|
+
|
|
34
|
+
## Authoring
|
|
35
|
+
|
|
36
|
+
On the product's **Attributes** tab, each content attribute of the product's
|
|
37
|
+
saved attribute set is a card rather than an input, below the attribute values.
|
|
38
|
+
The card shows, per editing language, whether content is filled in, and a short
|
|
39
|
+
summary of what is stored. The cards are the same at every scope of the editor's
|
|
40
|
+
scope switcher: content has no value per sales channel.
|
|
41
|
+
**Edit content** opens the product content screen
|
|
42
|
+
(`/catalog/products/:id/content/:attributeKey`). It has:
|
|
43
|
+
|
|
44
|
+
- a **language** switch — English, Polish, and any other language the stored
|
|
45
|
+
content already has;
|
|
46
|
+
- the **Page Builder** canvas for the selected language;
|
|
47
|
+
- **Save content** — one save stores every language you edited. Leaving the screen with
|
|
48
|
+
unsaved edits asks first. The back link returns to the product's Attributes
|
|
49
|
+
tab.
|
|
50
|
+
|
|
51
|
+
The card offers no link while the product has not been saved yet, or while the
|
|
52
|
+
Details tab shows a different attribute set from the saved one — save the
|
|
53
|
+
product first.
|
|
54
|
+
|
|
55
|
+
To remove a language, delete every block from its document and save. A language
|
|
56
|
+
with no block is not stored, and an attribute with no language left holds no
|
|
57
|
+
value.
|
|
58
|
+
|
|
59
|
+
Reading content needs the catalogue read permission, and saving it the catalogue
|
|
60
|
+
write permission. Without the write permission the screen is read-only.
|
|
61
|
+
|
|
62
|
+
The canvas offers the Page Builder's **Translate** action under its usual
|
|
63
|
+
switch and permission. A translation lands in the canvas and is stored only when
|
|
64
|
+
you press **Save content**.
|
|
65
|
+
|
|
66
|
+
## On the storefront
|
|
67
|
+
|
|
68
|
+
The description tab is shown when the product has a plain description **or** at
|
|
69
|
+
least one content attribute with content. It shows the plain description first,
|
|
70
|
+
then each content attribute in the attribute set's order. No heading or label is
|
|
71
|
+
printed above a document — the document carries its own headings.
|
|
72
|
+
|
|
73
|
+
Each document is resolved to one language in this order: the visitor's language,
|
|
74
|
+
the sales channel's default language, English, then any language that has
|
|
75
|
+
content. A language whose document holds no block is skipped. The content is the
|
|
76
|
+
product's, so it is the same whichever variant is selected.
|
|
77
|
+
|
|
78
|
+
The blocks are drawn by the storefront's Page Builder renderer — the one that
|
|
79
|
+
draws CMS pages — so HTML an operator typed is sanitised the same way, and a
|
|
80
|
+
block that belongs to a switched-off module is not drawn. A saved change is
|
|
81
|
+
visible on the next load of the product page.
|
|
82
|
+
|
|
83
|
+
Content never appears in the **Parametry** tab. That tab lists only attributes
|
|
84
|
+
marked visible on the product page that hold a value, and it is not shown when
|
|
85
|
+
there is none.
|
|
86
|
+
|
|
87
|
+
## When the CMS module is off
|
|
88
|
+
|
|
89
|
+
Product content needs the CMS module, which provides the Page Builder:
|
|
90
|
+
|
|
91
|
+
- the product page shows **no** content, and the product API returns none — a
|
|
92
|
+
product whose only description was content shows no description tab;
|
|
93
|
+
- the admin cards keep showing which languages hold content, but offer no
|
|
94
|
+
**Edit content** link, and the content screen explains that no editor is
|
|
95
|
+
available. An operator without access to the CMS module sees the same;
|
|
96
|
+
- nothing stored is changed or deleted. Switching the CMS module back on brings
|
|
97
|
+
the content back on the product page and makes it editable again.
|
|
98
|
+
|
|
99
|
+
This is stricter than [category page content](./category-content.md), which
|
|
100
|
+
keeps rendering while the CMS module is off.
|
|
101
|
+
|
|
102
|
+
## Lifecycle
|
|
103
|
+
|
|
104
|
+
- **Duplicate** — the copy carries the same content.
|
|
105
|
+
- **Attribute set** — when a content attribute leaves the product's attribute
|
|
106
|
+
set, its content is kept but not offered: the card disappears, the content
|
|
107
|
+
screen answers *not available*, and the product page leaves it out. Adding the
|
|
108
|
+
attribute back brings it all back.
|
|
109
|
+
- **Product delete** — a deleted product's content stays stored with it, and is
|
|
110
|
+
unreachable from the admin, the API and the storefront. Assets embedded in it
|
|
111
|
+
are no longer reported as in use.
|
|
112
|
+
- **Attribute delete** — deleting a content attribute deletes its content on
|
|
113
|
+
every product. The delete confirmation says how many products carry content
|
|
114
|
+
first (see [Attributes](./attributes.md#deleting-an-attribute)).
|
|
115
|
+
- **Assets** — a library asset embedded in a product's content is reported as in
|
|
116
|
+
use by that product, so it cannot be deleted while the content holds it.
|
|
117
|
+
|
|
118
|
+
## What content does not take part in
|
|
119
|
+
|
|
120
|
+
Content attributes are deliberately left out of:
|
|
121
|
+
|
|
122
|
+
- values per sales channel or per channel language (the editor's Channel and
|
|
123
|
+
Channel × language scopes): the editor's save and the connectors' scoped write
|
|
124
|
+
refuse a content attribute's key;
|
|
125
|
+
- product export and import — export omits them, and a non-empty cell under a
|
|
126
|
+
content attribute's `attribute:<key>` column is refused for that cell
|
|
127
|
+
(`content_attribute`), the rest of the row being imported;
|
|
128
|
+
- the external (integration) API and PIM/ERP connectors, and the API-key read of
|
|
129
|
+
an attribute set;
|
|
130
|
+
- the products bulk editor;
|
|
131
|
+
- product feeds — neither as a feed field nor in a selection rule;
|
|
132
|
+
- storefront search, quick search and the admin product search;
|
|
133
|
+
- promotions, price lists, comparison and storefront filters;
|
|
134
|
+
- the product list, the search response and every other product read except
|
|
135
|
+
the product page's.
|
|
136
|
+
|
|
137
|
+
## For integrators
|
|
138
|
+
|
|
139
|
+
| Verb + Path | Audience | Purpose |
|
|
140
|
+
| --- | --- | --- |
|
|
141
|
+
| `GET /api/v1/catalog/products/:idOrSlug?include=content` | storefront | The product detail with `contentAttributes`: `[{ key, language, content }]`, each document resolved to the caller's language, in set order. Without `include` the response has no `contentAttributes` key. `include` accepts only `content` |
|
|
142
|
+
| `GET /api/v1/admin/catalog/products/:id/content` | admin (`catalog:read`) | The card list: `{ productId, attributeSetId, attributes: [{ attributeId, key, label, labelDefault, position, languages: [{ language, filled, blocks, excerpt }] }] }`. Summaries only, never documents |
|
|
143
|
+
| `GET /api/v1/admin/catalog/products/:id/content/:attributeKey` | admin (`catalog:read`) | One attribute's envelope: `{ productId, attributeKey, content }` with `content` = `{ languages: { "<code>": <document> } }` or `null` |
|
|
144
|
+
| `PUT /api/v1/admin/catalog/products/:id/content/:attributeKey` | admin (`catalog:write`) | Replaces the envelope; the body is `{ "content": <envelope> }`, and `{ "content": null }` clears it. Answers the stored, normalised value |
|
|
145
|
+
|
|
146
|
+
The envelope is the one a CMS page uses and is limited to 1 MiB (1 048 576
|
|
147
|
+
bytes) of JSON across all languages; a larger one is refused with
|
|
148
|
+
`400 VALIDATION_FAILED`. A key that is not a content attribute of the product's
|
|
149
|
+
current set is refused with `400 ATTRIBUTE_VALUE_REJECTED`. An unknown or deleted
|
|
150
|
+
product answers `404 PRODUCT_NOT_FOUND`. The `PUT` body is validated by the
|
|
151
|
+
handler, so the published OpenAPI document shows no request schema for it.
|
|
152
|
+
|
|
153
|
+
A content attribute's key is refused in `attributeValues` everywhere —
|
|
154
|
+
`POST`/`PATCH /api/v1/admin/catalog/products`, the API-key
|
|
155
|
+
`PUT /api/v1/catalog/products/by-sku/:sku` and the catalogue's write port — with
|
|
156
|
+
`400 ATTRIBUTE_VALUE_REJECTED`; content is written only through the route above.
|
|
157
|
+
|
|
158
|
+
Saving runs the `product.content.update` command — the audit entry records the
|
|
159
|
+
attribute and which languages the envelope carried, not the documents — and
|
|
160
|
+
emits `product.content.updated.v1`, on which the storefront's product cache is
|
|
161
|
+
flushed. It does not emit `product.updated.v1`, so a content save does not
|
|
162
|
+
re-index the product.
|
|
163
|
+
|
|
164
|
+
A connector that maps attribute types should skip `page_builder`: it is a value
|
|
165
|
+
type of `customFieldValueTypeSchema`, `attributeValueTypeSchema` and
|
|
166
|
+
`apiAttributeTypeSchema` in `@endora-commerce/contracts`, and none of the
|
|
167
|
+
integration paths carries it. The content schemas are
|
|
168
|
+
`productContentEnvelopeSchema`, `putProductContentRequestSchema`,
|
|
169
|
+
`adminProductContentSchema`, `adminProductContentListSchema` and
|
|
170
|
+
`productPageContentAttributeSchema`.
|
|
171
|
+
|
|
172
|
+
## Providing an editor
|
|
173
|
+
|
|
174
|
+
The content screen owns the document and no editor: it renders the admin zone
|
|
175
|
+
`product.content.editor` and saves what the zone reports. A module that owns a
|
|
176
|
+
Page Builder contributes a component there; its props are
|
|
177
|
+
`{ productId, attributeKey, language, data, onChange }`, where `data` is the
|
|
178
|
+
document to open and `onChange` reports every edit. The contributor never saves.
|
|
179
|
+
When nothing contributes, the card and the screen say that no editor is
|
|
180
|
+
available.
|
|
@@ -1,72 +1,80 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: URL
|
|
2
|
+
title: URL keys and redirects
|
|
3
3
|
---
|
|
4
4
|
|
|
5
|
-
# URL
|
|
5
|
+
# URL keys and redirects
|
|
6
6
|
|
|
7
|
-
A product's storefront address is `/p/<key>`. The key
|
|
8
|
-
|
|
7
|
+
A product's storefront address is `/p/<key>`. The key follows the product scopes — Global, Channel
|
|
8
|
+
and Channel × language:
|
|
9
9
|
|
|
10
|
-
- **
|
|
11
|
-
|
|
12
|
-
- **language key** — one per language,
|
|
13
|
-
- **sales channel × language key** — one per channel and language, overriding the language key there.
|
|
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.
|
|
14
13
|
|
|
15
|
-
The **effective key** at a sales channel and language is the
|
|
16
|
-
language key, else the
|
|
17
|
-
canonical and alternate-language links, the sitemap, a redirect target,
|
|
18
|
-
admin — uses the effective key,
|
|
19
|
-
default.
|
|
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.
|
|
20
18
|
|
|
21
|
-
A key
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
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
28
|
|
|
29
29
|
## Managing keys
|
|
30
30
|
|
|
31
|
-
In the product editor
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
the
|
|
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.
|
|
35
37
|
|
|
36
|
-
`GET /api/v1/admin/catalog/products/:id/url-keys` (`catalog:read`) answers
|
|
37
|
-
the
|
|
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:
|
|
38
41
|
|
|
39
42
|
```json
|
|
40
43
|
{
|
|
41
44
|
"globalKey": "cordless-drill",
|
|
42
|
-
"
|
|
43
|
-
|
|
45
|
+
"channelKeys": [
|
|
46
|
+
{ "channelId": "<retail-uuid>", "key": "wiertarka" },
|
|
47
|
+
{ "channelId": "<retail-uuid>", "languageCode": "en-US", "key": { "inherit": true } }
|
|
48
|
+
]
|
|
44
49
|
}
|
|
45
50
|
```
|
|
46
51
|
|
|
47
|
-
|
|
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.
|
|
52
58
|
|
|
53
|
-
- **A key another product holds** in that
|
|
54
|
-
product (`details.conflicts`). A deleted product's
|
|
55
|
-
|
|
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.
|
|
56
62
|
- **A key that is another product's redirect** answers `409 URL_KEY_REDIRECT_TAKEOVER_REQUIRED`,
|
|
57
63
|
naming the product that would lose the redirect (`details.takeovers`). Sending the same request
|
|
58
64
|
again with the key in `confirmTakeover` takes it over. Only an operator can do this; an
|
|
59
65
|
integration never takes over a redirect.
|
|
60
|
-
- **A changed key stays as a redirect**
|
|
61
|
-
redirects never chain.
|
|
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:
|
|
62
69
|
`DELETE /api/v1/admin/catalog/products/:id/url-redirects/:redirectId` (`catalog:write`). Deleting
|
|
63
70
|
a product removes its redirects. While `seo` is off the answer leaves `redirects` out, but the
|
|
64
71
|
rows stay and keep reserving their keys.
|
|
65
72
|
|
|
66
73
|
A `PUT` is one audited Command, `product.url_keys.update`, whose before-state sent back through the
|
|
67
74
|
same route restores the keys; a redirect delete is `product.url_redirect.delete`. Both announce
|
|
68
|
-
`product.updated.v1` with `changedFields: ["urlKeys"]`. A
|
|
69
|
-
|
|
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.
|
|
70
78
|
|
|
71
79
|
## On the storefront
|
|
72
80
|
|
|
@@ -74,15 +82,17 @@ chosen free of every live product's language, channel and redirect keys.
|
|
|
74
82
|
language:
|
|
75
83
|
|
|
76
84
|
- the product's effective key there answers `{ kind: "product", productId, key }`;
|
|
77
|
-
-
|
|
78
|
-
|
|
79
|
-
being the product's URL to
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
`
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
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
|
|
86
96
|
`paths: { canonical, alternates }`: the page's URL at the request's channel and language, and one
|
|
87
97
|
per channel language where the product is available to anonymous visitors. `slug` on the listing,
|
|
88
98
|
the product detail, grouped and bundle children and product-link tiles is the effective key at the
|
|
@@ -92,7 +102,7 @@ request's channel and language.
|
|
|
92
102
|
|
|
93
103
|
| Code | Status | When |
|
|
94
104
|
| --- | --- | --- |
|
|
95
|
-
| `URL_KEY_TAKEN` | 409 | The key is another product's key in that language |
|
|
105
|
+
| `URL_KEY_TAKEN` | 409 | The key is another product's key in that channel (any language), or, for a Global key, anywhere |
|
|
96
106
|
| `URL_KEY_REDIRECT_TAKEOVER_REQUIRED` | 409 | The key is another product's redirect and the write did not confirm the takeover |
|
|
97
107
|
| `URL_REDIRECT_NOT_FOUND` | 404 | `:redirectId` is not a redirect of the product |
|
|
98
108
|
| `SCOPE_INVALID` | 422 | A key for a channel the product is not in, or a language the channel does not offer |
|
|
@@ -102,41 +112,31 @@ request's channel and language.
|
|
|
102
112
|
## Integrations
|
|
103
113
|
|
|
104
114
|
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
|
|
106
|
-
sales channel or language (FR-091).
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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.
|
|
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.
|
|
121
127
|
|
|
122
128
|
**URL keys from an integration are never forced.** A key that is another product's key in that
|
|
123
|
-
|
|
129
|
+
channel, or another product's redirect, is not written: the product keeps its previous key at that
|
|
124
130
|
scope and the call reports, per key, `{ written: false, issue: { languageCode, channelId, key,
|
|
125
131
|
heldByProductId, kind } }` — `kind` is `current` or `redirect`. An integration never takes over
|
|
126
132
|
another product's redirect and is never asked to confirm one; only an operator can, in the product
|
|
127
|
-
editor (FR-093).
|
|
128
|
-
|
|
133
|
+
editor (FR-093). An integration reserves at most 1 000 new keys per run; the rest are reported as
|
|
134
|
+
`limit_reached`.
|
|
129
135
|
|
|
130
136
|
**No completeness check runs** on an integration's write; the operator's warnings about missing
|
|
131
137
|
names and keys in a scope are an editor feature.
|
|
132
138
|
|
|
133
|
-
**The products CSV
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
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`).
|
|
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,7 +24,7 @@ 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 (no amount where the viewer's price display mode is *None*) |
|
|
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 |
|
|
@@ -33,7 +33,7 @@ otherwise; every price names its currency either way. A malformed code is refuse
|
|
|
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 | Delete (soft) — not the Archive action |
|
|
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
37
|
| `POST /api/v1/admin/catalog/products/:id/archive` | admin (`catalog:write`) | Archive one product — see *Product status and archiving* |
|
|
38
38
|
| `POST /api/v1/admin/catalog/products/:id/restore` | admin (`catalog:write`) | Restore one archived product |
|
|
39
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 |
|
|
@@ -42,7 +42,8 @@ otherwise; every price names its currency either way. A malformed code is refuse
|
|
|
42
42
|
| `GET /api/v1/admin/catalog/attributes/:idOrKey` | admin | Single attribute read |
|
|
43
43
|
| `POST /api/v1/admin/catalog/attributes` | admin | Create attribute (accepts the new flags + inline `options[]` for select-style types) |
|
|
44
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`) |
|
|
45
|
-
| `
|
|
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) |
|
|
46
47
|
| `GET /api/v1/admin/catalog/attributes/:idOrKey/options` | admin | List option-list rows for select/enum/multiselect attributes |
|
|
47
48
|
| `POST /api/v1/admin/catalog/attributes/:idOrKey/options` | admin | Append an option |
|
|
48
49
|
| `PATCH /api/v1/admin/catalog/attribute-options/:optionId` | admin | Patch label / labelDefault / isDefault / sortOrder (option `value` is immutable) |
|
|
@@ -54,6 +55,9 @@ otherwise; every price names its currency either way. A malformed code is refuse
|
|
|
54
55
|
| `DELETE /api/v1/admin/catalog/categories/:id` | admin | Soft-delete; rejects with 409 if any active child still references the row |
|
|
55
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)) |
|
|
56
57
|
| `PUT /api/v1/admin/catalog/categories/:id/content` | admin | Replace the category's page content; `null` clears it |
|
|
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 |
|
|
57
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 |
|
|
58
62
|
|
|
59
63
|
## Product status and archiving
|
|
@@ -127,10 +131,10 @@ reports any product changed since.
|
|
|
127
131
|
|
|
128
132
|
When an operator's **status change** switches a product on for a sales channel and
|
|
129
133
|
language — the global status, a channel or channel × language status, single or in
|
|
130
|
-
bulk — the product must have,
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
attribute of its attribute set. The setting **Completeness check when switching a
|
|
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
|
|
134
138
|
product on** (`catalog.scope_completeness_gate`, one value for the whole platform)
|
|
135
139
|
decides what happens when something is missing:
|
|
136
140
|
|
|
@@ -143,7 +147,7 @@ decides what happens when something is missing:
|
|
|
143
147
|
|
|
144
148
|
Only a status change is checked. A product that goes live because it joins a channel,
|
|
145
149
|
a channel gains a language, its publication window opens, its audience changes, or it
|
|
146
|
-
is restored is not checked; the **scope
|
|
150
|
+
is restored is not checked; the **scope map** of the product editor shows what is
|
|
147
151
|
missing at every channel and language instead. Setting an archived product `active` is
|
|
148
152
|
checked like any status change, although the product stays archived. Imports, PIM
|
|
149
153
|
synchronisation and the API-key upsert are never checked.
|
|
@@ -177,6 +181,11 @@ buyer pays is chosen.
|
|
|
177
181
|
the position it continues from can be a product the viewer may not see. A cursor that does not
|
|
178
182
|
open — altered, issued by a release before the seal, or before the instance's session key was
|
|
179
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.
|
|
180
189
|
- **Reading named products** — `?ids=<id>,<id>,…` on `GET /api/v1/catalog/products` restricts the
|
|
181
190
|
listing to those products: at most 24 distinct ids, each a uuid, or `400 VALIDATION_FAILED`. The
|
|
182
191
|
answer is the subset the viewer may see, priced exactly as any listing card for that viewer, in
|
|
@@ -187,6 +196,15 @@ buyer pays is chosen.
|
|
|
187
196
|
channel that hides prices until sign-in — the listing and the product detail carry no amount, and
|
|
188
197
|
a price ordering or range is refused for that page. Sales channels have no price-visibility flag
|
|
189
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.
|
|
190
208
|
|
|
191
209
|
For developers: the listing paths price a whole page in one batched call —
|
|
192
210
|
`resolveListingPrices`, or `resolveListingPriceDetails` where the page renders the split
|
|
@@ -200,6 +218,14 @@ category and attribute writes publish the events `price_lists` subscribes to, wh
|
|
|
200
218
|
pricing caches and mark on the price surface the products each event concerns, for the surface
|
|
201
219
|
worker to refresh.
|
|
202
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
|
+
|
|
203
229
|
### Removed price fields (migration note)
|
|
204
230
|
|
|
205
231
|
The release that introduced price books removed the product's *Default unit price* (the
|
|
@@ -346,7 +372,7 @@ modules are present. The payload is sent whole; the strict schemas are
|
|
|
346
372
|
| Event | Sent when | Payload, beside `eventId` and `occurredAt` |
|
|
347
373
|
| --- | --- | --- |
|
|
348
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. |
|
|
349
|
-
| `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
|
|
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. |
|
|
350
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` |
|
|
351
377
|
|
|
352
378
|
- **Order.** Archive sends `product.updated.v1` (with `archivedAt` in
|
|
@@ -456,8 +482,10 @@ value is on its own page.
|
|
|
456
482
|
### Per sales channel
|
|
457
483
|
|
|
458
484
|
Both rules can be overridden for one sales channel — **Order rules** per channel in the
|
|
459
|
-
product's scopes
|
|
460
|
-
`
|
|
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
|
|
461
489
|
applies wherever a basket, an order or a quote request belongs to that channel: adding to
|
|
462
490
|
the basket, the basket view, submitting for approval, the checkout preview, placement, the
|
|
463
491
|
admin order preview, quote requests and the buyer's quick-order import. A channel minimum
|
|
@@ -510,6 +538,9 @@ The catalog grew several capability surfaces, each with its own page:
|
|
|
510
538
|
- [Composite Products](./catalog/composite-products.md) — `grouped`
|
|
511
539
|
(fixed children), `bundle` (configurable slots), `virtual` (digital
|
|
512
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
|
|
513
544
|
|
|
514
545
|
Five product types are now supported: `simple`, `configurable`,
|
|
515
546
|
`grouped`, `bundle`, `virtual`. `simple` and `configurable` are the
|
|
@@ -604,6 +635,29 @@ UUID, which never changes. Updating the SKU writes an audit row and
|
|
|
604
635
|
refuses with `409 sku_in_use` if the new value already belongs to
|
|
605
636
|
another product.
|
|
606
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
|
+
|
|
607
661
|
### Attribute Set swap
|
|
608
662
|
|
|
609
663
|
When an operator assigns a different Attribute Set to a Product, the
|
|
@@ -641,7 +695,7 @@ and ownership model is different:
|
|
|
641
695
|
catalog behaviour flags (`isSearchable`, `isFilterable`,
|
|
642
696
|
`isVariantAxis`, `displayAsSlider`, `isComparable`,
|
|
643
697
|
`quickSearchable`, `isPromoRule`, `isPriceRule`, `filterPosition`,
|
|
644
|
-
`isVisibleOnProductPage`, `
|
|
698
|
+
`isVisibleOnProductPage`, `scopable`,
|
|
645
699
|
`massEditable`) plus two presentation refinements (`selectDisplay`,
|
|
646
700
|
`numericKind`) that keep the legacy `enum`/`select` and
|
|
647
701
|
`number`/`price` distinctions lossless. **Flags stay catalog-owned**
|