Get Site Custom Preference List

Retrieves the Custom Preferences for a specified siteId.

GET/organizations/{organizationId}/site-custom-preferences

Use it in a workflow

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

maskPasswordboolean

Whether to mask password or not.

Default false

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.

limitinteger (int32)

Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 200.

Default 200

offsetinteger (int32)

Used to retrieve the results based on a particular resource offset.

Default 0

Response

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

dataarray<object>

The list of custom preferences in the search result.

groupIdstringrequired

The ID of the preference group.

idstringrequired

The Preference Id.

valueanyrequired

The value for the Preference Id.

json

{
  "data": [
    {
      "groupId": "string",
      "id": "string",
      "value": null
    }
  ]
}

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

Was this page helpful?