Get Categorization Attribute Definitions

GET/organizations/{organizationId}/categorization-attribute-definitions

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Categorization Attribute Definitions action (under Products (Data API)).
Fill in the fields below, then reference the result from later steps as {{getCategorizationAttributeDefinitions.response.data}}.

Request

Path parameters

organizationIdstringrequired

An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).

Query parameters

localeoneOf

A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.

Response

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

dataarray<object>

The list of the categorization attribute definitions. This can be empty.

idstringrequired

The ID of the supported attribute.

attributeNamestring

The display name of the supported attribute.

attributeTypestringrequired

The type of the attribute (custom/system/categorization). "system" indicates the System Attribute of the Product in ECOM, "custom" indicates the Custom Attribute of the Product in ECOM defined by merchant and "categorization" indicates the attribute used for categorization purposes ONLY and is not a defined attribute on the Product Object.

One ofcustomsystemcategorization

valueTypestringrequired

The value type of the attribute.

One ofstringintdoubletexthtmldatedatetimeimagebooleanmoneyquantityemailpasswordset-of-stringset-of-intset-of-doubleenum-of-stringenum-of-int

allowedOperatorsarray<string>required

The list of allowed operators for this attribute based on its value type.

allowedValuesarray<string>

The list of allowed values for this attribute IF its attributeType is an ENUM.

allowedDisplayValuesarray<string>

The list of allowed Localized Display values for this attribute IF its attributeType is an ENUM based on the locale query param requested. If no locale query param value is provided "default" locale is assumed.

json

{
  "data": [
    {
      "id": "producttype",
      "attributeType": "categorization",
      "valueType": "string",
      "allowedOperators": [
        "equals",
        "notEquals"
      ],
      "attributeName": "Product Type",
      "allowedValues": [
        1,
        2
      ],
      "allowedDisplayValues": [
        "One",
        "Two"
      ]
    }
  ]
}

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

Was this page helpful?