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
+57-8Lines changed: 57 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,22 @@
2
2
3
3
## Overview
4
4
5
+
<<<<<<< HEAD
5
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
6
12
7
13
### What's a catalog?
8
14
9
-
With catalogs, Akeneo users can configure which products they want to share with your app thanks to a **product selection** composed of one or several criteria that allow you to filter products.
15
+
A catalog is a selection of products defined by one or several criteria. (families, categories, ...)
10
16
11
-
When your app uses catalogs to retrieve product data, it automatically enables the Catalogs tab and creates catalogs in Akeneo.
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
21
13
22

14
23
@@ -20,6 +29,13 @@ Most of the time, developers must design, develop and maintain a filter interfac
20
29
Using catalogs for apps prevents you from adding this filtering interface to your app. When you retrieve product information related to a catalog, you only retrieve the data your app needs to process.
21
30
22
31
Moreover, with catalogs, you don't have to master the entire PIM structure anymore to deliver a relevant filtering interface, as the Akeneo PXM Studio already provides it to your users.
You can only create **up to 15 catalogs** per app.
38
+
:::
23
39
24
40
### Next steps
25
41
@@ -29,6 +45,11 @@ Moreover, with catalogs, you don't have to master the entire PIM structure anymo
29
45
## Getting started with catalogs
30
46
31
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
+
50
+
## Getting started with catalogs
51
+
52
+
To create and use a catalog, an app must send some requests to the PIM REST API.
32
53
33
54
### What you'll learn
34
55
@@ -38,24 +59,52 @@ After completing this tutorial, you'll be able to create and use catalogs to ret
38
59
39
60
- You have a Partner account and a developer sandbox.
40
61
- Your app already manages the authorization step
62
+
- You have an app able to use the authorization process.
41
63
42
64
### Step 1: Ask for catalog scopes
43
65
44
-
<!-- TODO -->
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:
70
+
-`read_products`
71
+
-`read_catalogs`
72
+
-`write_catalogs`
73
+
-`delete_catalogs`
74
+
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.
45
77
46
78
### Step 2: Create catalogs
47
79
48
-
<!-- TODO -->
80
+
Checkout the [Create a new catalog](/api-reference.html#post_app_catalog) endpoint documentation to find out how
81
+
to create one.
49
82
50
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.
86
+
:::
51
87
52
-
::: warning
53
-
You can create **up to 15 catalogs** per app.
54
-
:::
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.
90
+
91
+
To help your users, you can give them a link to directly access the catalog configuration interface:
0 commit comments