Edit in GitHubLog an issue
Adobe Commerce only. Learn more

Manage custom shared catalogs

B2B for Adobe Commerce provides two types of shared catalog: public and custom. A public catalog is the default shared catalog. It is automatically displayed to all guest customers and to logged-in customers that are not company users. The seller assigns a custom shared catalog to specific companies as configured by admin. There can only be one public catalog, and it cannot be deleted.

Service name:

sharedCatalogSharedCatalogRepositoryV1

REST Endpoints:

Copied to your clipboard
1POST /V1/sharedCatalog
2PUT /V1/sharedCatalog/:id
3GET /V1/sharedCatalog/:sharedCatalogId
4DELETE /V1/sharedCatalog/:sharedCatalogId
5GET /V1/sharedCatalog/

Shared catalog parameters:

NameDescriptionFormatRequirements
idThe system-generated shared catalog ID numberintegerRequired to update a shared catalog. Not applicable for create operations.
nameThe display name of the shared catalog. Must be uniquestringRequired to create or update a shared catalog.
descriptionDescribes the shared catalogstringOptional
customer_group_idA system-generated ID. It cannot be changed.integer0 - Not logged in; 1 - General; 2 - Wholesale; 3 - Retailer
typeIndicates whether this is a custom or public shared catalog.integerRequired to create or update a shared catalog. 0 - Custom; 1 - Public
created_byThe user ID of the admin who created the shared catalogintegerOptional
store_idThe store ID the shared catalog is assigned tointegerRequired to create or update a shared catalog.
tax_class_idintegerRequired to create a shared catalog. 2 - Taxable goods; 3 - Retail Customer

Create a custom shared catalog#

When B2B is enabled, the system creates a public shared catalog named Default (General). Adobe Commerce allows only one public shared catalog at a time. You can create an unlimited number of custom shared catalogs.

Sample Usage:

POST <host>/rest/<store_code>/V1/sharedCatalog

Copied to your clipboard
1{
2 "sharedCatalog": {
3 "name": "Test",
4 "type": 0,
5 "store_id": 0,
6 "tax_class_id": 3
7 }
8}

Update a characteristics of a shared catalog#

You cannot change the type from public (1) to custom (0). If you need to replace the public shared catalog, create a custom catalog and change its type to public.

Sample Usage:

PUT <host>/rest/<store_code>/V1/sharedCatalog/2

Copied to your clipboard
1{
2 "sharedCatalog": {
3 "id": 2,
4 "name": "Custom shared catalog",
5 "description": "Just a sample custom shared catalog.",
6 "type": 0,
7 "store_id": 0,
8 "tax_class_id": 3
9 }
10}

Response#

Copied to your clipboard
// The shared catalog `id`, such as `2`.

Retrieve general information about a shared catalog#

This call returns information about the specified shared catalog.

Sample Usage:

GET <host>/rest/<store_code>/V1/sharedCatalog/2

Copied to your clipboard
// Not applicable

Delete a shared catalog#

Only custom shared catalogs can be deleted. When a custom catalog is deleted, the assigned companies are re-assigned to the default public catalog.

Sample Usage:

DELETE <host>/rest/<store_code>/V1/sharedCatalog/2

Copied to your clipboard
// Not applicable

Search for a shared catalog#

The following search returns all the custom shared catalogs (type = 0) in the system.

See Search using REST APIs for information about constructing a search query.

Sample Usage:

GET <host>/rest/<store_code>/V1/sharedCatalog?searchCriteria[filter_groups][0][filters][0][field]=type&searchCriteria[filter_groups][0][filters][0][value]=0&searchCriteria[filter_groups][0][filters][0][condition_type]=eq

Copied to your clipboard
// Not applicable
  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.