From 9f3f21e35c97b75fe2719ff9b82a88e4ae8b629c Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 31 Aug 2023 09:25:10 +0200 Subject: [PATCH 1/3] Restructuring the sdk section of dev guides --- _data/sidebars/scos_dev_sidebar.yml | 53 +++--- .../back-end-development/cronjobs/cronjobs.md | 1 + docs/scos/dev/{sdk => }/code-generator.md | 0 .../data-export-orders-.csv-files-format.md | 1 + .../dev/data-export/202204.0/data-export.md | 1 + .../data-export-orders-.csv-files-format.md | 164 ++++++++++++++++++ .../202307.0/data-export.md | 18 +- docs/scos/dev/data-export/202307.0/index.md | 10 ++ .../dev/data-import/202307.0/data-import.md | 2 + docs/scos/dev/sdk/cronjob-scheduling.md | 52 ------ docs/scos/dev/sdk/data-export.md | 44 ----- docs/scos/dev/sdk/data-import.md | 75 -------- ...l-machine-docker-containers-and-console.md | 46 ----- docs/scos/dev/sdk/sdk.md | 21 --- .../twig-and-twigextension.md | 1 + .../docker-environment-infrastructure.md | 1 + .../dev/{sdk => }/zed-api/zed-api-beta.md | 0 .../zed-api/zed-api-configuration.md | 0 .../zed-api/zed-api-crud-functionality.md | 0 .../zed-api/zed-api-processor-stack.md | 0 .../zed-api/zed-api-project-implementation.md | 0 .../{sdk => }/zed-api/zed-api-resources.md | 0 docs/scos/dev/{sdk => }/zed-api/zed-api.md | 0 docs/sdk/dev/spryker-sdk.md | 1 + 24 files changed, 216 insertions(+), 275 deletions(-) rename docs/scos/dev/{sdk => }/code-generator.md (100%) create mode 100644 docs/scos/dev/data-export/202307.0/data-export-orders-.csv-files-format.md rename docs/scos/dev/{data-import => data-export}/202307.0/data-export.md (93%) create mode 100644 docs/scos/dev/data-export/202307.0/index.md delete mode 100644 docs/scos/dev/sdk/cronjob-scheduling.md delete mode 100644 docs/scos/dev/sdk/data-export.md delete mode 100644 docs/scos/dev/sdk/data-import.md delete mode 100644 docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.md delete mode 100644 docs/scos/dev/sdk/sdk.md rename docs/scos/dev/{sdk => technical-enhancement-integration-guides}/twig-and-twigextension.md (99%) rename docs/scos/dev/{sdk => }/zed-api/zed-api-beta.md (100%) rename docs/scos/dev/{sdk => }/zed-api/zed-api-configuration.md (100%) rename docs/scos/dev/{sdk => }/zed-api/zed-api-crud-functionality.md (100%) rename docs/scos/dev/{sdk => }/zed-api/zed-api-processor-stack.md (100%) rename docs/scos/dev/{sdk => }/zed-api/zed-api-project-implementation.md (100%) rename docs/scos/dev/{sdk => }/zed-api/zed-api-resources.md (100%) rename docs/scos/dev/{sdk => }/zed-api/zed-api.md (100%) diff --git a/_data/sidebars/scos_dev_sidebar.yml b/_data/sidebars/scos_dev_sidebar.yml index 61e10d91e39..d42b1770421 100644 --- a/_data/sidebars/scos_dev_sidebar.yml +++ b/_data/sidebars/scos_dev_sidebar.yml @@ -3006,6 +3006,7 @@ entries: - "202005.0" - "202009.0" - "202108.0" + - "202307.0" - "202204.0" nested: - title: Exporting data @@ -3023,6 +3024,7 @@ entries: - "202005.0" - "202009.0" - "202108.0" + - "202307.0" - "202204.0" - title: Back-end development url: /docs/scos/dev/back-end-development/back-end-development.html @@ -4022,40 +4024,29 @@ entries: url: /docs/scos/dev/technical-enhancement-integration-guides/integrating-symfony-5.html - title: Symfony 6 url: /docs/scos/dev/technical-enhancement-integration-guides/integrating-symfony-6.html + - title: Twig and TwigExtension + url: /docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.html - title: ARM architecture (M1 chip) url: /docs/scos/dev/technical-enhancement-integration-guides/switch-to-arm-architecture-m1-chip.html - - title: SDK - url: /docs/scos/dev/sdk/sdk.html + - title: Zed API + url: /docs/scos/dev/sdk/zed-api/zed-api.html nested: - - title: Development Virtual Machine, Docker Containers & Console - url: /docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html - - title: Zed API - url: /docs/scos/dev/sdk/zed-api/zed-api.html - nested: - - title: Project implementation - Zed API - url: /docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html - - title: Zed API configuration - url: /docs/scos/dev/sdk/zed-api/zed-api-configuration.html - - title: CRUD functionality - Zed API - url: /docs/scos/dev/sdk/zed-api/zed-api-crud-functionality.html - - title: Processor stack - Zed API - url: /docs/scos/dev/sdk/zed-api/zed-api-processor-stack.html - - title: Zed API resources - url: /docs/scos/dev/sdk/zed-api/zed-api-resources.html - - title: Zed API (BETA) - url: /docs/scos/dev/sdk/zed-api/zed-api-beta.html - - title: Cronjob scheduling - url: /docs/scos/dev/sdk/cronjob-scheduling.html - - title: Importer - url: /docs/scos/dev/sdk/data-import.html - - title: Twig and TwigExtension - url: /docs/scos/dev/sdk/twig-and-twigextension.html - - title: Code generator - url: /docs/scos/dev/sdk/code-generator.html - include_versions: - - "201811.0" - - title: Data export - url: /docs/scos/dev/sdk/data-export.html + - title: Project implementation - Zed API + url: /docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html + - title: Zed API configuration + url: /docs/scos/dev/sdk/zed-api/zed-api-configuration.html + - title: CRUD functionality - Zed API + url: /docs/scos/dev/sdk/zed-api/zed-api-crud-functionality.html + - title: Processor stack - Zed API + url: /docs/scos/dev/sdk/zed-api/zed-api-processor-stack.html + - title: Zed API resources + url: /docs/scos/dev/sdk/zed-api/zed-api-resources.html + - title: Zed API (BETA) + url: /docs/scos/dev/sdk/zed-api/zed-api-beta.html + - title: Code generator + url: /docs/scos/dev/sdk/code-generator.html + include_versions: + - "201811.0" - title: Tutorials and HowTos url: /docs/scos/dev/tutorials-and-howtos/tutorials-and-howtos.html nested: diff --git a/docs/scos/dev/back-end-development/cronjobs/cronjobs.md b/docs/scos/dev/back-end-development/cronjobs/cronjobs.md index 2f23dd68116..0769f877601 100644 --- a/docs/scos/dev/back-end-development/cronjobs/cronjobs.md +++ b/docs/scos/dev/back-end-development/cronjobs/cronjobs.md @@ -18,6 +18,7 @@ redirect_from: - /v4/docs/en/cronjob-scheduling-guide-201907 - /v3/docs/cronjob-scheduling-guide - /v3/docs/en/cronjob-scheduling-guide + - /docs/scos/dev/sdk/cronjob-scheduling.html related: - title: Create a custom scheduler link: docs/scos/dev/back-end-development/cronjobs/create-a-custom-scheduler.html diff --git a/docs/scos/dev/sdk/code-generator.md b/docs/scos/dev/code-generator.md similarity index 100% rename from docs/scos/dev/sdk/code-generator.md rename to docs/scos/dev/code-generator.md diff --git a/docs/scos/dev/data-export/202204.0/data-export-orders-.csv-files-format.md b/docs/scos/dev/data-export/202204.0/data-export-orders-.csv-files-format.md index e144c87387b..362b7bcdb93 100644 --- a/docs/scos/dev/data-export/202204.0/data-export-orders-.csv-files-format.md +++ b/docs/scos/dev/data-export/202204.0/data-export-orders-.csv-files-format.md @@ -10,6 +10,7 @@ redirect_from: - /2021080/docs/en/data-export-orders-csv-files-format - /docs/data-export-orders-csv-files-format - /docs/en/data-export-orders-csv-files-format + - /docs/scos/dev/sdk/data-export.html related: - title: Exporting data link: docs/scos/dev/data-export/page.version/data-export.html diff --git a/docs/scos/dev/data-export/202204.0/data-export.md b/docs/scos/dev/data-export/202204.0/data-export.md index 30e22d15f9c..fc55cfa9fd0 100644 --- a/docs/scos/dev/data-export/202204.0/data-export.md +++ b/docs/scos/dev/data-export/202204.0/data-export.md @@ -10,6 +10,7 @@ redirect_from: - /2021080/docs/en/exporting-data - /docs/exporting-data - /docs/en/exporting-data + - /docs/scos/dev/data-import/202307.0/data-export.html related: - title: Sales Data Export feature integration link: docs/scos/dev/feature-integration-guides/page.version/sales-data-export-feature-integration.html diff --git a/docs/scos/dev/data-export/202307.0/data-export-orders-.csv-files-format.md b/docs/scos/dev/data-export/202307.0/data-export-orders-.csv-files-format.md new file mode 100644 index 00000000000..e144c87387b --- /dev/null +++ b/docs/scos/dev/data-export/202307.0/data-export-orders-.csv-files-format.md @@ -0,0 +1,164 @@ +--- +title: Data Export orders CSV files format +description: The document explains the format of the orders.csv, order-items.csv, order-expenses.csv export files +last_updated: Jun 16, 2021 +template: data-export-template +originalLink: https://documentation.spryker.com/2021080/docs/data-export-orders-csv-files-format +originalArticleId: 90c9187a-73af-4fb5-92fd-914ed471f74e +redirect_from: + - /2021080/docs/data-export-orders-csv-files-format + - /2021080/docs/en/data-export-orders-csv-files-format + - /docs/data-export-orders-csv-files-format + - /docs/en/data-export-orders-csv-files-format +related: + - title: Exporting data + link: docs/scos/dev/data-export/page.version/data-export.html + - title: Sales Data Export feature integration + link: docs/scos/dev/feature-integration-guides/page.version/sales-data-export-feature-integration.html +--- + +This document holds the content of the following files you get when [exporting data on orders](/docs/scos/dev/data-export/{{page.version}}/data-export.html) generated in Spryker: + +* orders.csv +* order-items.csv +* order-expenses.csv + +## Orders + +These are the header fields included in the `order.csv` file: + +| DEFAULT SEQUENCE | .CSV COLUMN HEADER NAME | MANDATORY | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| 1 | order_reference | Yes | String | Unique | Order reference identifier. | +| 2 | customer_reference | No | String | | Customer reference identifier. | +| 3 | order_created_at | No | Date Time | | Timestamp of this order creation. | +| 4 | order_updated_at | No | Date Time | | Last update timestamp of this order. | +| 5 | order_store | No | String | | The name of the store where the order was place. | +| 6 | email | No | String | | E-mail of the customer. | +| 7 | salutation | No | String | | Salutation used with the customer. | +| 8 | first_name | No | String | | Customer’s first name. | +| 9 | last_name | No | String | | Customer’s last name. | +| 10 | order_note | No | String | | Note added to the order. | +| 11 | currency_iso_code | No | String | | Indicates the currency used in the order. | +| 12 | price_mode | No | Enum (NET_MODE, GROSS_MODE) | | Indicates if the order was calculated in a net or gross price mode. | +| 13 | locale_name | No | String | | Sales order’s locale used during the checkout. The Sales Order has a relation to the Locale which was used during the checkout so that the same locale can be used for communication. | +| 14 | billing_address_salutation | No | ENUM (Mr, Mrs, Dr, Ms) | | Customer salutation used with the billing address. | +| 15 | billing_address_first_name | Yes | String | | Customer’s first name used in the billing address. | +| 16 | billing_address_last_name | Yes | String | | Customer’s last name used in the billing address. | +| 17 | billing_address_middle_name | No | String | | Customer’s middle name used in the billing address. | +| 18 | billing_address_email | No | String | | E-mail used with the billing address. | +| 19 | billing_address_cell_phone | No | String | | Cell phone used with the billing address. | +| 20 | billing_address_phone | No | String | | Phone used with the billing address. | +| 21 | billing_address_address1 | No | String | | Address first line of the billing address. Billing address is the address to which the invoice or bill is registered. | +| 22 | billing_address_address2 | No | String | | Address second line of the billing address. | +| 23 | billing_address_address3 | No | String | | Address third line of the billing address. | +| 24 | billing_address_city | Yes | String | | City of the billing address. | +| 25 | billing_address_zip_code | Yes | String | | Zip code of the billing address. | +| 26 | billing_address_po_box | No | String | | P.O. Box of the billing address. | +| 27 | billing_address_company | No | String | | Company used in the billing address. | +| 28 | billing_address_description | No | String | | Description used with the billing address. | +| 29 | billing_address_comment | No | String | | Comment used with the billing address. | +| 30 | billing_address_country | Yes | String | | Country of the billing address. | +| 31 | billing_address_region | No | String | | Region of the billing address. | +| 32 | order_totals_canceled_total | No | Number | The original value is multiplied by 100, before stored in this field. | Canceled total of the order totals. | +| 33 | order_totals_discount_total | No | Number | The original value is multiplied by 100, before stored in this field. | Discount total of the order totals. | +| 34 | order_totals_grand_total | No | Number | The original value is multiplied by 100, before stored in this field. | Grand total of the order totals. | +| 35 | order_totals_order_expense_total | No | Number | The original value is multiplied by 100, before stored in this field. | Order expense total of the order totals. | +| 36 | order_totals_refund_total | No | Number | The original value is multiplied by 100, before stored in this field. | Refund total of the order totals. | +| 37 | order_totals_subtotal | No | Number | The original value is multiplied by 100, before stored in this field. | Subtotal of the order totals. | +| 38 | order_totals_tax_total | No | Number | The original value is multiplied by 100, before stored in this field. | Tax total of the order totals. | +| 39 | order_comments | No | Object | The comments are presented in a JSON array format:
*order_comments
{% raw %}{{{% endraw %}username, message, createdat, updated_at}, …}* | Comments added by the customer to the sales order.
Username may be a different name from the customer first, middle or last name, e. g. a nickname. + | + + Check out the [orders.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/orders.csv). + +## Order Items + +These are the header fields included in the order_items.csv file: + + +| DEFAULT SEQUENCE | .CSV COLUMN HEADER NAME | MANDATORY | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| 1 | order_reference | Yes | String | | Order reference identifier. | +| 2 | order_item_reference | No | String | Unique | Order item reference identifier. | +| 3 | product_name | No | String | | Product name of the order item. | +| 4 | product_sku | Yes | String | | SKU of the order item. | +| 5 | canceled_amount | No | Number | Default = 0 | Canceled amount of the order item. | +| 6 | order_item_note | No | String | | Note of the order item. | +| 7 | discount_amount_aggregation | No | Number | Default = 0 | Discount amount aggregation of the order item. | +| 8 | discount_amount_full_aggregation | No | Number | Default = 0 | Discount amount full aggregation of the order item. | +| 9 | expense_price_aggregation | No | Number | Default = 0 | Expense price aggregation of the order item. | +| 10 | gross_price | No | Number | The original value is multiplied by 100, before stored in this field. | Gross price of the order item. | +| 11 | net_price | No | Number | The original value is multiplied by 100, before stored in this field. | Net price of the order item. | +| 12 | price | No | Number | The original value is multiplied by 100, before stored in this field. | Price of the order item. | +| 13 | price_to_pay_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Price to pay aggregation of the order item. | +| 14 | product_option_price_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Product option price aggregation of the order item. | +| 15 | quantity | Yes | Number | Default = 1 | Quantity of items in this order item. | +| 16 | refundable_amount | No | Number | The original value is multiplied by 100, before stored in this field. | Refundable amount of the order item. | +| 17 | subtotal_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Subtotal aggregation of the order item. | +| 18 | tax_amount | No | Number | The original value is multiplied by 100, before stored in this field. | Tax amount of the order item. | +| 19 | tax_amount_after_cancellation | No | Number | The original value is multiplied by 100, before stored in this field. | Tax amount after cancellation of the order item. | +| 20 | tax_amount_full_aggregation | No | Number | The original value is multiplied by 100, before stored in this field. | Tax amount full aggregation of the order item. | +| 21 | tax_rate | No | Number | | Tax rate of the order item. | +| 22 | tax_rate_average_aggregation | No | Number | | Tax rate average aggregation of the order item. | +| 23 | order_item_created_at | No | Date Time | | Timestamp of this order item creation. | +| 24 | order_item_update_at | No | Date Time | | Last update timestamp of this order item. | +| 25 | order_item_state | Yes | String | | State of this order item. Project specific states defined in Spryker project state-machine are: Pay, Ship, Stock-update, Close, Return, Refund. | +| 26 | order_item_state_description | No | String | | State description of this order item. | +| 27 | order_item_process | No | String | | Process of this order item. | +| 28 | order_item_bundle_id | No | Number | | Bundle product information identifier of the order item. | +| 29 | order_item_bundle_note | No | String | | Note of the ordered item bundle product. | +| 30 | order_item_bundle_gross_price | Yes | Number | | Gross price of the ordered item bundle product. | +| 31 | order_item_bundle_image | No | String | | Image of the order item bundle product. | +| 32 | order_item_bundle_product_name | Yes | String | | Bundle product name of the order item. | +| 33 | order_item_bundle_net_price | No | Number | Default = 0 | Net price of the ordered item bundle. | +| 34 | order_item_bundle_price | No | Number | Default = 0 | Price of the ordered item bundle. | +| 35 | order_item_bundle_product_sku | Yes | String | | SKU of the product bundle in the order item. | +| 36 | order_shipment_id | No | Number | | Order shipment identifier. | +| 37 | shipment_carrier_name | No | String | | Name of the shipment carrier. | +| 38 | shipment_delivery_time | No | String | | Delivery time of the shipment. | +| 39 | shipment_method_name | No | String | | Name of the shipment method. | +| 40 | shipment_requested_delivery_date | No | Date | | Requested delivery date of the shipment. | +| 41 | shipping_address_salutation | No | String | | Customer salutation used with shipping address. | +| 42 | shipping_address_first_name | No | String | | Customer’s first name used in shipping address. | +| 43 | shipping_address_last_name | No | String | | Customer’s last name used in shipping address. | +| 44 | shipping_address_middle_name | No | String | | Customer’s middle name used in shipping address. | +| 45 | shipping_address_email | No | String | | E-mail used with shipping address. | +| 46 | shipping_address_cell_phone | No | String | | Cell phone used with shipping address. | +| 47 | shipping_address_phone | No | String | | Phone used with shipping address. | +| 48 | shipping_address_address1 | No | String | | Address first line of shipping address.
Shipping address is the address to where the order is shipped. | +| 49 | shipping_address_address2 | No | String | | Address second line of shipping address. | +| 50 | shipping_address_address3 | No | String | | Address third line of shipping address. | +| 51 | shipping_address_city | No | String | | City of shipping address. | +| 52 | shipping_address_zip_code | Yes | String | | Zip code of shipping address. | +| 53 | shipping_address_po_box | No | String | | P.O. Box of shipping address. | +| 54 | shipping_address_company | No | String | | Company used in shipping address. | +| 55 | shipping_address_description | No | String | | Description used with shipping address. | +| 56 | shipping_address_comment | No | String | | Comment used with shipping address. | +| 57 | shipping_address_country | Yes | String | | Country of shipping address. | +| 58 | shipping_address_region | No | String | | Region of shipping address. | + + Check out the [order-items.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/order-items.csv). + +## Order Expenses + +| DEFAULT SEQUENCE | .CSV COLUMN HEADER NAME | MANDATORY | TYPE | OTHER REQUIREMENTS / COMMENTS | DESCRIPTION | +| --- | --- | --- | --- | --- | --- | +| 1 | order_reference | Yes | String | | Order reference identifier. | +| 2 | order_shipment_id | No | Number | |Order shipment identification. | +| 3 | canceled_amount | No | Number | Default = 0 | Expense canceled amount. | +| 4 | discount_amount_aggregation | No | Number | Default = 0 | Expense discount amount aggregation. | +| 5 | gross_price | Yes | Number | The original value is multiplied by 100, before stored in this field | Gross price of the expense. | +| 6 | name | No | String | | Name of the expense. | +| 7 | net_price | No | Number | The original value is multiplied by 100, before stored in this field. | Net price of the expense. | +| 8 | price | No | Number | The original value is multiplied by 100, before stored in this field. | Price of the expense. | +| 9 |price_to_pay_aggregation | No | Number |The original value is multiplied by 100, before stored in this field. |Expense price to pay aggregation. | +| 10 | refundable_amount | No | Number | The original value is multiplied by 100, before stored in this field. |Refundable amount of the expense. | +| 11 | tax_amount | No | Number |The original value is multiplied by 100, before stored in this field. | Tax amount of the expense. | +| 12 | tax_amount_after_cancellation | No | Number | The original value is multiplied by 100, before stored in this field. | Expense tax amount after cancellation. | +| 13 | tax_rate | No | Number | | Tax rate of the expense. | +| 14 | type | No | String | | Type of expense. | +| 15 | expense_created_at | Yes | Date Time | |Timestamp of this sales expense creation. | +| 16 |expense_updated_at | Yes | Date Time | | Last update timestamp of this sales expense. | + + Check out the [order-expenses.csv sample file](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Development+Guide/Data+Export/order-expenses.csv). diff --git a/docs/scos/dev/data-import/202307.0/data-export.md b/docs/scos/dev/data-export/202307.0/data-export.md similarity index 93% rename from docs/scos/dev/data-import/202307.0/data-export.md rename to docs/scos/dev/data-export/202307.0/data-export.md index b314bb3849e..e41c7693fa0 100644 --- a/docs/scos/dev/data-import/202307.0/data-export.md +++ b/docs/scos/dev/data-export/202307.0/data-export.md @@ -1,5 +1,5 @@ --- -title: Data export +title: Exporting data description: This document shows how to export data from a Spryker shop to an external system last_updated: Jun 16, 2021 template: concept-topic-template @@ -10,9 +10,13 @@ redirect_from: - /2021080/docs/en/exporting-data - /docs/exporting-data - /docs/en/exporting-data + - /docs/scos/dev/data-import/202307.0/data-export.html + - /docs/scos/dev/sdk/data-export.html related: - title: Sales Data Export feature integration - link: docs/pbc/all/order-management-system/page.version/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html + link: docs/scos/dev/feature-integration-guides/page.version/sales-data-export-feature-integration.html + - title: Data export orders .csv files format + link: docs/scos/dev/data-export/page.version/data-export-orders-.csv-files-format.html --- To quickly populate an external system like ERP or OMS with data from your Spryker shop, you can export it as CSV files from the Spryker shop and then import them into the external system. @@ -31,7 +35,7 @@ Out of the box, Spryker supports only CSV as a format for exporting files. To export the order data, follow these steps: -1. Make sure you have the [Sales Data Export feature installed](/docs/pbc/all/order-management-system/{{page.version}}/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html) for your project. +1. Make sure you have the [Sales Data Export feature installed](/docs/scos/dev/feature-integration-guides/{{page.version}}/sales-data-export-feature-integration.html) for your project. 2. Specify necessary configurations in the YML export configuration file residing in `./data/export/config/`. For details about the YML export configuration file structure and configuration options, see [.yml Export configuration file](#yml-export-configuration-file). 3. Run `console data:export --config file-name.yml`, where `file-name.yml` is the name of the YML export configuration file. The command creates export CSV files in the `./data/export/` folder for each `data_entity` of the YML file. For each store specified in the YML file, a separate file is created. For an example of how the export works, see [Structure of the YML export configuration file](#structure-of-the-yml-export-configuration-file). @@ -110,6 +114,8 @@ When running the command for data export with this file, `console data:export -- * `orders_AT.csv` * `orders_DE.csv` +For details about the content of each of the files, see [Data Export Orders CSV Files Format](/docs/scos/dev/data-export/{{page.version}}/data-export-orders-.csv-files-format.html). + ### Setting the filter criteria in a YML file You can set the following filter criteria for the order data export in your YML export configuration file: @@ -119,7 +125,7 @@ You can set the following filter criteria for the order data export in your YML #### Defining the stores for order data export -To define the stores you want to export the order data for, specify them in `destination` for the specific data entities. +To define the stores you want to export the order data for, specify them in `destination` for the specific data entities. {% info_block warningBox "Warning" %} @@ -153,11 +159,11 @@ actions: <<: *default_filter_criteria store_name: [AT] ``` - + {% endinfo_block %} -#### Defining the Date and Time Range for Order Data Export +#### Defining the Ddte and time range for order data export The default date and time range filter criteria—for example, the order creation dates filter applied to all `data_entity` items by default—is specified in the `defaults` section: diff --git a/docs/scos/dev/data-export/202307.0/index.md b/docs/scos/dev/data-export/202307.0/index.md new file mode 100644 index 00000000000..a877b947b1a --- /dev/null +++ b/docs/scos/dev/data-export/202307.0/index.md @@ -0,0 +1,10 @@ +--- +title: Data export +description: This section explains how to export data from a Spryker shop to an external system +last_updated: Sep 20, 2022 +template: concept-topic-template +--- + +Spryker’s customers need to export data generated in their Spryker shops to a variety of external systems. The _Data export_ section holds all the needed information for that. For details, see the following documents: +* [Exporting data](/docs/scos/dev/data-export/{{page.version}}/data-export.html) +* [Data export orders CSV files format](/docs/scos/dev/data-export/{{page.version}}/data-export-orders-.csv-files-format.html) diff --git a/docs/scos/dev/data-import/202307.0/data-import.md b/docs/scos/dev/data-import/202307.0/data-import.md index 202b4e13bee..e8ca2ce347c 100644 --- a/docs/scos/dev/data-import/202307.0/data-import.md +++ b/docs/scos/dev/data-import/202307.0/data-import.md @@ -3,6 +3,8 @@ title: Data import description: Import data from other systems into your Spryker Commerce OS project last_updated: Sep 7, 2022 template: concept-topic-template +redirect_from: + - /docs/scos/dev/sdk/data-import.html --- Spryker’s customers need to import data from other systems into their Spryker Commerce OS project. The _Data import_ section holds all the needed information for that. For details, see the following documents: * [Importing data with a configuration file](/docs/scos/dev/data-import/{{page.version}}/importing-data-with-a-configuration-file.html) diff --git a/docs/scos/dev/sdk/cronjob-scheduling.md b/docs/scos/dev/sdk/cronjob-scheduling.md deleted file mode 100644 index 8f4657fceb2..00000000000 --- a/docs/scos/dev/sdk/cronjob-scheduling.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Cronjob scheduling -description: With the feature, jobs can be scheduled, versioned, queued, or changed by developers. -last_updated: Jun 16, 2021 -template: concept-topic-template -originalLink: https://documentation.spryker.com/2021080/docs/cronjob-scheduling -originalArticleId: 2d7a260a-89e1-4754-b33c-74048e6184d8 -redirect_from: - - /2021080/docs/cronjob-scheduling - - /2021080/docs/en/cronjob-scheduling - - /docs/cronjob-scheduling - - /docs/en/cronjob-scheduling - - /v6/docs/cronjob-scheduling - - /v6/docs/en/cronjob-scheduling - - /v5/docs/cronjob-scheduling - - /v5/docs/en/cronjob-scheduling - - /v4/docs/cronjob-scheduling - - /v4/docs/en/cronjob-scheduling - - /v3/docs/cronjob-scheduling - - /v3/docs/en/cronjob-scheduling - - /v2/docs/cronjob-scheduling - - /v2/docs/en/cronjob-scheduling - - /v1/docs/cronjob-scheduling - - /v1/docs/en/cronjob-scheduling - - /docs/scos/dev/sdk/201811.0/cronjob-scheduling.html - - /docs/scos/dev/sdk/201903.0/cronjob-scheduling.html - - /docs/scos/dev/sdk/201907.0/cronjob-scheduling.html - - /docs/scos/dev/sdk/202001.0/cronjob-scheduling.html - - /docs/scos/dev/sdk/202005.0/cronjob-scheduling.html - - /docs/scos/dev/sdk/202009.0/cronjob-scheduling.html - - /docs/scos/dev/sdk/202108.0/cronjob-scheduling.html - - /docs/scos/user/features/202005.0/sdk/cronjob-scheduling.html -related: - - title: Code Generator - link: docs/scos/dev/sdk/code-generator.html - - title: Data export - link: docs/scos/dev/sdk/data-export.html - - title: Data import - link: docs/scos/dev/sdk/data-import.html - - title: Development virtual machine, docker containers & console - link: docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html - - title: Twig and TwigExtension - link: docs/scos/dev/sdk/twig-and-twigextension.html ---- - -To enable your system to process all requests effortlessly, the Spryker Commerce OS is equipped with a Cronjob Scheduling feature. All jobs can be scheduled and executed automatically or manually. Jobs are versioned and can easily be changed by your own developers. - -Spryker uses Jenkins for cronjob scheduling. - -* Jobs are queued and can be manually executed -* Job definitions are under version control and can be changed by any developer -* Console output available for debugging diff --git a/docs/scos/dev/sdk/data-export.md b/docs/scos/dev/sdk/data-export.md deleted file mode 100644 index 95e0a1f98e4..00000000000 --- a/docs/scos/dev/sdk/data-export.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: Data export -description: The data export feature allows you to export orders from a Spryker shop to an external system. -last_updated: Jun 16, 2021 -template: concept-topic-template -originalLink: https://documentation.spryker.com/2021080/docs/data-export -originalArticleId: 407e3f09-8906-4ab2-b043-40371cee5328 -redirect_from: - - /2021080/docs/data-export - - /2021080/docs/en/data-export - - /docs/data-export - - /docs/en/data-export - - /v6/docs/data-export - - /v6/docs/en/data-export - - /v5/docs/data-export - - /v5/docs/en/data-export - - /docs/scos/dev/sdk/201811.0/data-export.html - - /docs/scos/dev/sdk/201903.0/data-export.html - - /docs/scos/dev/sdk/201907.0/data-export.html - - /docs/scos/dev/sdk/202001.0/data-export.html - - /docs/scos/dev/sdk/202005.0/data-export.html - - /docs/scos/dev/sdk/202009.0/data-export.html - - /docs/scos/dev/sdk/202108.0/data-export.html -related: - - title: Code Generator - link: docs/scos/dev/sdk/code-generator.html - - title: Cronjob scheduling - link: docs/scos/dev/sdk/cronjob-scheduling.html - - title: Data import - link: docs/scos/dev/sdk/data-import.html - - title: Development virtual machine, docker containers & console - link: docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html - - title: Twig and TwigExtension - link: docs/scos/dev/sdk/twig-and-twigextension.html ---- - -Export data on orders, generated in Spryker, to external systems like ERP or OMS using the Spryker Data Export feature. The current functionality allows you to export orders, order items, and order expenses data for one or multiple stores. At the same time, you don’t need to export all the data - you can define a filter to run export for specific stores and time period of orders in a .yml export configuration file. - -![image](https://spryker.s3.eu-central-1.amazonaws.com/docs/Features/SDK/Data+Export/data-export.png) - -## Next steps - -* To install the Sales Data Export feature, see [Sales Data Export Feature Integration](/docs/pbc/all/order-management-system/{{site.version}}/base-shop/install-and-upgrade/install-features/install-the-sales-data-export-feature.html). -* To learn how you can export order information, see [Exporting Data](/docs/scos/dev/data-import/{{site.version}}/data-export.html). diff --git a/docs/scos/dev/sdk/data-import.md b/docs/scos/dev/sdk/data-import.md deleted file mode 100644 index 1bb9e2324f9..00000000000 --- a/docs/scos/dev/sdk/data-import.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Data import -description: Easily import your business logic and data, such as Product Information, Customer Base, Categories and many more into the Spryker Commerce OS. -last_updated: Jun 16, 2021 -template: concept-topic-template -originalLink: https://documentation.spryker.com/2021080/docs/importer -originalArticleId: 7f50e4ff-4b3f-4ed8-ba02-788107e21036 -redirect_from: - - /2021080/docs/importer - - /2021080/docs/en/importer - - /docs/importer - - /docs/en/importer - - /v6/docs/importer - - /v6/docs/en/importer - - /v5/docs/importer - - /v5/docs/en/importer - - /v4/docs/importer - - /v4/docs/en/importer - - /v3/docs/importer - - /v3/docs/en/importer - - /v2/docs/importer - - /v2/docs/en/importer - - /v1/docs/importer - - /v1/docs/en/importer - - /docs/scos/dev/sdk/201811.0/data-import.html - - /docs/scos/dev/sdk/201903.0/data-import.html - - /docs/scos/dev/sdk/201907.0/data-import.html - - /docs/scos/dev/sdk/202001.0/data-import.html - - /docs/scos/dev/sdk/202005.0/data-import.html - - /docs/scos/dev/sdk/202009.0/data-import.html - - /docs/scos/dev/sdk/202108.0/data-import.html -related: - - title: About Demo Shop Data Import - link: docs/scos/dev/data-import/page.version/demo-shop-data-import/importing-demo-shop-data.html - - title: Execution Order of Data Importers in Demo Shop - link: docs/scos/dev/data-import/page.version/demo-shop-data-import/execution-order-of-data-importers-in-demo-shop.html - - title: About Data Import Categories - link: docs/scos/dev/data-import/page.version/data-import-categories/about-data-import-categories.html - - title: Importing Data with the Queue Data Importer - link: docs/scos/dev/data-import/page.version/importing-data-with-the-queue-data-importer.html - - title: Code Generator - link: docs/scos/dev/sdk/code-generator.html - - title: Cronjob scheduling - link: docs/scos/dev/sdk/cronjob-scheduling.html - - title: Data export - link: docs/scos/dev/sdk/data-export.html - - title: Development virtual machine, docker containers & console - link: docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html - - title: Twig and TwigExtension - link: docs/scos/dev/sdk/twig-and-twigextension.html ---- - -Easily import your business logic and data, such as Product Information, Customer Base, Categories, and many more into the Spryker Commerce OS. - -The *Data Import* feature allows you to configure what you need to import. You don't need to import all data that is available in Spryker OS out of the box. Instead, you can define what data you want to import for your project using a YAML configuration file. See [Importing data with a configuration file](/docs/scos/dev/data-import/{{site.version}}/importing-data-with-a-configuration-file.html) for details on how you can do that. - -{% info_block infoBox "Data import help" %} - -To help you build your import files, define the correct order of the data importers to run, there is the [Data import documentation](/docs/scos/dev/data-import/{{site.version}}/data-import-categories/about-data-import-categories.html) for your reference. Consult it whenever you need to import data into your project. - -{% endinfo_block %} - -The main benefits of the Data Import feature are: - -* Allows for flexibility to set up initial data and update new information using configuration (YAML) file as a parameter of the `data:import console` command. -* Presupposes batch data files import, allowing to change sequence order, without changing the project’s source code. -* Reduces new projects time-to-market due to a high agility to run frequent data updates. -* Increases business people autonomy (online store manager, purchasing agent, warehouse manager, analyst, etc.), as the data changes are handled flexibly. - -**What's next?** - -* For an overview and implementation details of the Spryker data importers, see [Data importers overview and implementation](/docs/scos/dev/data-import/{{site.version}}/data-importers-overview-and-implementation.html). -* To create your own data importer, see [Creating a data importer](/docs/scos/dev/data-import/{{site.version}}/creating-a-data-importer.html). -* To import the Demo Shop data, see [Importing Demo Shop data](/docs/scos/dev/data-import/{{site.version}}/demo-shop-data-import/importing-demo-shop-data.html) and[ About data import categories](/docs/scos/dev/data-import/{{site.version}}/data-import-categories/about-data-import-categories.html). -* To import data with a YAML configuration file, see [Importing data with a configuration file](/docs/scos/dev/data-import/{{site.version}}/importing-data-with-a-configuration-file.html). diff --git a/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.md b/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.md deleted file mode 100644 index db2dee39712..00000000000 --- a/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Development virtual machine, docker containers & console -last_updated: Jun 16, 2021 -template: concept-topic-template -originalLink: https://documentation.spryker.com/2021080/docs/devvm -originalArticleId: 68abbec6-248a-4a45-9623-67d36366bc74 -redirect_from: - - /2021080/docs/devvm - - /2021080/docs/en/devvm - - /docs/devvm - - /docs/en/devvm - - /v6/docs/devvm - - /v6/docs/en/devvm - - /v5/docs/devvm - - /v5/docs/en/devvm - - /v4/docs/devvm - - /v4/docs/en/devvm - - /v3/docs/devvm - - /v3/docs/en/devvm - - /v2/docs/devvm - - /v2/docs/en/devvm - - /v1/docs/devvm - - /v1/docs/en/devvm - - /docs/scos/dev/sdk/201811.0/development-virtual-machine-docker-containers-and-console.html - - /docs/scos/dev/sdk/201903.0/development-virtual-machine-docker-containers-and-console.html - - /docs/scos/dev/sdk/201907.0/development-virtual-machine-docker-containers-and-console.html - - /docs/scos/dev/sdk/202001.0/development-virtual-machine-docker-containers-and-console.html - - /docs/scos/dev/sdk/202005.0/development-virtual-machine-docker-containers-and-console.html - - /docs/scos/dev/sdk/202009.0/development-virtual-machine-docker-containers-and-console.html - - /docs/scos/dev/sdk/202108.0/development-virtual-machine-docker-containers-and-console.html -related: - - title: Code Generator - link: docs/scos/dev/sdk/code-generator.html - - title: Cronjob scheduling - link: docs/scos/dev/sdk/cronjob-scheduling.html - - title: Data export - link: docs/scos/dev/sdk/data-export.html - - title: Data import - link: docs/scos/dev/sdk/data-import.html - - title: Twig and TwigExtension - link: docs/scos/dev/sdk/twig-and-twigextension.html ---- - -Spryker Commerce OS is shipped with an all-inclusive and fully pre-provisioned development environment on a virtual machine, based on Vagrant and VirtualBox. A Docker container-based environment is provided for development as an alternative to the virtual machine. - -The command-line Console tool enables you to execute a great variety of commands, such as managing the Spryker Commerce OS installer, to run the OS in any environment. diff --git a/docs/scos/dev/sdk/sdk.md b/docs/scos/dev/sdk/sdk.md deleted file mode 100644 index 641dc6bb767..00000000000 --- a/docs/scos/dev/sdk/sdk.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: SDK -description: working with the Spryker Commerce OS SDK -template: concept-topic-template ---- - -This section contains information about the following topics related to working with the Spryker Commerce OS SDK: - -* [Development virtual machine docker containers and console](/docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html) - -* [Zed API](/docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html) - -* [Cronjob scheduling](/docs/scos/dev/sdk/cronjob-scheduling.html) - -* [Data import](/docs/scos/dev/sdk/data-import.html) - -* [Development tools](/docs/sdk/dev/development-tools/architecture-sniffer.html) - -* [Twig and TwigExtension](/docs/scos/dev/sdk/twig-and-twigextension.html) - -* [Data export](/docs/scos/dev/sdk/data-export.html) diff --git a/docs/scos/dev/sdk/twig-and-twigextension.md b/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md similarity index 99% rename from docs/scos/dev/sdk/twig-and-twigextension.md rename to docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md index f301ea489d2..a7a4c12303d 100644 --- a/docs/scos/dev/sdk/twig-and-twigextension.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md @@ -29,6 +29,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/twig-and-twigextension.html - /docs/scos/dev/sdk/202009.0/twig-and-twigextension.html - /docs/scos/dev/sdk/202108.0/twig-and-twigextension.html + - /docs/scos/dev/sdk/twig-and-twigextension.html related: - title: Code Generator link: docs/scos/dev/sdk/code-generator.html diff --git a/docs/scos/dev/the-docker-sdk/202307.0/docker-environment-infrastructure.md b/docs/scos/dev/the-docker-sdk/202307.0/docker-environment-infrastructure.md index 3c6f20e8c5c..df2e5829ac4 100644 --- a/docs/scos/dev/the-docker-sdk/202307.0/docker-environment-infrastructure.md +++ b/docs/scos/dev/the-docker-sdk/202307.0/docker-environment-infrastructure.md @@ -9,6 +9,7 @@ redirect_from: - /2021080/docs/en/docker-environment-infrastructure - /docs/docker-environment-infrastructure - /docs/en/docker-environment-infrastructure + - /docs/scos/dev/sdk/development-virtual-machine-docker-containers-and-console.html related: - title: The Docker SDK link: docs/scos/dev/the-docker-sdk/page.version/the-docker-sdk.html diff --git a/docs/scos/dev/sdk/zed-api/zed-api-beta.md b/docs/scos/dev/zed-api/zed-api-beta.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api-beta.md rename to docs/scos/dev/zed-api/zed-api-beta.md diff --git a/docs/scos/dev/sdk/zed-api/zed-api-configuration.md b/docs/scos/dev/zed-api/zed-api-configuration.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api-configuration.md rename to docs/scos/dev/zed-api/zed-api-configuration.md diff --git a/docs/scos/dev/sdk/zed-api/zed-api-crud-functionality.md b/docs/scos/dev/zed-api/zed-api-crud-functionality.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api-crud-functionality.md rename to docs/scos/dev/zed-api/zed-api-crud-functionality.md diff --git a/docs/scos/dev/sdk/zed-api/zed-api-processor-stack.md b/docs/scos/dev/zed-api/zed-api-processor-stack.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api-processor-stack.md rename to docs/scos/dev/zed-api/zed-api-processor-stack.md diff --git a/docs/scos/dev/sdk/zed-api/zed-api-project-implementation.md b/docs/scos/dev/zed-api/zed-api-project-implementation.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api-project-implementation.md rename to docs/scos/dev/zed-api/zed-api-project-implementation.md diff --git a/docs/scos/dev/sdk/zed-api/zed-api-resources.md b/docs/scos/dev/zed-api/zed-api-resources.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api-resources.md rename to docs/scos/dev/zed-api/zed-api-resources.md diff --git a/docs/scos/dev/sdk/zed-api/zed-api.md b/docs/scos/dev/zed-api/zed-api.md similarity index 100% rename from docs/scos/dev/sdk/zed-api/zed-api.md rename to docs/scos/dev/zed-api/zed-api.md diff --git a/docs/sdk/dev/spryker-sdk.md b/docs/sdk/dev/spryker-sdk.md index 91f8c43dff6..dc41f2f27ae 100644 --- a/docs/sdk/dev/spryker-sdk.md +++ b/docs/sdk/dev/spryker-sdk.md @@ -4,6 +4,7 @@ description: Learn about the Spryker SDK and how you can use it in your project. template: concept-topic-template redirect_from: - /docs/sdk/dev/sdk-conventions.com + - /docs/scos/dev/sdk/sdk.html --- The Spryker SDK aims to provide a single entry point to accelerate your productivity while working with Spryker. The Spryker SDK provides tools to validate existing code, implement new features with Spryker, and go live with your project. From e1acc59eb599bc7fcdeaac9bfeab067746ff63f8 Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 31 Aug 2023 14:25:50 +0200 Subject: [PATCH 2/3] altering the zed api guides --- docs/scos/dev/zed-api/zed-api-beta.md | 6 ++++++ docs/scos/dev/zed-api/zed-api-configuration.md | 6 ++++++ docs/scos/dev/zed-api/zed-api-crud-functionality.md | 5 +++++ docs/scos/dev/zed-api/zed-api-processor-stack.md | 5 +++++ docs/scos/dev/zed-api/zed-api-project-implementation.md | 6 ++++++ docs/scos/dev/zed-api/zed-api-resources.md | 6 ++++++ docs/scos/dev/zed-api/zed-api.md | 7 +++++++ 7 files changed, 41 insertions(+) diff --git a/docs/scos/dev/zed-api/zed-api-beta.md b/docs/scos/dev/zed-api/zed-api-beta.md index b5f5c74347c..616bb74d1db 100644 --- a/docs/scos/dev/zed-api/zed-api-beta.md +++ b/docs/scos/dev/zed-api/zed-api-beta.md @@ -18,6 +18,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/zed-api/zed-api-beta.html - /docs/scos/dev/sdk/202009.0/zed-api/zed-api-beta.html - /docs/scos/dev/sdk/202108.0/zed-api/zed-api-beta.html + - /docs/scos/dev/sdk/zed-api/zed-api.html related: - title: Zed API configuration link: docs/scos/dev/sdk/zed-api/zed-api-configuration.html @@ -30,6 +31,11 @@ related: - title: Zed API project implementation link: docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html --- +{% info_block warningBox "Warning" %} + +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} The Spryker OS offers a flexible REST API for Zed. It maps basic REST functionality to the persistence layer of the Spryker backend. diff --git a/docs/scos/dev/zed-api/zed-api-configuration.md b/docs/scos/dev/zed-api/zed-api-configuration.md index c9d0d405e5d..0220199be0f 100644 --- a/docs/scos/dev/zed-api/zed-api-configuration.md +++ b/docs/scos/dev/zed-api/zed-api-configuration.md @@ -29,6 +29,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/zed-api/zed-api-configuration.html - /docs/scos/dev/sdk/202009.0/zed-api/zed-api-configuration.html - /docs/scos/dev/sdk/202108.0/zed-api/zed-api-configuration.html + - /docs/scos/dev/sdk/zed-api/zed-api-configuration.html related: - title: Zed API (Beta) link: docs/scos/dev/sdk/zed-api/zed-api-beta.html @@ -41,6 +42,11 @@ related: - title: Zed API project implementation link: docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html --- +{% info_block warningBox "Warning" %} + +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} First of all we need to decide on the resources being exposed. Those will be mapped inside the `ApiDependencyProvider`: diff --git a/docs/scos/dev/zed-api/zed-api-crud-functionality.md b/docs/scos/dev/zed-api/zed-api-crud-functionality.md index a3fe9cffcbc..fb143d07827 100644 --- a/docs/scos/dev/zed-api/zed-api-crud-functionality.md +++ b/docs/scos/dev/zed-api/zed-api-crud-functionality.md @@ -29,6 +29,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/zed-api/zed-api-crud-functionality.html - /docs/scos/dev/sdk/202009.0/zed-api/zed-api-crud-functionality.html - /docs/scos/dev/sdk/202108.0/zed-api/zed-api-crud-functionality.html + - /docs/scos/dev/sdk/zed-api/zed-api-crud-functionality.html related: - title: Zed API (Beta) link: docs/scos/dev/sdk/zed-api/zed-api-beta.html @@ -41,7 +42,11 @@ related: - title: Zed API project implementation link: docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html --- +{% info_block warningBox "Warning" %} +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} ## Filtering For find action we return a paginated collection that can be limited and customized based on query string input or headers. So using the provided `FilterPreProcessors` one can enable filtering (conditions), sorting (and multi-sorting) and pagination. diff --git a/docs/scos/dev/zed-api/zed-api-processor-stack.md b/docs/scos/dev/zed-api/zed-api-processor-stack.md index 67335ff27b4..e7393ed8f39 100644 --- a/docs/scos/dev/zed-api/zed-api-processor-stack.md +++ b/docs/scos/dev/zed-api/zed-api-processor-stack.md @@ -29,6 +29,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/zed-api/zed-api-processor-stack.html - /docs/scos/dev/sdk/202009.0/zed-api/zed-api-processor-stack.html - /docs/scos/dev/sdk/202108.0/zed-api/zed-api-processor-stack.html + - /docs/scos/dev/sdk/zed-api/zed-api-processor-stack.html related: - title: Zed API (Beta) link: docs/scos/dev/sdk/zed-api/zed-api-beta.html @@ -41,7 +42,11 @@ related: - title: Zed API project implementation link: docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html --- +{% info_block warningBox "Warning" %} +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} ## Request and pre-processing We now need to decide further on the URL format. Should this be extension driven, which is easier to browse, or HTTP header driven, for example? What kind of URL query string transformation do we need, what kind of header parsing REQUIRED diff --git a/docs/scos/dev/zed-api/zed-api-project-implementation.md b/docs/scos/dev/zed-api/zed-api-project-implementation.md index 64b88660cd9..17cc102ba17 100644 --- a/docs/scos/dev/zed-api/zed-api-project-implementation.md +++ b/docs/scos/dev/zed-api/zed-api-project-implementation.md @@ -29,6 +29,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/zed-api/zed-api-project-implementation.html - /docs/scos/dev/sdk/202009.0/zed-api/zed-api-project-implementation.html - /docs/scos/dev/sdk/202108.0/zed-api/zed-api-project-implementation.html + - /docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html related: - title: Zed API (Beta) link: docs/scos/dev/sdk/zed-api/zed-api-beta.html @@ -41,6 +42,11 @@ related: - title: Zed API processor stack link: docs/scos/dev/sdk/zed-api/zed-api-processor-stack.html --- +{% info_block warningBox "Warning" %} + +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} For the API and the API bundles to get activated we need to configure our own service provider stack in the Zed `ApplicationDependencyProvider` class: diff --git a/docs/scos/dev/zed-api/zed-api-resources.md b/docs/scos/dev/zed-api/zed-api-resources.md index 369f516ad3d..48576d047dd 100644 --- a/docs/scos/dev/zed-api/zed-api-resources.md +++ b/docs/scos/dev/zed-api/zed-api-resources.md @@ -28,6 +28,7 @@ redirect_from: - /docs/scos/dev/sdk/202005.0/zed-api/zed-api-resources.html - /docs/scos/dev/sdk/202009.0/zed-api/zed-api-resources.html - /docs/scos/dev/sdk/202108.0/zed-api/zed-api-resources.html + - /docs/scos/dev/sdk/zed-api/zed-api-resources.html related: - title: Zed API (Beta) link: docs/scos/dev/sdk/zed-api/zed-api-beta.html @@ -40,6 +41,11 @@ related: - title: Zed API project implementation link: docs/scos/dev/sdk/zed-api/zed-api-project-implementation.html --- +{% info_block warningBox "Warning" %} + +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} Each module can have a “{module}Api” module(e.g. CustomerApi for Customer). Such an API module exposes CRUD facade methods (find, get, add, update, remove) that can be mapped to a URL via REST `resource/action` resolution. diff --git a/docs/scos/dev/zed-api/zed-api.md b/docs/scos/dev/zed-api/zed-api.md index cd0efc7118b..023b6e10790 100644 --- a/docs/scos/dev/zed-api/zed-api.md +++ b/docs/scos/dev/zed-api/zed-api.md @@ -3,7 +3,14 @@ title: Zed API description: This section lists documents inside the Zed API section. last_updated: Apr 26, 2023 template: concept-topic-template +redirect_from: + - /docs/scos/dev/sdk/zed-api/zed-api-beta.html --- +{% info_block warningBox "Warning" %} + +Zed API, initially released as a beta version, is now considered outdated and is no longer being developed. Instead of it, we recommend using [Glue Backend API](/docs/scos/dev/glue-api-guides/{{site.version}}/decoupled-glue-api.html#new-type-of-application-glue-backend-api-application). + +{% endinfo_block %} Explore the flexible REST API offered by the Spryker OS for Zed and the basic functionality of mapping REST actions to the backend persistence layer. Learn how to configure the API and explore the Zed API processor stack and the project implementation process for activating API and API bundles. Also, expand your knowledge about Zed API resources to leverage their capabilities effectively. From d43e8be061516d935bc577bb75a7ce85343c689b Mon Sep 17 00:00:00 2001 From: Helen Kravchenko Date: Thu, 31 Aug 2023 15:12:53 +0200 Subject: [PATCH 3/3] removing the outdated code generator link --- .../twig-and-twigextension.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md b/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md index a7a4c12303d..a231afc5ad1 100644 --- a/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md +++ b/docs/scos/dev/technical-enhancement-integration-guides/twig-and-twigextension.md @@ -31,8 +31,6 @@ redirect_from: - /docs/scos/dev/sdk/202108.0/twig-and-twigextension.html - /docs/scos/dev/sdk/twig-and-twigextension.html related: - - title: Code Generator - link: docs/scos/dev/sdk/code-generator.html - title: Cronjob scheduling link: docs/scos/dev/sdk/cronjob-scheduling.html - title: Data export