Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MP-6047 Product Approval Process + Merchant Context #866

Merged
merged 12 commits into from
May 4, 2022
Merged

MP-6047 Product Approval Process + Merchant Context #866

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f6688c2
MP-6047: docs
ilyakubanov Apr 13, 2022
2ac65f1
MP-6047: added a fix
ilyakubanov May 3, 2022
b178a29
Update file-details-merchant-product-approval-status-default.csv.md
May 3, 2022
59ed5e6
PR review
VadymSachenko May 3, 2022
40b3a53
Merge branch 'master' into feature/mp-6047-product-approval-process
VadymSachenko May 3, 2022
d241f27
Merge branch 'master' into feature/mp-6047-product-approval-process
VadymSachenko May 3, 2022
00e9d65
Merge branch 'master' into feature/mp-6047-product-approval-process
VadymSachenko May 3, 2022
34e6af6
Update docs/marketplace/dev/feature-walkthroughs/202200.0/marketplace…
May 3, 2022
761c0bc
Merge branch 'master' into feature/mp-6047-product-approval-process
VadymSachenko May 4, 2022
4c9116c
Update docs/marketplace/dev/feature-walkthroughs/202200.0/marketplace…
May 4, 2022
d36d327
Update docs/marketplace/dev/data-import/202200.0/file-details-merchan…
May 4, 2022
d01ffa2
Update marketplace-product-approval-process-feature-walkthrough.md
May 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ...ta-import/202200.0/file-details-merchant-product-approval-status-default.csv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "File details: merchant_product_approval_status_default.csv"
description: This document describes the merchant_product_approval_status_default.csv file to configure default merchant products approval statuses in your Spryker shop.
template: import-file-template
---

This document describes the `merchant_product_approval_status_default.csv` file to configure default merchant products approval statuses in your Spryker shop.

To import the file, run:
VadymSachenko marked this conversation as resolved.
Show resolved Hide resolved

```bash
console data:import merchant-product-approval-status-default
```

## Import file parameters

The file must have the following parameters:

| PARAMETER | REQUIRED? | TYPE | DEFAULT VALUE | REQUIREMENTS OR COMMENTS | DESCRIPTION |
| ------------- | ---------- | ------ | ----------- | ------------------- | ------------------------------------ |
| merchant_reference | ✓ | String | | Unique | Identifier of the merchant in the system. |
| approval_status | ✓ | String | | | Default approval status for the merchant products. |

## Import file dependencies

The file has the following dependency: [merchant.csv](/docs/marketplace/dev/data-import/{{site.version}}/file-details-merchant.csv.html).

## Import template file and content example

In the following table, you can find the template and example of the file:

| FILE | DESCRIPTION |
| -------------------------- | -------------------------- |
| [template_merchant_product_approval_status_default.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/template_merchant_product_approval_status_default.csv) | Import file template with headers only. |
| [merchant_product_approval_status_default.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Marketplace+setup/merchant_product_approval_status_default.csv) | Example of the import file with Demo Shop data. |
31 changes: 31 additions & 0 deletions ...lkthroughs/202200.0/marketplace-product-approval-process-feature-walkthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Marketplace Product Approval Process feature walkthrough
description: Marketplace Product Approval Process feature adds Merchant context to product approval process.
template: feature-walkthrough-template
---

The *Marketplace Product Approval Process* feature adds a Merchant context to Product Approval Process by providing
VadymSachenko marked this conversation as resolved.
Show resolved Hide resolved
an optional `spy_merchant.default_product_abstract_approval_status` DB column where default product approval statuses for merchants are stored and can be used as default product approval statuses for merchant products. Also, the feature provides Data importer for merchant's default product approval statuses.
VadymSachenko marked this conversation as resolved.
Show resolved Hide resolved

## Module dependency graph

The following diagram illustrates the dependencies between the modules for the *Marketplace Product Approval Process* feature.

![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/bdeba422-0437-4c39-a29f-9340eb153a6a.png?utm_medium=live&utm_source=custom)

