Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit ba1c4d5

Browse files
authored
Merge pull request #8125 from magento/em_prex-catsyncapi
Adding content about the catalog sync CLI
2 parents d44f0fd + 941213f commit ba1c4d5

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

src/_data/toc/configuration-guide.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@ pages:
115115
- label: Dependency reports
116116
url: /config-guide/cli/config-cli-subcommands-depen.html
117117

118+
- label: Catalog sync
119+
url: /config-guide/cli/config-cli-subcommands-catalog-sync.html
120+
118121
- label: Configuration management
119122
children:
120123

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
group: configuration-guide
3+
title: Catalog Sync
4+
---
5+
6+
Magento compiles catalog data into tables using indexers. This process is automatically [triggered by several events](https://docs.magento.com/user-guide/system/index-management-events.html), such as changes to a product's price or inventory levels. To allow some Magento services to use that catalog data, a catalog sync process runs hourly. The catalog sync process exports product data from the Magento server to SaaS services on an ongoing basis. For example, the [Product Recommendations](https://docs.magento.com/user-guide/marketing/product-recommendations.html) feature needs up-to-date catalog information so that it can accurately return recommendations with correct names, pricing, and availability. Use the command-line interface to trigger the catalog sync and reindex product data for consumption by SaaS services.
7+
8+
The commands used to sync catalog data are part of the `magento/saas-export` package. See [Install and configure Product Recommendations]({{ site.baseurl }}/recommendations/install-configure.html) for more information.
9+
10+
{:.bs-callout-info}
11+
When you trigger a data resync from the command line, it can take up to an hour for the data to update.
12+
13+
The following command reindexes the product data from the Magento catalog and resyncs it to Magento SaaS services:
14+
15+
```bash
16+
bin/magento saascatalog:resync --feed products
17+
```
18+
19+
If you do not want to run a full reindex of the products, you can instead sync the product data that has already been generated:
20+
21+
```bash
22+
bin/magento saascatalog:resync --feed products --no-reindex
23+
```
24+
25+
|Parameter|Description|
26+
|---|---|
27+
|`feed`|(Required) Specifies which entity to resync, such as `products`|
28+
|`no-reindex`|(Optional) Resubmits the existing catalog data to the SaaS service without reindexing. When this parameter is not specified, the command runs a full reindex before syncing data.|
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../v2.3/config-guide/cli/config-cli-subcommands-catalog-sync.md

0 commit comments

Comments
 (0)