Skip to content

Commit 6399c62

Browse files
merge and update about catalogs
1 parent 0a2fa9b commit 6399c62

File tree

4 files changed

+31
-41
lines changed

4 files changed

+31
-41
lines changed

content/apps/catalogs.md

Lines changed: 31 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,14 @@
22

33
## Overview
44

5-
<<<<<<< HEAD
6-
This guide introduces the catalog feature and explains why using catalogs to retrieve Akeneo data.
7-
=======
8-
This guide introduces the catalog feature. With catalogs, you will save time during development because Akeneo PXM Studio
9-
will manage your **product selection** and give you direct access to the relevant data.
10-
With catalogs, you don't need to develop interfaces about filtering products, locales or attributes.
11-
>>>>>>> e6e4c6c0ebf5c8f6f6d3274d2066a8812d80227a
5+
This guide introduces the catalog feature and explains why using catalogs to retrieve Akeneo data.
6+
You will save time during development with catalogs because Akeneo PXM Studio manages your **product selection** and gives you direct access to the relevant data.
127

138
### What's a catalog?
149

15-
A catalog is a selection of products defined by one or several criteria. (families, categories, ...)
10+
A catalog is a selection of products defined by one or several criteria (families, categories, etc.)
1611

17-
Catalogs are only created by apps and are configured by Akeneo users themselves from Akeneo PXM Studio. This feature is
18-
only visible if the app manage catalogs.
19-
20-
![Catalogs](../img/apps/catalogs-list.png)
12+
Catalogs are only created by apps and configured by Akeneo users from Akeneo PXM Studio. This feature is only visible if the app manages catalogs.
2113

2214
![Catalogs for apps](../img/apps/app-catalog-list.png)
2315

@@ -33,23 +25,20 @@ Moreover, with catalogs, you don't have to master the entire PIM structure anymo
3325

3426
### Limits
3527

36-
::: warning
37-
You can only create **up to 15 catalogs** per app.
38-
:::
28+
To ensure Akeneo PXM Studio remains stable, we added some limits to catalogs:
29+
- Each app can create up to **15 catalogs**.
30+
- A product selection can have up to **25 selection criteria**.
31+
3932

4033
### Next steps
4134

4235
- Learn [how to create and use catalogs](/apps/catalogs.html#getting-started-with-catalogs)
4336
- Discover [how users configure catalogs](https://help.akeneo.com/pim/serenity/articles/how-to-connect-my-pim-with-apps.html#how-to-configure-catalogs-for-apps) in the Akeneo PXM Studio
4437

45-
## Getting started with catalogs
46-
47-
This guide describes how to use the catalog features with your app.
48-
<!-- - Discover how users configure catalogs in the Akeneo PXM Studio TODO Add link -->
4938

5039
## Getting started with catalogs
5140

52-
To create and use a catalog, an app must send some requests to the PIM REST API.
41+
To create and use a catalog, your app has to send some requests to the Akeneo REST API. This guide describes how to use the catalog features with your app.
5342

5443
### What you'll learn
5544

@@ -58,53 +47,54 @@ After completing this tutorial, you'll be able to create and use catalogs to ret
5847
### Requirements
5948

6049
- You have a Partner account and a developer sandbox.
61-
- Your app already manages the authorization step
62-
- You have an app able to use the authorization process.
50+
- Your app already manages the authorization process.
6351

6452
### Step 1: Ask for catalog scopes
6553

66-
In the documentation [Ask for authorizations](/apps/authentication-and-authorization.html#step-2-ask-for-authorizations),
67-
you discovered how to ask for scopes.
68-
69-
If you want to manage catalogs, you need to ask for at least 4 scopes:
54+
To manage catalogs, you need to ask for at least 4 scopes:
7055
- `read_products`
7156
- `read_catalogs`
7257
- `write_catalogs`
7358
- `delete_catalogs`
7459

75-
Once these scopes are accepted by Akeneo users during the installation of your app, you will be able to manage and use
76-
catalogs.
60+
In the documentation [Ask for authorizations](/apps/authentication-and-authorization.html#step-2-ask-for-authorizations),
61+
you can discover how to ask for scopes.
62+
63+
Once Akeneo users accept these scopes during the app connection, you will be able to manage and use catalogs.
7764

7865
### Step 2: Create catalogs
7966

80-
Checkout the [Create a new catalog](/api-reference.html#post_app_catalog) endpoint documentation to find out how
81-
to create one.
67+
Once your app is connected and gets the proper authorization, your app can start using catalogs.
68+
69+
To do so, your app has to create a catalog using the [Create a new catalog](/api-reference.html#post_app_catalog) endpoint.
70+
When your app creates a catalog, the API returns its UUID. You will use this catalog UUID to get information about the catalog and retrieve related products.
8271

83-
By default, when you create a catalog in the Akeneo PXM Studio, the catalog is disabled. It means that until a user hasn't enabled it, you won't be able to retrieve products for this catalog. Note that only users can enable a catalog.
84-
::: info
85-
You should create a catalog with the more descriptive name possible. It will help your users to know how to configure it.
72+
::: tips
73+
To help your users know how to configure a catalog, give it the most descriptive name possible.
8674
:::
8775

88-
Catalogs created **are always disabled by default** in the Akeneo PXM Studio. Only Akeneo users are able to enable a
89-
catalog. You must wait for any of your users to enable it before using it.
76+
By default, new catalogs are **disabled**.
77+
It means that until a user hasn't enabled it, you won't be able to retrieve products for this catalog.
78+
79+
Please note that only users can enable a catalog.
80+
![Catalog settings](../img/apps/catalogs-settings.png)
9081

91-
To help your users, you can give them a link to directly access the catalog configuration interface:
82+
To help your users, you can redirect them directly to the catalog configuration interface on their Akeneo PXM Studio using the following URL structure:
9283

9384
``` http
9485
95-
https://my-pim.cloud.akeneo.com/connect/apps/v1/catalogs/{catalog id}
86+
https://my-pim.cloud.akeneo.com/connect/apps/v1/catalogs/{catalog_uuid}
9687
```
9788

98-
At any moment, you can verify if the catalog is enabled by calling the [get catalog endpoint](/api-reference.html#get_app_catalog).
89+
At any moment, you can verify if a catalog is enabled by calling the [get catalog endpoint](/api-reference.html#get_app_catalog).
9990

10091
### Step 3: Get products using catalogs
10192

10293
::: warning
103-
The endpoint for retrieving the list of product uuids will be available soon.
94+
The endpoint for retrieving the list of product UUIDs will be available soon!
10495
:::
10596

106-
Once you have an enabled catalog, you will be able to paginate the corresponding product uuids using this
107-
[endpoint](/api-reference.html#Appcatalogproduct).
97+
Once you have an enabled catalog, you can paginate the corresponding product UUIDs using this [endpoint](/api-reference.html#Appcatalogproduct).
10898

10999
### Next steps
110100
- Learn [how to synchronize Akeneo data](/getting-started/synchronize-pim-products-6x/welcome.html)

content/img/apps/catalogs-list.png

-80.7 KB
Binary file not shown.
70.6 KB
Loading
119 KB
Loading

0 commit comments

Comments
 (0)