younifyd
Menu

Get Catalog

Retrieve details of a specific catalog.

GET/organizations/{organizationId}/catalogs/{catalogId}

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Get Catalog action (under Catalogs (Data API)).
  3. Fill in the fields below, then reference the result from later steps as {{getCatalog.response.data}}.

Request

Path parameters

catalogIdstringrequired

The ID of the requested catalog.

organizationIdstringrequired

An identifier for the organization the request is being made by

Response

Returns 200 with an object. Read it in later steps with {{getCatalog.response.data.<field>}}.

assignedProductCountinteger (int32)

The count of products assigned to the catalog. It is read only.

assignedSitesarray<object>

The sites assigned to the catalog. It is read only.

cartridgesstring

The cartridge path of the site.

customerListLinkobject2 fields

Document representing a link to a customer list.

descriptionobject

The description of this site.

displayNameobjectrequired

The display name entered by the user.

idstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites

inDeletionboolean

The deletion status of this site, true if in deletion.

storefrontStatusstring

The storefront status of the site, it can be optionally be set to online, maintenance, to_be_deleted, and protected.

One ofonlinemaintenanceto_be_deletedprotected

categoryCountinteger (int32)

The category count of catalog. It is read only.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'. It is read only.

descriptionobject

The description of catalog.

idstring

The ID of the catalog.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'. It is read only.

nameobject

The catalog name.

onlineboolean

The online status of catalog.

ownedProductCountinteger (int32)

The count of products owned by the catalog. It is read only.

recommendationCountinteger (int32)

The recommendation count of the catalog. It is read only.

rootCategorystring

The root category of the catalog. It is read only.

json
{
  "id": "apparel-catalog",
  "assignedProductCount": 20,
  "assignedSites": [
    {
      "displayName": {
        "default": "Site Genesis"
      },
      "id": "RefArch",
      "cartridges": "sitegenesis_storefront_controllers:sitegenesis_storefront_core",
      "customerListLink": {
        "customerListId": "SiteGenesis",
        "title": {}
      },
      "description": {
        "default": "Prototypical site used for starting point"
      },
      "inDeletion": false,
      "storefrontStatus": "online"
    }
  ],
  "categoryCount": 10,
  "creationDate": 253402214400,
  "description": {},
  "lastModified": 253402214400,
  "name": {},
  "online": false,
  "ownedProductCount": 100,
  "recommendationCount": 50,
  "rootCategory": "apparel-master-catalog"
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.