| MODULE | DESCRIPTION |
|------------|----------------------------|
| [MerchantProductApproval](https://github.com/spryker/merchant-product-approval) | This module provides merchant product approval functionality. |
| [MerchantProductApprovalDataImport](https://github.com/spryker/merchant-product-approval-data-import) | This module provides functionality to import the merchant product approval process related data. |

## Domain model

The following schema illustrates the *Marketplace Product Approval Process* domain model:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why domain model contains only one item?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed


![Domain Model](https://confluence-connect.gliffy.net/embed/image/6e87c4b8-7481-4150-a5e9-ff04ab90b762.png?utm_medium=live&utm_source=custom)

## Related Developer articles

|INTEGRATION GUIDES | DATA IMPORT |
|---------| --- |
| [Marketplace Product Approval Process feature integration](/docs/marketplace/dev/feature-integration-guides/{{page.version}}/marketplace-product-approval-process-feature-integration.html) | [File details: merchant_product_approval_status_default.csv](/docs/marketplace/dev/data-import/{{page.version}}/file-details-merchant-product-approval-status-default.csv.html) |
35 changes: 35 additions & 0 deletions ...ies/catalog-setup/products/file-details-product-abstract-approval-status.csv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: "File details: product_abstract_approval_status.csv"
description: This document contains content of the product_approval_status_default.csv file to configure products approval information on your Spryker Demo Shop.
template: data-import-template
---

This document contains content of the `product_approval_status_default.csv` file to configure products approval information on your Spryker Demo Shop.

To import the file, run

```bash
console data:import product-approval-status
```

## Import file parameters

The file must have the following parameters:

| PARAMETER | REQUIRED | TYPE | REQUIREMENTS OR COMMENTS | DESCRIPTION |
| --- | --- | --- | --- | --- |
| abstract_sku | ✓ | String | | SKU identifier of the abstract product. |
| approval_status | ✓ | String | | Default product approval status. |

## Dependencies

This file has the following dependency: [product_abstract.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-abstract.csv.html).

## Import template file and content example

In the following table, you can find the template and example of the file:

| FILE | DESCRIPTION |
| --- | --- |
| [template_product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202109.0/template_product_approval_status.csv) | Import file template with headers only. |
| [product_abstract.csv](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Back-End/Data+Manipulation/Data+Ingestion/Data+Import/Data+Import+Categories/Catalog+Setup/Products/202200.0/product_approval_status.csv) | Exemplary import file with the Demo Shop data. |
0 ...t-approval-process-feature-integration.md → ...t-approval-process-feature-integration.md
View file
Open in desktop
File renamed without changes.
35 changes: 35 additions & 0 deletions ...v/feature-walkthroughs/202200.0/product-approval-process-feature-walkthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: Product Approval Process feature walkthrough
description: Product Approval Process feature adds approval mechanism for products.
template: feature-walkthrough-template
---

The *Product Approval Process* feature adds approval mechanism for products by providing
an optional `spy_product_abstract.approval_status` DB column to store product approval statuses. Thus,
a shop owner can follow the review process and manage which products will be placed in the store by setting the
corresponding approval statuses. The feature also provides the Back Office UI for managing the approval statuses and
the corresponding Data importer.

## Module dependency graph

The following diagram illustrates the dependencies between the modules for the *Product Approval Process* feature.

![Module Dependency Graph](https://confluence-connect.gliffy.net/embed/image/e83e1c59-8592-46ec-906e-1483779419c7.png?utm_medium=live&utm_source=custom)

| MODULE | DESCRIPTION |
|------------|----------------------------|
| [ProductApproval](https://github.com/spryker/product-approval) | This module provides product approval functionality. |
| [ProductApprovalDataImport](https://github.com/spryker/product-approval-data-import) | Module for importing Product approval statuses from .csv file. |
| [ProductApprovalGui](https://github.com/spryker/product-approval-gui) | This module provides Zed UI interface for product approval management. |

## Domain model

The following schema illustrates the *Product Approval Process* domain model:

![Domain Model](https://confluence-connect.gliffy.net/embed/image/9307bb4e-6cb5-43d7-b7a5-e0b3d98ef664.png?utm_medium=live&utm_source=custom)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why domain model has only one module?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

discussed


## Related Developer articles

|INTEGRATION GUIDES | DATA IMPORT |
|---------|---------|
| [Product Approval Process feature integration](/docs/scos/dev/feature-integration-guides/{{page.version}}/product-approval-process-feature-integration.html) | [File details: product_abstract_approval_status.csv](/docs/scos/dev/data-import/{{page.version}}/data-import-categories/catalog-setup/products/file-details-product-abstract-approval-status.csv) |