You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/apps/catalogs.md
+31-41Lines changed: 31 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,14 @@
2
2
3
3
## Overview
4
4
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.
12
7
13
8
### What's a catalog?
14
9
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.)
16
11
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
-

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.
21
13
22
14

23
15
@@ -33,23 +25,20 @@ Moreover, with catalogs, you don't have to master the entire PIM structure anymo
33
25
34
26
### Limits
35
27
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
+
39
32
40
33
### Next steps
41
34
42
35
- Learn [how to create and use catalogs](/apps/catalogs.html#getting-started-with-catalogs)
43
36
- 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
44
37
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 -->
49
38
50
39
## Getting started with catalogs
51
40
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.
53
42
54
43
### What you'll learn
55
44
@@ -58,53 +47,54 @@ After completing this tutorial, you'll be able to create and use catalogs to ret
58
47
### Requirements
59
48
60
49
- 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.
63
51
64
52
### Step 1: Ask for catalog scopes
65
53
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:
70
55
-`read_products`
71
56
-`read_catalogs`
72
57
-`write_catalogs`
73
58
-`delete_catalogs`
74
59
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.
77
64
78
65
### Step 2: Create catalogs
79
66
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.
82
71
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.
86
74
:::
87
75
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.
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:
0 commit comments