Get Category From Catalog

Retrieve details of a specific category within a catalog.

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

Use it in a workflow

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

Request

Path parameters

categoryIdstringrequired

The ID of the category to be created.

catalogIdstringrequired

The ID of the requested catalog.

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

levelsinteger (int32)

The level number.

Response

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

catalogIdany

The ID of the catalog that contains it.

categoriesarray<object>

The array of subcategories for the category.

creationDatestring (date-time)

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

descriptionobject

The localized description of the category.

idany

The ID of the category.

imagestring

The name of the category image. The URL to the image is computed.

lastModifiedstring (date-time)

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

nameobject

The localized name of the category.

onlineboolean

The online status of the category determines if it is visible in the storefront. Defaults to false if not specified on creation.

pageDescriptionobject

The localized page description of the category.

pageKeywordsobject

The localized page keywords for the category.

pageTitleobject

The localized page title of the category.

parentCategoryIdstring

The ID of the parent category. Defaults to root if not specified on creation.

pathsarray<object>

The path record.

idany

The ID of the category path.

nameobject

The name of the category path.

positionnumber (double)

The position of the category determines the display order in the storefront.

sortingRulesarray<object>

The category sorting rules.

creationDatestring (date-time)

The creation date, read only.

descriptionany

The description of the product sorting rule.

idany

The ID of the product sorting rule.

productSortingRuleStepsarray<object>6 fields

The steps involved in sorting by this rule.

ruleContextstring

The context of the rule, either site or global.

One ofsiteglobal

sitestring

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

thumbnailstring

The name of the category thumbnail. The URL to the thumbnail is computed.

json

{
  "id": "mens-clothing-outerwear",
  "catalogId": "apparel-catalog",
  "categories": [
    {}
  ],
  "creationDate": 253402214400,
  "description": {
    "en_US": "Mens Clothing Outerwear"
  },
  "image": "Summer Bomber Jacket",
  "lastModified": 253402214400,
  "name": {
    "en_US": "Mens Clothing Outerwear"
  },
  "online": true,
  "pageDescription": {
    "en_US": "Mens Outerwear Category"
  },
  "pageKeywords": {
    "en_US": "Outerwear"
  },
  "pageTitle": {
    "en_US": "Mens Clothing Outerwear"
  }
}

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

Was this page helpful?