Get Categorization Status

Get the status of the latest categorization job.

GET/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/rules-execution

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Categorization Status action (under Catalogs (Data API)).
Fill in the fields below, then reference the result from later steps as {{getCategorizationStatus.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

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

offsetinteger (int32)

The zero-based index of the first hit/data to include in the result.

Default 0

Response

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

typestring

The type of execution job.

One ofevaluationexecution

assignedCountinteger

Indicates total number of products assigned by the execution job.

unassignedCountinteger

Indicates total number of products unassigned by the execution job.

matchedCountinteger

Indicates total number of products evaluated and matched by the evaluation job.

jobStatusstring

Indicates the status of the rules execution job (that is, indicates whether the job completed successfully or an error occurred).

One ofinProgresssuccesserrorunavailable

messagestring

A description of any errors, failures, and exceptions that caused the job to fail.

lastRunDatestring (date-time)

The date that the rules categorization job was last run for given catalog and category.

productIdsarray<string>

The list of matched product IDs returned by the execution job.

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

offsetinteger (int32)

The zero-based index of the first hit/data to include in the result.

Default 0

json

{
  "jobStatus": "success",
  "type": "evaluation",
  "assignedCount": 100,
  "unassignedCount": 100,
  "matchedCount": 100,
  "message": "Job execution failed to start.",
  "lastRunDate": 253402214400,
  "productIds": [
    25772717,
    25772792
  ],
  "limit": 10,
  "offset": 0
}

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

Was this page helpful?