younifyd
Menu

Get Catalogs

Retrieve a list of catalog IDs.

GET/organizations/{organizationId}/catalogs

Use it in a workflow

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

Request

Path parameters

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

limitinteger (int32)

Maximum records to retrieve per request, not to exceed 50. Defaults to 25.

Default 25

offsetinteger (int32)

Used to retrieve the results based on a particular resource offset.

Default 0

Response

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

dataarray<object>

The collection of catalogs.

assignedProductCountinteger (int32)

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

assignedSitesarray<object>7 fields

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

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.

idstringrequired

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
{
  "data": [
    {
      "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.