Search Products

Search products.

POST/organizations/{organizationId}/product-search

Use it in a workflow

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

siteIdstring

The site context.

Response

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

hitsarray<object>

A sorted array of search hits (`Product` objects). The array can be empty.

assignedCategoriesarray<object>2 fields

The catalog categories that the product is assigned to. It is read only.

atsnumber (double)

The Available To Sell (ATS) inventory value of the product. This is a calculated value.

brandstring

The brand of the product.

bundledProductsarray<object>

The array of bundled products which the product includes. It is read only.

classificationCategoryobject2 fields

Document representing a catalog category ID.

creationDatestring (date-time)

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

defaultVariantIdstring

The ID of the product's default variant. It is read only.

eanstring

The European Article Number of the product.

idstringrequired

The id (SKU) of the product.

imageobject5 fields

Document representing media file.

imageGroupsarray<object>3 fields

The array of product image groups. It is read only.

inStockboolean

The flag that indicates if the product is in stock, or not. This is a calculated value.

lastModifiedstring (date-time)

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

localizedTaxClassIdobject

The localized tax class identifier of the product.

longDescriptionobject

The localized long description of the product.

manufacturerNamestring

The name of the product's manufacturer.

manufacturerSkustring

The SKU of the product's manufacturer.

masterobject5 fields

Representation of a group of variant products by an attribute. This is a non-buyable entity, provides inheritable attributes for it's product variants, and is used for navigation. *Does'nt have a SKU.*

nameobject

The localized name of the product.

onlineboolean

The flag that indicates if the product is online, or not. This is a calculated value.

onlineFlagobject

The site-specific online status of the product.

owningCatalogIdstring

The ID of the catalog that owns the product.

owningCatalogNameobject

The localized name of the catalog that owns the product. It is read only.

pageDescriptionobject

The localized page description of the product.

pageKeywordsobject

The localized page keywords of the product.

pageTitleobject

The localized page title of the product.

pricenumber (double)

The price of the product.

priceCurrencystring

The currency code for a product's price.

pricePerUnitnumber (double)

The price per unit of the product. This is a read only field.

primaryCategoriesarray<object>2 fields

The primary catalog categories that the product is assigned to. It is read only.

primaryCategoryIdstring

The ID of the products primary category. This is a read only field. It is read only.

productBundlesarray<object>

The array of product bundles which the product belongs to. It is read only.

productOptionsarray<object>10 fields

The array of product options. This is applicable for products of type "option". It is read only.

productSetsarray<object>

The array of product sets which the product belongs to. It is read only.

searchableobject

The site-specific searchable status of the product.

setProductsarray<object>

The array of set products which the product includes. It is read only.

shortDescriptionobject

The localized short description of the product.

taxClassIdstring

The tax class identifier of the product.

typeobject11 fields

Document representing a product type.

unitstring

The sales unit of the product.

json

{
  "hits": [
    {
      "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": [
            {
              "path": null,
              "absUrl": null,
              "alt": null,
              "disBaseUrl": null,
              "title": null
            }
          ],
          "viewType": "hi-res",
          "variationAttributes": [
            {
              "attributeDefinitionId": null,
              "attributeDefinitionName": null,
              "defaultValue": null,
              "id": null,
              "name": null,
              "shared": null,
              "slicing": null,
              "values": null,
              "variationAttributeType": null
            }
          ]
        }
      ],
      "inStock": true
    }
  ]
}

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

Was this page helpful?