Add Products To Exclusion List

Add products to the exclusion list.

POST/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/excluded-products

Use it in a workflow

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

Request body

Enter the body as JSON in the step's Body field.

dataarray<object>required

The list of the excluded products.

productIdstringrequired

The id (SKU) of the product.

json

{
  "data": [
    {
      "productId": "apple-ipod-classic"
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{addProductsToExclusionList.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

dataarray<object>

The list of the excluded products. This can be empty.

productIdstringrequired

The id (SKU) of the product.

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,
  "data": [
    {
      "productId": "apple-ipod-classic"
    }
  ]
}

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

Was this page helpful?