Assign companies to a shared catalog

A shared catalog must be assigned to one or more companies before it can be accessed by the company users.

Service name:

sharedCatalogCompanyManagementV1

REST endpoints:

Copy
POST /V1/sharedCatalog/:sharedCatalogId/assignCompanies
POST /V1/sharedCatalog/:sharedCatalogId/unassignCompanies
GET  /V1/sharedCatalog/:sharedCatalogId/companies
Copied to your clipboard
POST /V1/sharedCatalog/:sharedCatalogId/assignCompanies
POST /V1/sharedCatalog/:sharedCatalogId/unassignCompanies
GET  /V1/sharedCatalog/:sharedCatalogId/companies

Company parameters:

Assign companies to shared catalog

This action works as an update. It does not replace companies that have already been assigned.

If a specified company is already assigned to a different shared catalog, this request unassigns the company from the previous catalog and assigns to the new one.

Sample usage:

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

Copy
{
  "companies": [
    {
      "id": 1
    },
    {
      "id": 2
    }
  ]
}
Copied to your clipboard
{
  "companies": [
    {
      "id": 1
    },
    {
      "id": 2
    }
  ]
}

Copy
// `true`, indicating the request was successful
Copied to your clipboard
// `true`, indicating the request was successful

Unassign companies from a shared catalog

When you unassign a company from a custom catalog, the system automatically assigns this company to the public shared catalog. You cannot unassign a company from the public catalog.

Sample usage:

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

Copy
{
  "companies": [
    {
      "id": 2
    }
  ]
}
Copied to your clipboard
{
  "companies": [
    {
      "id": 2
    }
  ]
}

Copy
// `true`, indicating the request was successful
Copied to your clipboard
// `true`, indicating the request was successful

List the shared catalog companies

The GET call returns an array of company IDs.

Sample Usage:

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

Copy
// Not applicable
Copied to your clipboard
// Not applicable

Copy
"[\"1\",\"2\"]"
Copied to your clipboard
"[\"1\",\"2\"]"

Last updated 9/8/2023

Was this helpful?

Yes

No