Skip to content

Commit 9dc6b8c

Browse files
200 error message on disabled catalogs
1 parent da9386a commit 9dc6b8c

File tree

4 files changed

+20
-3
lines changed

4 files changed

+20
-3
lines changed

content/apps/catalogs.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,20 @@ To ensure Akeneo PXM Studio remains stable, we added some limits to catalogs:
2929
- Each app can create up to **15 catalogs**.
3030
- A product selection can have up to **25 selection criteria**.
3131

32+
### Troubleshooting
33+
34+
#### Automatic deactivation on catalogs
35+
36+
When a product selection becomes invalid, e.g. a selected category no longer exists, the PIM automatically disables the catalog.
37+
38+
In that case, your app receives an HTTP 200 response containing the following payload.
39+
40+
```json
41+
{
42+
"error": "No products to synchronize. The catalog \"65f5a521-e65c-4d7b-8be8-1f267fa2729c\" has been disabled on the PIM side. Note that you can get catalogs status with the GET /api/rest/v1/catalogs endpoint."
43+
}
44+
```
45+
3246

3347
### Next steps
3448

content/swagger/resources/app_catalogs/routes/app_catalogs_id_product_uuids.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
get:
22
summary: Get the list of product uuids
33
operationId: "get_app_catalog_product_uuids"
4-
description: Coming soon. This endpoint allows you to get the list of uuids of products contained in a catalog.
4+
description: This endpoint allows you to get the list of uuids of products contained in a catalog. Please, note that a disabled catalog can return an HTTP 200 with a payload containing an error message,
5+
for more details see the <a href="apps/catalogs.html#troubleshooting">App Catalog</a> section.
56
tags:
67
- Catalog products
78
x-versions:

content/swagger/resources/app_catalogs/routes/app_catalogs_id_products.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ get:
55
- Catalog products
66
x-versions:
77
- "SaaS"
8-
description: This endpoint allows you to get the list of products related to a catalog. Products are paginated and they can be filtered. In the Enterprise Edition, permissions based on your app settings are applied to the set of products you request.
8+
description: This endpoint allows you to get the list of products related to a catalog. Products are paginated and they can be filtered. In the Enterprise Edition, permissions based on your app settings are applied to the set of products you request. Please, note that a disabled catalog can return an HTTP 200 with a payload containing an error message,
9+
for more details see the <a href="apps/catalogs.html#troubleshooting">App Catalog</a> section.
910
parameters:
1011
- name: id
1112
in: path

content/swagger/resources/app_catalogs/routes/app_catalogs_id_products_uuid.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ get:
55
- Catalog products
66
x-versions:
77
- "SaaS"
8-
description: This endpoint allows you to get a specific product related to a catalog. In the Enterprise Edition, permissions based on your app settings are applied on the product you request.
8+
description: This endpoint allows you to get a specific product related to a catalog. In the Enterprise Edition, permissions based on your app settings are applied on the product you request. Please, note that a disabled catalog can return an HTTP 200 with a payload containing an error message,
9+
for more details see the <a href="apps/catalogs.html#troubleshooting">App Catalog</a> section.
910
parameters:
1011
- name: id
1112
in: path

0 commit comments

Comments
 (0)