younifyd
Menu

Get Public Product Lists By Search Term

Get Public Product Lists By Search Term

GET/organizations/{organizationId}/product-lists

Use it in a workflow

  1. Add a step and choose the Salesforce Commerce Cloud connector.
  2. Pick the Get Public Product Lists By Search Term action (under Shopper Customers).
  3. Fill in the fields below, then reference the result from later steps as {{getPublicProductListsBySearchTerm.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

emailstring

The email address of the customer the product lists belong to.

firstNamestring

The first name of the customer the product lists belong to. This field is case sensitive and must be an exact match.

lastNamestring

The last name of the customer the product lists belong to. This field is case sensitive and must be an exact match.

siteIdstringrequired

The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.

Response

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

dataarray<object>

The array of product list link documents.

descriptionstring

The description of this product list.

idstringrequired

The ID of the product-list document.

namestring

The name of this product list.

titlestringrequired

The link title.

typestringrequired

The type of the product list.

One ofwish_listgift_registryshopping_listcustom_1custom_2custom_3

json
{
  "data": [
    {
      "id": "3958739435",
      "title": "Product List Title",
      "type": "custom_1",
      "description": "Super Awesome ProductList",
      "name": "My Product List"
    }
  ]
}

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

Get Public Product Lists By Search Term — Salesforce Commerce Cloud — Documentation