Get Global Preference Group

GET/organizations/{organizationId}/global-preference-groups/{groupId}/{instanceType}

Use it in a workflow

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

groupIdstringrequired

The preference group ID.

instanceTypestringrequired

The instance type for which to read or update preferences.

One ofstagingdevelopmentsandboxproduction

Query parameters

maskPasswordsboolean

The preference values of type Password are masked when set.

Default false

expandarray<string>

Expands the result document to include additional information. For global preference groups, the expansion "sites" retrieves the custom preferences for all the available sites.

Response

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

sitePreferencesarray<object>

The list of site-specific preferences, returned when expand=sites.

siteobject10 fields

json

{
  "sitePreferences": [
    {
      "site": {
        "id": null,
        "displayName": {},
        "description": {},
        "customerListLink": null,
        "inDeletion": false,
        "storefrontStatus": "online",
        "siteCatalogId": "storefront-catalog-m-en",
        "cartridges": "app_storefront_core:app_storefront_base",
        "creationDate": "2024-01-15T10:00:00.000Z",
        "lastModified": "2024-10-14T15:30:00.000Z"
      }
    }
  ]
}

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

Was this page helpful?