younifyd
Menu

Search Products Assigned To Category

Search for category product assignments.

POST/organizations/{organizationId}/catalogs/{catalogId}/categories/{categoryId}/category-product-assignment-search

Use it in a workflow

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

siteIdstring

The site context.

Response

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

hitsarray<object>

The sorted array of search hits. This array can be empty.

catalogIdanyrequired

The ID of the catalog.

categoryIdanyrequired

The ID of the category.

creationDatestring (date-time)

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

lastModifiedstring (date-time)

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

owningCatalogNameobject

The name of the catalog that owns the product.

positionnumber (double)

The position of product category assignment.

productobject40 fields

Any product that is sold, shown alone, and does not have variations such as different sizes or colors. Product that has no reliance on any other product for inheritance. *A product has a SKU and can have a product option, which has a different SKU*.

productIdstringrequired

The id (SKU) of the product.

productNameobject

The name of the product.

json
{
  "hits": [
    {
      "catalogId": "apparel-catalog",
      "categoryId": "mens",
      "productId": "apple-ipod-classic",
      "creationDate": 253402214400,
      "lastModified": 253402214400,
      "owningCatalogName": {},
      "position": 2,
      "product": {
        "id": "apple-ipod-classic",
        "assignedCategories": [
          {
            "catalogId": "apparel-catalog",
            "categoryId": "mens"
          }
        ],
        "ats": 15,
        "brand": "Apple",
        "bundledProducts": [
          {}
        ],
        "classificationCategory": {
          "catalogId": "apparel-catalog",
          "categoryId": "mens"
        },
        "creationDate": 253402214400,
        "defaultVariantId": "apple-ipod-classic-8gb-black",
        "ean": "ksdf69w4",
        "image": {
          "path": "/images/apple-ipod-classic.jpg",
          "absUrl": "https://www.example-image.com/images/apple-ipod-classic.jpg",
          "alt": {
            "en_US": "iPod"
          },
          "disBaseUrl": "https://www.dis-base-url/images/apple-ipod-clasic.jpg",
          "title": {
            "en_US": "iPod"
          }
        },
        "imageGroups": [
          {
            "images": [
              null
            ],
            "viewType": "hi-res",
            "variationAttributes": [
              null
            ]
          }
        ],
        "inStock": true
      },
      "productName": {
        "default": "Summer Bomber Jacket"
      }
    }
  ]
}

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