Get Category Rule Conditions

Retrieve conditions for a rule.

GET/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules/{ruleId}/conditions

Use it in a workflow

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

Request

Path parameters

ruleIdanyrequired

The Id of the rule

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

Response

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

limitinteger (int32)

Maximum records to retrieve per request, not to exceed the maximum defined. A limit must be at least 1 so at least one record is returned (if any match the criteria).

Default 10

conditionsarray<object>

The list of conditions for a rule. This can be empty.

idanyrequired

The ID of the condition.

attributeKeyanyrequired

The key of the attribute(system or custom). This represents the ID of the attribute.

attributeNameany

The human-readable name of the attribute(system or custom). This is a read-only field.

attributeValuearray<any>required

The value of the attribute.

operatorstringrequired

The operator for the condition.

One ofstarts_withcontainsequalsnot_equalsgreater_thanless_thanis_one_ofnot_one_ofis_definedis_not_defined

totalinteger (int32)

The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

Default 0

json

{
  "limit": 10,
  "total": 10,
  "conditions": [
    {
      "id": "NameCondition",
      "attributeKey": "name",
      "attributeValue": [
        "Shirt"
      ],
      "operator": "starts_with",
      "attributeName": "name"
    }
  ]
}

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

Was this page helpful?