Available with B2C Commerce version 24.7.2, B2C Commerce teams must regularly configure site and environment-specific settings to support changing business needs and technical integrations. In many instances, Storefront Reference Architecture (SFRA)/SiteGenesis implementations rely on declarative Custom Site Preferences to alter these settings without the need for deployment or significant engineering support. Site preferences allow teams to adapt their sites with minimal effort.
+B2C Commerce teams must regularly configure site and environment-specific settings to support changing business needs and technical integrations. In many instances, Storefront Reference Architecture (SFRA)/SiteGenesis implementations rely on declarative Custom Site Preferences to alter these settings without the need for deployment or significant engineering support. Site preferences allow teams to adapt their sites with minimal effort.
The following Preferences API endpoints retrieve preference-related information:
Global custom preferences: @@ -95,8 +95,9 @@
The custom preference API requires a Account Manager token from the Admin APIs.
-You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see Authorization Scopes Catalog.
+For resource access, you must use a client ID and client secret from Account Manager to request an access token. The access token is used as a bearer token and added to the Authorization header of your API request.
+You must include sfcc.preferences in the client ID used to generate the token. For a full list of required permissions, see the Authorization Scopes Catalog.
For detailed setup instructions, see the Authorization for Admin APIs guide.
Caching capabilities are available for the Preferences APIs. For details, see Server-Side Web-Tier Caching.
- -Caching capabilities are available for the Preferences APIs. For details, see Server-Side Web-Tier Caching.*
For instructions on how to retrieve access token for admin APIs: https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html
Example with admin auth
import { Preferences, ClientConfig } from "commerce-sdk";
@@ -175,7 +171,14 @@ Properties
Methods
- get
GlobalCustomPreferenceList
+ - get
GlobalPreferenceGroup
- get
SiteCustomPreferenceList
+ - get
SitePreference
+ - get
SitePreferenceGroup
+ - search
SitePreferences
+ - update
GlobalPreferenceGroup
+ - update
SitePreference
+ - update
SitePreferenceGroup
@@ -194,7 +197,7 @@ constructor
Parameters
@@ -235,7 +238,7 @@ getGlobalCustomPreferenceList
-
Returns Promise
@@ -295,6 +298,89 @@
Returns Promise +
+
+
-
@@ -331,7 +417,7 @@
getGlobalPreferenceGroup
++- get
GlobalPreferenceGroup(options?: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<GetGlobalPreferenceGroupExpandEnum>; groupId: string; instanceType: GetGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<OrganizationPreferences>
+ - get
GlobalPreferenceGroup<T>(options?: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<GetGlobalPreferenceGroupExpandEnum>; groupId: string; instanceType: GetGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : OrganizationPreferences>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+For the specified instance, read the custom preferences in the preference group at the + global (organization) level. Specify 'current' to retrieve the preferences for the instance + on which this call is being made. The system will recognize its type.
+Note:* If instance type sandbox is used, the preference values of development instance type + will be returned as fallback.
+If you would like to get a raw Response object use the other getGlobalPreferenceGroup function.
+Parameters
++-
+
+
+
+
+
+
+Optional options: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<GetGlobalPreferenceGroupExpandEnum>; groupId: string; instanceType: GetGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<OrganizationPreferences>
+A promise of type OrganizationPreferences.
+For the specified instance, read the custom preferences in the preference group at the + global (organization) level. Specify 'current' to retrieve the preferences for the instance + on which this call is being made. The system will recognize its type.
+Note:* If instance type sandbox is used, the preference values of development instance type + will be returned as fallback.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+Optional options: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<GetGlobalPreferenceGroupExpandEnum>; groupId: string; instanceType: GetGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : OrganizationPreferences>
+A promise of type Response if rawResponse is true, a promise of type OrganizationPreferences otherwise.
+getSiteCustomPreferenceList
@@ -306,7 +392,7 @@getSiteCustomPreferenceList
Returns Promise
@@ -366,6 +452,538 @@
@@ -386,45 +1004,6 @@
diff --git a/docs/classes/shoppercustomers.shoppercustomers-3.html b/docs/classes/shoppercustomers.shoppercustomers-3.html
index df98751e..0c976e3d 100644
--- a/docs/classes/shoppercustomers.shoppercustomers-3.html
+++ b/docs/classes/shoppercustomers.shoppercustomers-3.html
@@ -209,6 +209,7 @@ - register
ExternalProfile
- remove
CustomerAddress
- reset
Password
+ - setup
CustomerPaymentMethodReference
- update
Customer
- update
CustomerAddress
- update
CustomerPassword
@@ -233,7 +234,7 @@ -
@@ -299,7 +300,7 @@
Returns Promise +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
getSitePreference
++- get
SitePreference(options?: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<PreferenceValue>
+ - get
SitePreference<T>(options?: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : PreferenceValue>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+Read a specific preference value identified by its ID within the given preference group + and instance type. Returns the preference value for all sites.
+If you would like to get a raw Response object use the other getSitePreference function.
+Parameters
++-
+
+
+
+
+
+
+Optional options: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<PreferenceValue>
+A promise of type PreferenceValue.
+Read a specific preference value identified by its ID within the given preference group + and instance type. Returns the preference value for all sites.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+Optional options: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : PreferenceValue>
+A promise of type Response if rawResponse is true, a promise of type PreferenceValue otherwise.
+getSitePreferenceGroup
++- get
SitePreferenceGroup(options?: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<SitePreferences>
+ - get
SitePreferenceGroup<T>(options?: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : SitePreferences>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+For the specified site and instance, read the custom preferences in the preference group. + Specify 'current' to retrieve the preferences for the instance on which this call is being made. + The system will recognize its type.
+If you would like to get a raw Response object use the other getSitePreferenceGroup function.
+Parameters
++-
+
+
+
+
+
+
+Optional options: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<SitePreferences>
+A promise of type SitePreferences.
+For the specified site and instance, read the custom preferences in the preference group. + Specify 'current' to retrieve the preferences for the instance on which this call is being made. + The system will recognize its type.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+Optional options: RequireParametersUnlessAllAreOptional<{ fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: GetSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : SitePreferences>
+A promise of type Response if rawResponse is true, a promise of type SitePreferences otherwise.
+searchSitePreferences
++- search
SitePreferences(options: RequireParametersUnlessAllAreOptional<{ body: SearchRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<SearchSitePreferencesExpandEnum>; groupId: string; instanceType: SearchSitePreferencesInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<PreferenceValueSearchResult>
+ - search
SitePreferences<T>(options: RequireParametersUnlessAllAreOptional<{ body: SearchRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<SearchSitePreferencesExpandEnum>; groupId: string; instanceType: SearchSitePreferencesInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : PreferenceValueSearchResult>
+
++-
+
+
+
+
+
+
+
+ Field
+ Type
+
+
+
+ id
+ String
+
+
+ display_name
+ Localized String
+
+
+ description
+ Localized String
+
+
+ value_type
+ Enum (see below)
+
+
+
+
+ -
+
+
+
+
+
+
+
+ Field
+ Type
+
+
+
+ id
+ String
+
+
+ display_name
+ Localized String
+
+
+ description
+ Localized String
+
+
+ value_type
+ Enum (see below)
+
+
+
+
+
+Search preferences across sites in the specified preference group and instance. + The query attribute specifies a complex query that can be used to narrow down the search.
+The following is a list of searchable fields:
+Allowed value_type values: string, int, double, text, html, date, image, boolean, money, + quantity, datetime, email, password, set_of_string, set_of_int, set_of_double, + enum_of_string, enum_of_int.
+Note:* value_type can only be joined with other attributes using a conjunction (AND). + Only searchable attributes can be used in sorting.
+Note:* If instance type sandbox is used, the preference values of development instance type + will be returned as fallback.
+If you would like to get a raw Response object use the other searchSitePreferences function.
+Parameters
++-
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: SearchRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<SearchSitePreferencesExpandEnum>; groupId: string; instanceType: SearchSitePreferencesInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<PreferenceValueSearchResult>
+A promise of type PreferenceValueSearchResult.
+Search preferences across sites in the specified preference group and instance. + The query attribute specifies a complex query that can be used to narrow down the search.
+The following is a list of searchable fields:
+Allowed value_type values: string, int, double, text, html, date, image, boolean, money, + quantity, datetime, email, password, set_of_string, set_of_int, set_of_double, + enum_of_string, enum_of_int.
+Note:* value_type can only be joined with other attributes using a conjunction (AND). + Only searchable attributes can be used in sorting.
+Note:* If instance type sandbox is used, the preference values of development instance type + will be returned as fallback.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: SearchRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ expand?: Array<SearchSitePreferencesExpandEnum>; groupId: string; instanceType: SearchSitePreferencesInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : PreferenceValueSearchResult>
+A promise of type Response if rawResponse is true, a promise of type PreferenceValueSearchResult otherwise.
+updateGlobalPreferenceGroup
++- update
GlobalPreferenceGroup(options: RequireParametersUnlessAllAreOptional<{ body: OrganizationPreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<OrganizationPreferences>
+ - update
GlobalPreferenceGroup<T>(options: RequireParametersUnlessAllAreOptional<{ body: OrganizationPreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : OrganizationPreferences>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+For the specified instance, update one or more custom preferences in the preference group + at the global (organization) level.
+Note:* If instance type sandbox is used, the preference values of development instance type + will be returned as fallback.
+If you would like to get a raw Response object use the other updateGlobalPreferenceGroup function.
+Parameters
++-
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: OrganizationPreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<OrganizationPreferences>
+A promise of type OrganizationPreferences.
+For the specified instance, update one or more custom preferences in the preference group + at the global (organization) level.
+Note:* If instance type sandbox is used, the preference values of development instance type + will be returned as fallback.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: OrganizationPreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateGlobalPreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : OrganizationPreferences>
+A promise of type Response if rawResponse is true, a promise of type OrganizationPreferences otherwise.
+updateSitePreference
++- update
SitePreference(options: RequireParametersUnlessAllAreOptional<{ body: PreferenceValue & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<PreferenceValue>
+ - update
SitePreference<T>(options: RequireParametersUnlessAllAreOptional<{ body: PreferenceValue & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : PreferenceValue>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+Update a specific preference value identified by its ID within the given preference group + and instance type. The siteValues map specifies the new values per site.
+If you would like to get a raw Response object use the other updateSitePreference function.
+Parameters
++-
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: PreferenceValue & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<PreferenceValue>
+A promise of type PreferenceValue.
+Update a specific preference value identified by its ID within the given preference group + and instance type. The siteValues map specifies the new values per site.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: PreferenceValue & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; preferenceId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : PreferenceValue>
+A promise of type Response if rawResponse is true, a promise of type PreferenceValue otherwise.
+updateSitePreferenceGroup
++- update
SitePreferenceGroup(options: RequireParametersUnlessAllAreOptional<{ body: SitePreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<SitePreferences>
+ - update
SitePreferenceGroup<T>(options: RequireParametersUnlessAllAreOptional<{ body: SitePreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : SitePreferences>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+For the specified site and instance, update one or more custom preferences in the preference group. + Preferences of type password cannot be set to "****" since it is a reserved value.
+If you would like to get a raw Response object use the other updateSitePreferenceGroup function.
+Parameters
++-
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: SitePreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<SitePreferences>
+A promise of type SitePreferences.
+For the specified site and instance, update one or more custom preferences in the preference group. + Preferences of type password cannot be set to "****" since it is a reserved value.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: SitePreferences & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ groupId: string; instanceType: UpdateSitePreferenceGroupInstanceTypeEnum; maskPasswords?: boolean; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : SitePreferences>
+A promise of type Response if rawResponse is true, a promise of type SitePreferences otherwise.
+Returns Promise
Methods
constructor
Parameters
@@ -274,7 +275,7 @@createCustomerAddress
Returns Promise
@@ -345,7 +346,7 @@ -
@@ -370,7 +371,7 @@
createCustomerPaymentInstrument
Returns Promise
@@ -416,7 +417,7 @@ -
@@ -441,7 +442,7 @@
createCustomerProductList
Returns Promise
@@ -487,7 +488,7 @@ -
@@ -523,7 +524,7 @@
createCustomerProductListItem
Returns Promise
@@ -582,7 +583,7 @@ -
@@ -607,7 +608,7 @@
deleteCustomerPaymentInstrument
Returns Promise
@@ -653,12 +654,12 @@ -
-
@@ -679,12 +680,12 @@
deleteCustomerPaymentMethodReference
Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
+Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
If you would like to get a raw Response object use the other deleteCustomerPaymentMethodReference function.
Returns Promise
-
-
@@ -754,7 +755,7 @@
Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
+Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
Type parameters
@@ -728,7 +729,7 @@deleteCustomerProductList
Returns Promise
@@ -803,7 +804,7 @@ -
@@ -828,7 +829,7 @@
deleteCustomerProductListItem
Returns Promise
@@ -874,7 +875,7 @@ -
@@ -899,7 +900,7 @@
getCustomer
Returns Promise
@@ -945,7 +946,7 @@ -
@@ -970,7 +971,7 @@
getCustomerAddress
Returns Promise
@@ -1016,7 +1017,7 @@ -
@@ -1041,7 +1042,7 @@
getCustomerBaskets
Returns Promise
@@ -1087,7 +1088,7 @@ -
@@ -1112,7 +1113,7 @@
getCustomerOrders
Returns Promise
@@ -1158,7 +1159,7 @@ -
@@ -1183,7 +1184,7 @@
getCustomerPaymentInstrument
Returns Promise
@@ -1229,7 +1230,7 @@ -
@@ -1254,7 +1255,7 @@
getCustomerProductList
Returns Promise
@@ -1300,7 +1301,7 @@ -
@@ -1325,7 +1326,7 @@
getCustomerProductListItem
Returns Promise
@@ -1371,7 +1372,7 @@ -
@@ -1396,7 +1397,7 @@
getCustomerProductLists
Returns Promise
@@ -1442,7 +1443,7 @@ -
@@ -1467,7 +1468,7 @@
getExternalProfile
Returns Promise
@@ -1513,7 +1514,7 @@ -
@@ -1538,7 +1539,7 @@
getProductListItem
Returns Promise
@@ -1584,7 +1585,7 @@ -
@@ -1609,7 +1610,7 @@
getPublicProductList
Returns Promise
@@ -1655,7 +1656,7 @@ -
@@ -1681,7 +1682,7 @@
getPublicProductListItems
Returns Promise
@@ -1730,7 +1731,7 @@ -
@@ -1755,7 +1756,7 @@
getPublicProductListsBySearchTerm
Returns Promise
@@ -1801,7 +1802,7 @@ -
@@ -1827,7 +1828,7 @@
getResetPasswordToken
Returns Promise
@@ -1876,7 +1877,7 @@ -
@@ -1902,7 +1903,7 @@
registerCustomer
Returns Promise
@@ -1951,7 +1952,7 @@ -
@@ -1976,7 +1977,7 @@
registerExternalProfile
Returns Promise
@@ -2022,7 +2023,7 @@ -
@@ -2047,7 +2048,7 @@
removeCustomerAddress
Returns Promise
@@ -2093,7 +2094,7 @@ -
@@ -2119,7 +2120,7 @@
resetPassword
Returns Promise
@@ -2157,6 +2158,81 @@
Returns Promise +
+
+
-
@@ -2193,7 +2269,7 @@
setupCustomerPaymentMethodReference
++- setup
CustomerPaymentMethodReference(options: RequireParametersUnlessAllAreOptional<{ body: PaymentMethodReferenceSetupRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ customerId: string; organizationId: string; siteId: string; zoneId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<PaymentMethodReferenceSetupResponse>
+ - setup
CustomerPaymentMethodReference<T>(options: RequireParametersUnlessAllAreOptional<{ body: PaymentMethodReferenceSetupRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ customerId: string; organizationId: string; siteId: string; zoneId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : PaymentMethodReferenceSetupResponse>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
+If you would like to get a raw Response object use the other setupCustomerPaymentMethodReference function.
+Parameters
++-
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: PaymentMethodReferenceSetupRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ customerId: string; organizationId: string; siteId: string; zoneId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<PaymentMethodReferenceSetupResponse>
+A promise of type PaymentMethodReferenceSetupResponse.
+Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
+Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: PaymentMethodReferenceSetupRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ customerId: string; organizationId: string; siteId: string; zoneId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : PaymentMethodReferenceSetupResponse>
+A promise of type Response if rawResponse is true, a promise of type PaymentMethodReferenceSetupResponse otherwise.
+updateCustomer
@@ -2168,7 +2244,7 @@updateCustomer
Returns Promise
@@ -2239,7 +2315,7 @@ -
@@ -2264,7 +2340,7 @@
updateCustomerAddress
Returns Promise
@@ -2310,7 +2386,7 @@ -
@@ -2335,7 +2411,7 @@
updateCustomerPassword
Returns Promise
@@ -2381,7 +2457,7 @@ -
@@ -2406,7 +2482,7 @@
updateCustomerPaymentInstrument
Returns Promise
@@ -2452,7 +2528,7 @@ -
@@ -2477,7 +2553,7 @@
updateCustomerProductList
Returns Promise
@@ -2523,7 +2599,7 @@ -
@@ -2557,7 +2633,7 @@
updateCustomerProductListItem
Returns Promise
@@ -2712,6 +2788,9 @@
Returns Promise resetPassword
+ -
+ setup
CustomerPaymentMethodReference
+
-
update
Customer
diff --git a/docs/classes/shopperexperience.shopperexperience-3.html b/docs/classes/shopperexperience.shopperexperience-3.html
index 6ed69270..84b2589c 100644
--- a/docs/classes/shopperexperience.shopperexperience-3.html
+++ b/docs/classes/shopperexperience.shopperexperience-3.html
@@ -80,7 +80,7 @@
- Configurable depth levels for subfolder retrieval (0, 1, or 2 levels)
- The entire component hierarchy of the page at design time.
- All merchant data provided at design time.
- Server-side scripting data provided at run time.
+ - Tracking for each rendered component or fragment using a globally unique content link UUID.
+ - Support for reusable component fragments that can be shared across multiple pages.
- get
MultipleContent
- get
Page
- get
Pages
+ - resolve
Qualifiers
- search
Content
@@ -207,7 +225,7 @@ -
@@ -279,7 +297,7 @@
API Overview
-Use the Shopper Experience API to look up page information for pages that are created in Page Designer, content assets and to access content folders.
+Use the Shopper Experience API to look up page information for pages created in Page Designer, search and retrieve content assets, and access content folders.
Authentication & Authorization
@@ -102,6 +102,21 @@Access Content Folders
Only content folders that are marked as online are returned in the API responses.
+ +Search Content Assets
+ +Search for content assets using keywords and refinement filters. The search functionality supports:
++- Keyword-based search across content assets
+ - Refinement attributes to filter results, for example, by folder or content type
+ - Sorting by configurable attributes
+ - Pagination for large result sets (up to 200 items per page)
+
+Only content assets that are online and assigned to a folder are included in search results.
+ +Batch Retrieval
+ +Retrieve multiple content assets or content folders in a single API request for improved performance (up to 50 content assets or folders at once).
Page Responses
@@ -110,6 +125,8 @@Page Responses
Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
Only visible pages are returned. Because the visibility of components is driven by rules (scheduling or customer groups, for example), these rules are subject to evaluation when assembling the component hierarchy in the response. Only components that are visible for the current customer context appear in the response. The same rules apply to the page itself, which is only be processed and returned if it is visible.
@@ -188,6 +205,7 @@Methods
constructor
Parameters
@@ -248,7 +266,7 @@getContent
Returns Promise
@@ -333,7 +351,7 @@ -
@@ -362,7 +380,7 @@
getContentFolder
Returns Promise
@@ -414,7 +432,7 @@ -
@@ -443,7 +461,7 @@
getContentFolders
Returns Promise
@@ -495,7 +513,7 @@ -
@@ -526,7 +544,7 @@
getMultipleContent
Returns Promise
@@ -580,7 +598,7 @@ -
@@ -612,7 +630,7 @@
-
+
getPage
Returns Promise
@@ -667,7 +685,7 @@ -
@@ -700,7 +718,7 @@
-
- PaginatedResultBase: { limit: number; offset: number; total: number } & {}
+
+ Filter: { boolFilter?: BoolFilter; queryFilter?: QueryFilter; range2Filter?: Range2Filter; rangeFilter?: RangeFilter; termFilter?: TermFilter } & {}
- property
- - property
- - property
- - property
+ - property
+
-
- ResultBase: { limit: number; total: number } & {}
+
+ FilteredQuery: { filter: Filter; query: Query } & {}
- property
- - property
-
-
-
-
-
- defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/configuration/preferences/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/configuration/preferences/v1"
+
+
+ GetGlobalPreferenceGroupExpandEnum: "sites"
-
-
+
+
+ GetGlobalPreferenceGroupInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ GetSitePreferenceGroupInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ GetSitePreferenceInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ NestedQuery: { path: string; query: Query; scoreMode?: NestedQueryScoreModeEnum } & {}
+
+
+
+
+
+
+ NestedQueryScoreModeEnum: "avg" | "total" | "max" | "none"
+
+
+
+
+ ObjectAttributeDefinition: { defaultValue?: ValueDefinition; description?: {}; displayName?: {}; effectiveId?: string; externallyDefined?: boolean; externallyManaged?: boolean; fieldHeight?: number; fieldLength?: number; id?: string; key?: boolean; localizable?: boolean; mandatory?: boolean; maxValue?: number; minLength?: number; minValue?: number; multiValueType?: boolean; orderRequired?: boolean; queryable?: boolean; readOnly?: boolean; regularExpression?: string; requiresEncoding?: boolean; scale?: number; searchable?: boolean; setValueType?: boolean; siteSpecific?: boolean; system?: boolean; unit?: {}; valueDefinitions?: Array<ValueDefinition>; valueType?: ValueType; visible?: boolean } & {}
+
+
+
+
+
+
+ OrganizationPreferences: { sitePreferences?: Array<SitePreferences> } & {}
+
+
+
+
+
+
+ PaginatedResultBase: { limit: number; offset: number; total: number } & {}
+
+
+
+
+
+
+ PaginatedSearchResult: { hits?: Array<object>; limit: number; offset: number; query: Query; sorts?: Array<Sort>; total: number } & {}
+
+
+
+
+
+
+ PreferenceValue: { attributeDefinition?: ObjectAttributeDefinition; description?: {}; displayName?: {}; id: string; siteValues?: {}; valueType?: ValueType } & {}
+
+
+
+
+
+
+ PreferenceValueSearchResult: { hits?: Array<PreferenceValue>; limit: number; offset: number; query: Query; sorts?: Array<Sort>; total: number } & {}
+
+
+
+
+
+
+ Query: { boolQuery?: BoolQuery; filteredQuery?: FilteredQuery; matchAllQuery?: object; nestedQuery?: NestedQuery; termQuery?: TermQuery; textQuery?: TextQuery } & {}
+
+
+
+
+
+
+ QueryFilter: { query: Query } & {}
+
+
+
+
+
+
+ Range2Filter: { filterMode?: Range2FilterFilterModeEnum; fromField: string; fromInclusive?: boolean; fromValue?: any | null; toField: string; toInclusive?: boolean; toValue?: any | null } & {}
+
+
+
+
+
+
+ Range2FilterFilterModeEnum: "overlap" | "containing" | "contained"
+
+
+
+
+ RangeFilter: { field: string; from?: RangeFilterFrom; fromInclusive?: boolean; to?: RangeFilterTo; toInclusive?: boolean } & {}
+
+
+
+
+
+
+ RangeFilterFrom: Date | number
+
+
+
+
+
+
+ RangeFilterTo: Date | number
+
+
+
+
+
+
+ ResultBase: { limit: number; total: number } & {}
+
+
+
+
+
+
+ SearchRequest: { limit?: number; offset?: number; query: Query; sorts?: Array<Sort> } & {}
+
+
+
+
+
+
+ SearchSitePreferencesExpandEnum: "value"
+
+
+
+
+ SearchSitePreferencesInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ Site: { cartridges?: string; creationDate?: string; customerListLink?: CustomerListLink; description?: {}; displayName?: {}; id: string; inDeletion?: boolean; lastModified?: string; siteCatalogId?: string; storefrontStatus?: SiteStorefrontStatusEnum } & {}
+
+
+
+
+
+
+ SitePreferences: { site?: Site } & {}
+
+
+
+
+
+
+ SiteStorefrontStatusEnum: "online" | "maintenance" | "to_be_deleted" | "protected"
+
+
+
+
+ Sort: { field: string; sortOrder?: SortSortOrderEnum } & {}
+
+
+
+
+
+
+ SortSortOrderEnum: "asc" | "desc"
+
+
+
+
+ TermFilter: { field: string; operator: TermFilterOperatorEnum; values?: Array<string> } & {}
+
+
+
+
+
+
+ TermFilterOperatorEnum: "is" | "one_of" | "is_null" | "is_not_null" | "less" | "greater" | "not_in" | "neq"
+
+
+
+
+ TermQuery: { fields: Array<string>; operator: TermQueryOperatorEnum; values?: Array<TermQueryValuesInner> } & {}
+
+
+
+
+
+
+ TermQueryOperatorEnum: "is" | "one_of" | "is_null" | "is_not_null" | "less" | "greater" | "not_in" | "neq"
+
+
+
+
+ TermQueryValuesInner: boolean | number | string
+
+
+
+
+
+
+ TextQuery: { fields: Array<string>; searchPhrase: string } & {}
+
+
+
+
+
+
+ UpdateGlobalPreferenceGroupInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ UpdateSitePreferenceGroupInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ UpdateSitePreferenceInstanceTypeEnum: "staging" | "development" | "sandbox" | "production"
+
+
+
+
+ ValueDefinition: { description?: {}; displayValue?: {}; id?: string; position?: number; value?: string } & {}
+
+
+
+
+
+
+ ValueType: "string" | "int" | "double" | "text" | "html" | "date" | "image" | "boolean" | "money" | "quantity" | "datetime" | "email" | "password" | "set_of_string" | "set_of_int" | "set_of_double" | "enum_of_string" | "enum_of_int"
+
+
+
+
+
+
+
+
+
+
+ defaultBaseUri: "https://{shortCode}.api.commercecloud.salesforce.com/configuration/preferences/v1" = "https://{shortCode}.api.commercecloud.salesforce.com/configuration/preferences/v1"
+
+
+
+
getPages
Returns Promise
@@ -745,6 +763,95 @@
+
+
+ CustomerListLink: { customerListId?: string; title?: string } & {}
+
+
+
+
Returns Promise +
+
+
-
@@ -792,7 +899,7 @@
@@ -158,21 +631,150 @@
diff --git a/docs/modules/preferences.html b/docs/modules/preferences.html
index 35218fb9..ff60cf54 100644
--- a/docs/modules/preferences.html
+++ b/docs/modules/preferences.html
@@ -73,18 +73,104 @@
@@ -103,11 +189,54 @@
@@ -121,6 +250,36 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ BoolFilter: { filters?: Array<Filter>; operator: BoolFilterOperatorEnum } & {}
+
+
+
+
+
+
+ BoolFilterOperatorEnum: "and" | "or" | "not"
+
+
+
+
+ BoolQuery: { must?: Array<Query>; mustNot?: Array<Query>; should?: Array<Query> } & {}
+
+
+
+
resolveQualifiers
++- resolve
Qualifiers(options: RequireParametersUnlessAllAreOptional<{ body: QualifierResolveRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ locale?: LocaleCode; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>): Promise<QualifierResolveResponse>
+ - resolve
Qualifiers<T>(options: RequireParametersUnlessAllAreOptional<{ body: QualifierResolveRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ locale?: LocaleCode; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>, rawResponse?: T): Promise<T extends true ? Response : QualifierResolveResponse>
+
++-
+
+
+
+
+
+
+ -
+
+
+
+
+
+
+
+Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
+The endpoint takes each value and determines whether the user is active for the item:
++- Customer groups are verified against the user's qualification via the EffectiveContext.
+ - Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
+ - Data bindings are resolved by fetching the requested records from their respective data providers.
+
+Returns a boolean result for each provided qualifier and resolved data binding objects grouped by provider type and record identifier. If a qualifier cannot be validated,
+falseis returned for that item. If a data binding cannot be resolved, it is omitted from the response.If you would like to get a raw Response object use the other resolveQualifiers function.
+Parameters
++-
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: QualifierResolveRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ locale?: LocaleCode; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Returns Promise<QualifierResolveResponse>
+A promise of type QualifierResolveResponse.
+Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
+The endpoint takes each value and determines whether the user is active for the item:
++- Customer groups are verified against the user's qualification via the EffectiveContext.
+ - Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
+ - Data bindings are resolved by fetching the requested records from their respective data providers.
+
+Returns a boolean result for each provided qualifier and resolved data binding objects grouped by provider type and record identifier. If a qualifier cannot be validated,
+falseis returned for that item. If a data binding cannot be resolved, it is omitted from the response.Type parameters
++-
+
+
+T: boolean
+Parameters
++-
+
+
+
+
+
+ -
+
+
+
+
+
+
+options: RequireParametersUnlessAllAreOptional<{ body: QualifierResolveRequest & CustomRequestBody; fetchOptions?: RequestInit; headers?: {}; parameters?: CompositeParameters<{ locale?: LocaleCode; organizationId: string; siteId: string } & QueryParameters, CommonParameters>; retrySettings?: OperationOptions }>
+An object containing the options for this method.
+Optional rawResponse: T
+Set to true to return entire Response object instead of DTO.
+Returns Promise<T extends true ? Response : QualifierResolveResponse>
+A promise of type Response if rawResponse is true, a promise of type QualifierResolveResponse otherwise.
+searchContent
@@ -756,7 +863,7 @@searchContent
Returns Promise
@@ -889,6 +996,9 @@
@@ -88,13 +131,43 @@
+
+ BoolFilter: PreferencesModelTypes.BoolFilter
+
+
+
+
+ BoolFilterOperatorEnum: PreferencesModelTypes.BoolFilterOperatorEnum
+
+
+
+
+ BoolQuery: PreferencesModelTypes.BoolQuery
+
+
CustomPreference: PreferencesModelTypes.CustomPreference
@@ -104,7 +177,17 @@ CustomPreferenceList: PreferencesModelTypes.CustomPreferenceList
+
+
+
+ CustomerListLink: PreferencesModelTypes.CustomerListLink
+
@@ -114,7 +197,107 @@ ErrorResponse: PreferencesModelTypes.ErrorResponse
+
+
+
+ Filter: PreferencesModelTypes.Filter
+
+
+
+
+ FilteredQuery: PreferencesModelTypes.FilteredQuery
+
+
+
+
+ GetGlobalPreferenceGroupExpandEnum: PreferencesApiTypes.GetGlobalPreferenceGroupExpandEnum
+
+
+
+
+ GetGlobalPreferenceGroupInstanceTypeEnum: PreferencesApiTypes.GetGlobalPreferenceGroupInstanceTypeEnum
+
+
+
+
+ GetSitePreferenceGroupInstanceTypeEnum: PreferencesApiTypes.GetSitePreferenceGroupInstanceTypeEnum
+
+
+
+
+ GetSitePreferenceInstanceTypeEnum: PreferencesApiTypes.GetSitePreferenceInstanceTypeEnum
+
+
+
+
+ NestedQuery: PreferencesModelTypes.NestedQuery
+
+
+
+
+ NestedQueryScoreModeEnum: PreferencesModelTypes.NestedQueryScoreModeEnum
+
+
+
+
+ ObjectAttributeDefinition: PreferencesModelTypes.ObjectAttributeDefinition
+
+
+
+
+ OrganizationPreferences: PreferencesModelTypes.OrganizationPreferences
+
@@ -124,7 +307,107 @@ PaginatedResultBase: PreferencesModelTypes.PaginatedResultBase
+
+
+
+ PaginatedSearchResult: PreferencesModelTypes.PaginatedSearchResult
+
+
+
+
+ PreferenceValue: PreferencesModelTypes.PreferenceValue
+
+
+
+
+ PreferenceValueSearchResult: PreferencesModelTypes.PreferenceValueSearchResult
+
+
+
+
+ Query: PreferencesModelTypes.Query
+
+
+
+
+ QueryFilter: PreferencesModelTypes.QueryFilter
+
+
+
+
+ Range2Filter: PreferencesModelTypes.Range2Filter
+
+
+
+
+ Range2FilterFilterModeEnum: PreferencesModelTypes.Range2FilterFilterModeEnum
+
+
+
+
+ RangeFilter: PreferencesModelTypes.RangeFilter
+
+
+
+
+ RangeFilterFrom: PreferencesModelTypes.RangeFilterFrom
+
+
+
+
+ RangeFilterTo: PreferencesModelTypes.RangeFilterTo
+
@@ -132,12 +415,202 @@ ResultBase: PreferencesModelTypes.ResultBase
+
+
+
+
+ SearchRequest: PreferencesModelTypes.SearchRequest
+
+
+
+
+ SearchSitePreferencesExpandEnum: PreferencesApiTypes.SearchSitePreferencesExpandEnum
+
+
+
+
+ SearchSitePreferencesInstanceTypeEnum: PreferencesApiTypes.SearchSitePreferencesInstanceTypeEnum
+
+
+
+
+ Site: PreferencesModelTypes.Site
+
+
+
+
+ SitePreferences: PreferencesModelTypes.SitePreferences
+
+
+
+
+ SiteStorefrontStatusEnum: PreferencesModelTypes.SiteStorefrontStatusEnum
+
+
+
+
+ Sort: PreferencesModelTypes.Sort
+
+
+
+
+ SortSortOrderEnum: PreferencesModelTypes.SortSortOrderEnum
+
+
+
+
+ TermFilter: PreferencesModelTypes.TermFilter
+
+
+
+
+ TermFilterOperatorEnum: PreferencesModelTypes.TermFilterOperatorEnum
+
+
+
+
+ TermQuery: PreferencesModelTypes.TermQuery
+
+
+
+
+ TermQueryOperatorEnum: PreferencesModelTypes.TermQueryOperatorEnum
+
+
+
+
+ TermQueryValuesInner: PreferencesModelTypes.TermQueryValuesInner
+
+
+
+
+ TextQuery: PreferencesModelTypes.TextQuery
+
+
+
+
+ UpdateGlobalPreferenceGroupInstanceTypeEnum: PreferencesApiTypes.UpdateGlobalPreferenceGroupInstanceTypeEnum
+
+
+ UpdateSitePreferenceGroupInstanceTypeEnum: PreferencesApiTypes.UpdateSitePreferenceGroupInstanceTypeEnum
+
+
+
+
+ UpdateSitePreferenceInstanceTypeEnum: PreferencesApiTypes.UpdateSitePreferenceInstanceTypeEnum
+
+
+
+
+ ValueDefinition: PreferencesModelTypes.ValueDefinition
+
+
+
+
+ ValueType: PreferencesModelTypes.ValueType
+
+
Returns Promise getPages
+ -
+ resolve
Qualifiers
+
-
search
Content
diff --git a/docs/index.html b/docs/index.html
index 48245474..ae4a363a 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -118,7 +118,7 @@
Prerequisites
Download and install Node.js and npm here. ​
Installation
@@ -625,7 +625,7 @@Security
For more information about security considerations related to developing headless commerce applications, see Security Considerations for Headless Commerce on the Commerce Cloud Developer Center.
-If you discover any potential security issues, please report them to security@salesforce.com as soon as possible.
+If you discover any potential security issues, please report them to security@salesforce.com as soon as possible.
Additional Documentation
diff --git a/docs/modules/preferences.PreferencesTypes.html b/docs/modules/preferences.PreferencesTypes.html index dffa0317..95885419 100644 --- a/docs/modules/preferences.PreferencesTypes.html +++ b/docs/modules/preferences.PreferencesTypes.html @@ -76,11 +76,54 @@Index
Type aliases
+- Bool
Filter
+ - Bool
FilterOperatorEnum
+ - Bool
Query
- Custom
Preference
- Custom
PreferenceList
+ - Customer
ListLink
- Error
Response
+ - Filter
+ - Filtered
Query
+ - Get
GlobalPreferenceGroupExpandEnum
+ - Get
GlobalPreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceInstanceTypeEnum
+ - Nested
Query
+ - Nested
QueryScoreModeEnum
+ - Object
AttributeDefinition
+ - Organization
Preferences
- Paginated
ResultBase
+ - Paginated
SearchResult
+ - Preference
Value
+ - Preference
ValueSearchResult
+ - Query
+ - Query
Filter
+ - Range2
Filter
+ - Range2
FilterFilterModeEnum
+ - Range
Filter
+ - Range
FilterFrom
+ - Range
FilterTo
- Result
Base
+ - Search
Request
+ - Search
SitePreferencesExpandEnum
+ - Search
SitePreferencesInstanceTypeEnum
+ - Site
+ - Site
Preferences
+ - Site
StorefrontStatusEnum
+ - Sort
+ - Sort
SortOrderEnum
+ - Term
Filter
+ - Term
FilterOperatorEnum
+ - Term
Query
+ - Term
QueryOperatorEnum
+ - Term
QueryValuesInner
+ - Text
Query
+ - Update
GlobalPreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceInstanceTypeEnum
+ - Value
Definition
+ - Value
Type
Type aliases
Type aliases
+BoolFilter
+BoolFilterOperatorEnum
+BoolQuery
+CustomPreference
CustomPreferenceList
CustomerListLink
+ErrorResponse
Filter
+FilteredQuery
+GetGlobalPreferenceGroupExpandEnum
+GetGlobalPreferenceGroupInstanceTypeEnum
+GetSitePreferenceGroupInstanceTypeEnum
+GetSitePreferenceInstanceTypeEnum
+NestedQuery
+NestedQueryScoreModeEnum
+ObjectAttributeDefinition
+OrganizationPreferences
+PaginatedResultBase
PaginatedSearchResult
+PreferenceValue
+PreferenceValueSearchResult
+Query
+QueryFilter
+Range2Filter
+Range2FilterFilterModeEnum
+RangeFilter
+RangeFilterFrom
+RangeFilterTo
+PaginatedResultBase
ResultBase
SearchRequest
+SearchSitePreferencesExpandEnum
+SearchSitePreferencesInstanceTypeEnum
+Site
+SitePreferences
+SiteStorefrontStatusEnum
+Sort
+SortSortOrderEnum
+TermFilter
+TermFilterOperatorEnum
+TermQuery
+TermQueryOperatorEnum
+TermQueryValuesInner
+TextQuery
+UpdateGlobalPreferenceGroupInstanceTypeEnum
+UpdateSitePreferenceGroupInstanceTypeEnum
+UpdateSitePreferenceInstanceTypeEnum
+ValueDefinition
+ValueType
+ResultBase
Index
References
+- Bool
Filter
+ - Bool
Filter
+ - Bool
FilterOperatorEnum
+ - Bool
FilterOperatorEnum
+ - Bool
Query
+ - Bool
Query
- Custom
Preference
- Custom
Preference
- Custom
PreferenceList
- Custom
PreferenceList
+ - Customer
ListLink
+ - Customer
ListLink
- Error
Response
- Error
Response
+ - Filter
+ - Filter
+ - Filtered
Query
+ - Filtered
Query
+ - Get
GlobalPreferenceGroupExpandEnum
+ - Get
GlobalPreferenceGroupExpandEnum
+ - Get
GlobalPreferenceGroupInstanceTypeEnum
+ - Get
GlobalPreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceInstanceTypeEnum
+ - Get
SitePreferenceInstanceTypeEnum
+ - Nested
Query
+ - Nested
Query
+ - Nested
QueryScoreModeEnum
+ - Nested
QueryScoreModeEnum
+ - Object
AttributeDefinition
+ - Object
AttributeDefinition
+ - Organization
Preferences
+ - Organization
Preferences
- Paginated
ResultBase
- Paginated
ResultBase
+ - Paginated
SearchResult
+ - Paginated
SearchResult
+ - Preference
Value
+ - Preference
Value
+ - Preference
ValueSearchResult
+ - Preference
ValueSearchResult
- Preferences
- Preferences
+ - Query
+ - Query
+ - Query
Filter
+ - Query
Filter
+ - Range2
Filter
+ - Range2
Filter
+ - Range2
FilterFilterModeEnum
+ - Range2
FilterFilterModeEnum
+ - Range
Filter
+ - Range
Filter
+ - Range
FilterFrom
+ - Range
FilterFrom
+ - Range
FilterTo
+ - Range
FilterTo
- Result
Base
- Result
Base
+ - Search
Request
+ - Search
Request
+ - Search
SitePreferencesExpandEnum
+ - Search
SitePreferencesExpandEnum
+ - Search
SitePreferencesInstanceTypeEnum
+ - Search
SitePreferencesInstanceTypeEnum
+ - Site
+ - Site
+ - Site
Preferences
+ - Site
Preferences
+ - Site
StorefrontStatusEnum
+ - Site
StorefrontStatusEnum
+ - Sort
+ - Sort
+ - Sort
SortOrderEnum
+ - Sort
SortOrderEnum
+ - Term
Filter
+ - Term
Filter
+ - Term
FilterOperatorEnum
+ - Term
FilterOperatorEnum
+ - Term
Query
+ - Term
Query
+ - Term
QueryOperatorEnum
+ - Term
QueryOperatorEnum
+ - Term
QueryValuesInner
+ - Term
QueryValuesInner
+ - Text
Query
+ - Text
Query
+ - Update
GlobalPreferenceGroupInstanceTypeEnum
+ - Update
GlobalPreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceInstanceTypeEnum
+ - Update
SitePreferenceInstanceTypeEnum
+ - Value
Definition
+ - Value
Definition
+ - Value
Type
+ - Value
Type
- default
BaseUri
Classes
Type aliases
+- Bool
Filter
+ - Bool
FilterOperatorEnum
+ - Bool
Query
- Custom
Preference
- Custom
PreferenceList
+ - Customer
ListLink
- Error
Response
+ - Filter
+ - Filtered
Query
+ - Get
GlobalPreferenceGroupExpandEnum
+ - Get
GlobalPreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceGroupInstanceTypeEnum
+ - Get
SitePreferenceInstanceTypeEnum
+ - Nested
Query
+ - Nested
QueryScoreModeEnum
+ - Object
AttributeDefinition
+ - Organization
Preferences
- Paginated
ResultBase
+ - Paginated
SearchResult
+ - Preference
Value
+ - Preference
ValueSearchResult
+ - Query
+ - Query
Filter
+ - Range2
Filter
+ - Range2
FilterFilterModeEnum
+ - Range
Filter
+ - Range
FilterFrom
+ - Range
FilterTo
- Result
Base
+ - Search
Request
+ - Search
SitePreferencesExpandEnum
+ - Search
SitePreferencesInstanceTypeEnum
+ - Site
+ - Site
Preferences
+ - Site
StorefrontStatusEnum
+ - Sort
+ - Sort
SortOrderEnum
+ - Term
Filter
+ - Term
FilterOperatorEnum
+ - Term
Query
+ - Term
QueryOperatorEnum
+ - Term
QueryValuesInner
+ - Text
Query
+ - Update
GlobalPreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceGroupInstanceTypeEnum
+ - Update
SitePreferenceInstanceTypeEnum
+ - Value
Definition
+ - Value
Type
Variables
References
+BoolFilter
+ Re-exports BoolFilter +BoolFilter
+ Re-exports BoolFilter +BoolFilterOperatorEnum
+ Re-exports BoolFilterOperatorEnum +BoolFilterOperatorEnum
+ Re-exports BoolFilterOperatorEnum +BoolQuery
+ Re-exports BoolQuery +BoolQuery
+ Re-exports BoolQuery +CustomPreference
@@ -141,6 +300,16 @@CustomPreferenceList
CustomPreferenceList
Re-exports CustomPreferenceListCustomerListLink
+ Re-exports CustomerListLink +CustomerListLink
+ Re-exports CustomerListLink +ErrorResponse
@@ -151,6 +320,106 @@ErrorResponse
ErrorResponse
Re-exports ErrorResponseFilter
+ Re-exports Filter +Filter
+ Re-exports Filter +FilteredQuery
+ Re-exports FilteredQuery +FilteredQuery
+ Re-exports FilteredQuery +GetGlobalPreferenceGroupExpandEnum
+ Re-exports GetGlobalPreferenceGroupExpandEnum +GetGlobalPreferenceGroupExpandEnum
+ Re-exports GetGlobalPreferenceGroupExpandEnum +GetGlobalPreferenceGroupInstanceTypeEnum
+ Re-exports GetGlobalPreferenceGroupInstanceTypeEnum +GetGlobalPreferenceGroupInstanceTypeEnum
+ Re-exports GetGlobalPreferenceGroupInstanceTypeEnum +GetSitePreferenceGroupInstanceTypeEnum
+ Re-exports GetSitePreferenceGroupInstanceTypeEnum +GetSitePreferenceGroupInstanceTypeEnum
+ Re-exports GetSitePreferenceGroupInstanceTypeEnum +GetSitePreferenceInstanceTypeEnum
+ Re-exports GetSitePreferenceInstanceTypeEnum +GetSitePreferenceInstanceTypeEnum
+ Re-exports GetSitePreferenceInstanceTypeEnum +NestedQuery
+ Re-exports NestedQuery +NestedQuery
+ Re-exports NestedQuery +NestedQueryScoreModeEnum
+ Re-exports NestedQueryScoreModeEnum +NestedQueryScoreModeEnum
+ Re-exports NestedQueryScoreModeEnum +ObjectAttributeDefinition
+ Re-exports ObjectAttributeDefinition +ObjectAttributeDefinition
+ Re-exports ObjectAttributeDefinition +OrganizationPreferences
+ Re-exports OrganizationPreferences +OrganizationPreferences
+ Re-exports OrganizationPreferences +PaginatedResultBase
@@ -161,6 +430,36 @@PaginatedResultBase
PaginatedResultBase
Re-exports PaginatedResultBasePaginatedSearchResult
+ Re-exports PaginatedSearchResult +PaginatedSearchResult
+ Re-exports PaginatedSearchResult +PreferenceValue
+ Re-exports PreferenceValue +PreferenceValue
+ Re-exports PreferenceValue +PreferenceValueSearchResult
+ Re-exports PreferenceValueSearchResult +PreferenceValueSearchResult
+ Re-exports PreferenceValueSearchResult +Preferences
@@ -171,6 +470,76 @@Preferences
Preferences
Re-exports PreferencesQuery
+ Re-exports Query +Query
+ Re-exports Query +QueryFilter
+ Re-exports QueryFilter +QueryFilter
+ Re-exports QueryFilter +Range2Filter
+ Re-exports Range2Filter +Range2Filter
+ Re-exports Range2Filter +Range2FilterFilterModeEnum
+ Re-exports Range2FilterFilterModeEnum +Range2FilterFilterModeEnum
+ Re-exports Range2FilterFilterModeEnum +RangeFilter
+ Re-exports RangeFilter +RangeFilter
+ Re-exports RangeFilter +RangeFilterFrom
+ Re-exports RangeFilterFrom +RangeFilterFrom
+ Re-exports RangeFilterFrom +RangeFilterTo
+ Re-exports RangeFilterTo +RangeFilterTo
+ Re-exports RangeFilterTo +ResultBase
@@ -181,6 +550,196 @@ResultBase
ResultBase
Re-exports ResultBaseSearchRequest
+ Re-exports SearchRequest +SearchRequest
+ Re-exports SearchRequest +SearchSitePreferencesExpandEnum
+ Re-exports SearchSitePreferencesExpandEnum +SearchSitePreferencesExpandEnum
+ Re-exports SearchSitePreferencesExpandEnum +SearchSitePreferencesInstanceTypeEnum
+ Re-exports SearchSitePreferencesInstanceTypeEnum +SearchSitePreferencesInstanceTypeEnum
+ Re-exports SearchSitePreferencesInstanceTypeEnum +Site
+ Re-exports Site +Site
+ Re-exports Site +SitePreferences
+ Re-exports SitePreferences +SitePreferences
+ Re-exports SitePreferences +SiteStorefrontStatusEnum
+ Re-exports SiteStorefrontStatusEnum +SiteStorefrontStatusEnum
+ Re-exports SiteStorefrontStatusEnum +Sort
+ Re-exports Sort +Sort
+ Re-exports Sort +SortSortOrderEnum
+ Re-exports SortSortOrderEnum +SortSortOrderEnum
+ Re-exports SortSortOrderEnum +TermFilter
+ Re-exports TermFilter +TermFilter
+ Re-exports TermFilter +TermFilterOperatorEnum
+ Re-exports TermFilterOperatorEnum +TermFilterOperatorEnum
+ Re-exports TermFilterOperatorEnum +TermQuery
+ Re-exports TermQuery +TermQuery
+ Re-exports TermQuery +TermQueryOperatorEnum
+ Re-exports TermQueryOperatorEnum +TermQueryOperatorEnum
+ Re-exports TermQueryOperatorEnum +TermQueryValuesInner
+ Re-exports TermQueryValuesInner +TermQueryValuesInner
+ Re-exports TermQueryValuesInner +TextQuery
+ Re-exports TextQuery +TextQuery
+ Re-exports TextQuery +UpdateGlobalPreferenceGroupInstanceTypeEnum
+ Re-exports UpdateGlobalPreferenceGroupInstanceTypeEnum +UpdateGlobalPreferenceGroupInstanceTypeEnum
+ Re-exports UpdateGlobalPreferenceGroupInstanceTypeEnum +UpdateSitePreferenceGroupInstanceTypeEnum
+ Re-exports UpdateSitePreferenceGroupInstanceTypeEnum +UpdateSitePreferenceGroupInstanceTypeEnum
+ Re-exports UpdateSitePreferenceGroupInstanceTypeEnum +UpdateSitePreferenceInstanceTypeEnum
+ Re-exports UpdateSitePreferenceInstanceTypeEnum +UpdateSitePreferenceInstanceTypeEnum
+ Re-exports UpdateSitePreferenceInstanceTypeEnum +ValueDefinition
+ Re-exports ValueDefinition +ValueDefinition
+ Re-exports ValueDefinition +ValueType
+ Re-exports ValueType +ValueType
+ Re-exports ValueType +defaultBaseUri
@@ -189,6 +748,59 @@defaultBaseUri
Type aliases
+BoolFilter
++- property
+ - property
+
+filters: A list of filters that are logically combined by an operator.
+operator: The logical operator that is used to combine the filters.
+BoolFilterOperatorEnum
+BoolQuery
++- property
+ - property
+ - property
+
+must: List of queries to be evaluated as an
+ANDoperator.mustNot: List of queries to be evaluated as a
+NOToperator.should: List of queries to be evaluated as an
+ORoperator.CustomPreference
@@ -238,6 +850,33 @@CustomPreferenceList
CustomerListLink
++- property
+ - property
+
+customerListId: The customer list identifier
++- Min Length: 1
+ - Max Length: 256
+
+title: The title of the customer list link
++- Max Length: 256
+
+ErrorResponse
@@ -274,63 +913,920 @@ErrorResponse
PaginatedResultBase
-Filter
+offset: The zero-based index of the first hit/data to include in the result.
+boolFilter:
limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter
+limitof the endpoint returning this schema.queryFilter:
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+range2Filter:
+rangeFilter:
+termFilter:
ResultBase
-FilteredQuery
+limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter
+limitof the endpoint returning this schema.filter:
total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+query:
Variables
-Const defaultBaseUri
-GetGlobalPreferenceGroupExpandEnum
+GetGlobalPreferenceGroupInstanceTypeEnum
+GetSitePreferenceGroupInstanceTypeEnum
+GetSitePreferenceInstanceTypeEnum
+NestedQuery
++- property
+ - property
+ - property
+
+path: The path to the nested document.
++- Max Length: 2048
+
+query:
+scoreMode: Indicates how scores for matching child objects affect the root parent document’s relevance score.
+NestedQueryScoreModeEnum
+ObjectAttributeDefinition
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+id: The attribute definition ID
++- Min Length: 1
+ - Max Length: 256
+
+displayName:
+description:
+valueType:
+effectiveId: The effective ID, which is c_id if the attribute is custom, and just the id otherwise. It is read only.
++- Min Length: 1
+ - Max Length: 256
+
+key: Flag indicating if this is a key attribute.
+mandatory: Flag indicating if a value is mandatory for the attribute.
+localizable: Flag indicating if this attribute can be localized.
+siteSpecific: Flag indicating if this attribute is site-specific.
+searchable: Flag indicating if this attribute is searchable.
+queryable: Returns true if the attribute definition is explicitly marked queryable. If no explicit queryable is found and the attribute value type belongs to a queryable type, true is returned too. In all other cases false is returned. Value is computed and read-only.
+visible: Flag indicating if this attribute is visible.
+system: Flag indicating if this attribute is a system attribute.
+unit:
+requiresEncoding: Flag indicating if this attribute can be encoded using the encoding="off" flag in ISML templates. It is read only.
+multiValueType: True if the attribute can have multiple values.
+setValueType: Flag indicating if this attribute is of type 'Set of'. It is read only.
+externallyManaged: Flag indicating if this attribute is externally managed.
+externallyDefined: Flag indicating if this attribute is externally defined.
+orderRequired: Flag indicating if this attribute is required for order of the attribute model's product.
+regularExpression: A regular expression that defines the legal values for this attribute.
++- Max Length: 4000
+
+fieldLength: The length of the field for this attribute in the editor.
+fieldHeight: The height of the field for this attribute in the editor.
+minLength: The minimum length of the field for this attribute.
+readOnly: Flag indicating if this attribute is read-only. It is read only.
+minValue: The minimum possible value for this attribute.
+maxValue: The maximum possible value for this attribute.
+scale: The minimum number of fraction digits for a value of this attribute.
+defaultValue:
+valueDefinitions: The value definitions for the attribute, returned when expand=value.
+OrganizationPreferences
++- property
+
+sitePreferences: The list of site-specific preferences, returned when expand=sites.
+PaginatedResultBase
++- property
+ - property
+ - property
+
+offset: The zero-based index of the first hit/data to include in the result.
+limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter
+limitof the endpoint returning this schema.total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+PaginatedSearchResult
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+query:
+sorts: The sorting that was applied to the result.
+hits: The sorted array of search hits. Can be empty.
+offset: The zero-based index of the first hit/data to include in the result.
+limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter
+limitof the endpoint returning this schema.total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+PreferenceValue
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+id: The preference attribute ID
++- Min Length: 1
+ - Max Length: 256
+
+description:
+displayName:
+attributeDefinition:
+siteValues: A mapping of site IDs to their preference values.
+valueType:
+PreferenceValueSearchResult
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+hits: The sorted array of search hits. Can be empty.
+query:
+sorts: The sorting that was applied to the result.
+offset: The zero-based index of the first hit/data to include in the result.
+limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter
+limitof the endpoint returning this schema.total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+Query
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+boolQuery:
+filteredQuery:
+matchAllQuery: Matches all documents (namespace and document type). This query comes in handy if you just want to filter a search result or really do not have any constraints.
+nestedQuery:
+termQuery:
+textQuery:
+QueryFilter
++- property
+
+query:
+Range2Filter
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+filterMode: Compare mode: overlap, containing, or contained.
+fromField: The field name of the field that starts the first range.
++- Max Length: 260
+
+fromInclusive: A flag indicating if the lower bound of the second range is inclusive. To make the lower bound exclusive, set to
+false.fromValue: The lower bound of the second range. If not specified, the range is open-ended with respect to the lower bound. You can't leave both the lower and upper bounds open-ended.
+toField: The field name of the field that ends the first range.
++- Max Length: 260
+
+toInclusive: A flag indicating if the upper bound of the second range is inclusive. To make the lower bound exclusive, set to
+false.toValue: The upper bound of the second range. If not specified, the range is open-ended with respect to the upper bound. You can't leave both the upper and lower bounds open-ended.
+Range2FilterFilterModeEnum
+RangeFilter
++- property
+ - property
+ - property
+ - property
+ - property
+
+field: The search field.
++- Max Length: 260
+
+from:
+fromInclusive: A flag indicating if the lower bound of the range is inclusive. To make the lower bound exclusive, set to
+false.to:
+toInclusive: A flag indicating if the upper bound of the range is inclusive. To make the upper bound exclusive, set to
+false.RangeFilterFrom
+RangeFilterTo
+ResultBase
++- property
+ - property
+
+limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter
+limitof the endpoint returning this schema.total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.
+SearchRequest
++- property
+ - property
+ - property
+ - property
+
+limit: Maximum records to retrieve per request, not to exceed 200.
+query:
+sorts: The list of sort clauses configured for the search request. Sort clauses are optional. See the description of the search endpoint for details on the default sorting behavior that is used when explicit sorts are not passed.
+offset: The zero-based index of the first hit/data to include in the result.
+SearchSitePreferencesExpandEnum
+SearchSitePreferencesInstanceTypeEnum
+Site
++- property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+ - property
+
+id: The ID of the site.
++- Min Length: 1
+ - Max Length: 32
+
+displayName:
+description:
+customerListLink: The link to the customer list
+inDeletion: Specifies whether the site status is in deletion (true) or not (false)
+storefrontStatus: Status of the storefront
+siteCatalogId: The catalog bound to the given site.
++- Min Length: 1
+ - Max Length: 256
+
+cartridges: The cartridge names assigned to a site delemited by ':'.
++- Max Length: 4000
+
+creationDate: The timestamp when the site was created.
+lastModified: The timestamp when the site was last modified.
+SitePreferences
++- property
+
+site:
+SiteStorefrontStatusEnum
+Sort
++- property
+ - property
+
+field: The name of the field to sort on.
++- Max Length: 256
+
+sortOrder: The sort order to be applied when sorting. When omitted, the default sort order (asc) is used.
+SortSortOrderEnum
+TermFilter
++- property
+ - property
+ - property
+
+field: The filter field.
++- Max Length: 260
+
+operator: The operator used to compare the field's values with the given values.
+values: The filter values.
+TermFilterOperatorEnum
+TermQuery
++- property
+ - property
+ - property
+
+fields: The document fields that the values are matched against, combined with the operator.
+operator: Returns the operator to use for the term query.
+values: The values that the fields are compared against, combined with the operator.
+TermQueryOperatorEnum
+TermQueryValuesInner
+TextQuery
++- property
+ - property
+
+fields: The document fields that the search phrase matches against.
+searchPhrase: A search phrase, which can include multiple terms separated by spaces.
+UpdateGlobalPreferenceGroupInstanceTypeEnum
+UpdateSitePreferenceGroupInstanceTypeEnum
+UpdateSitePreferenceInstanceTypeEnum
+ValueDefinition
++- property
+ - property
+ - property
+ - property
+ - property
+
+id: The attribute value ID
++- Min Length: 1
+ - Max Length: 256
+
+displayValue:
+description:
+position: The position of the value within the list.
+value: The value.
++- Min Length: 1
+ - Max Length: 256
+
+ValueType
+The value type of a preference attribute.
+Variables
+Const defaultBaseUri
+