WebStoreBundle | Metadata API Developer Guide

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

WebStoreBundle components have the suffix Webstore and are stored in the .webStoreBundle folder.

Version

WebStoreBundle components are available in API version 49.0 and later.

Special Access Rules

A B2B Commerce or D2C Commerce license and access to Commerce objects is required.

Fields

Field Name	Description
autoFacetingEnabled	Field Type boolean Description Indicates whether auto faceting is enabled (`true`) or not (`false`). If enabled (True), the most relevant search facets are automatically returned, in addition to the configured search facets, in the product search results. If disabled (False), only the configured search facets are returned. The default is `False`.See Add Product Search Filters (Facets).for more information. This field is available in API version 50.0 or later.
cartToOrderAutoCustomFieldMapping	Field Type boolean Description Indicates whether custom field mapping for cart and order objects is enabled (`True`) or not (`False`). The default value is `True`. This field is available in API version 57.0 or later.
commerceEinsteinActivitiesTracked	Field Type boolean Description Indicates whether Commerce Einstein activities tracking is enabled (`true`) or not (`false`).
commerceEinsteinDeployed	Field Type boolean Description Indicates whether Commerce Einstein is deployed (`true`) or not (`false`).
country	Field Type CountryIsoCode (enumeration of type string) Description Two-digit ISO code of the store's country. Purchases can be shipped only to the country assigned to the store. Valid for only D2C stores. This field is available in API version 56.0 and later.
defaultCurrency	Field Type string Description The store’s default currency setting for new records.
defaultLanguage	Field Type string Description Required. The store’s default language setting for new records.
defaultTaxLocaleType	Field Type TaxLocaleType (enumeration of type string) Description Required. The default tax type for the store. Possible values are: `Automatic` `Gross` `Net`
description	Field Type string Description Description of the store.
guestBrowsingEnabled	Field Type boolean Description Indicates whether guest browsing is enabled (`true`) or not (`false`).
guestCartTimeToLive	Field Type int Description Amount of time in minutes that a guest cart stays active and doesn’t expire. This field is available in API version 52.0 and later.
label	Field Type string Description Required. The store’s label.
orderLifeCycleType	Field Type OrderLifeCycleType (enumeration of type string) Description The order life cycle type. Possible values are: `MANAGED` `UNMANAGED` This field is available in API version 55.0 and later.
pricingStrategy	Field Type PricingStrategy (enumeration of type string) Description Required. The price selected to display to buyers. Possible values are: `LowestPrice` `Priority` The default value is `LowestPrice`.
productGrouping	Field Type ProductGrouping (enumeration of type string) Description Determines whether product variations are listed individually in search results or are represented by the parent product, which links to its children. Possible values are: `NoGrouping`—Variations are listed individually in search results. `VariationParent`—The parent product is returned in search results with a link to its children. The default value is `VariationParent`. This field is available in API version 52.0 and later.
skipAdditionalEntitlementCheckForSearch	Field Type boolean Description By default, user entitlement checks are run as part of a search index rebuild and again when product search results are returned. Skips the second check to promote faster search performance. Set the option to `True` to skip additional entitlement checks on a search. This field is available in API version 52.0 and later.
skuDetectionEnabled	Field Type boolean Description Indicates whether SKU detection is enabled (`true`) or not (`false`).
storeName	Field Type string Description Name of the store.
supportedCurrencies	Field Type string Description Currencies supported by the store.
supportedLanguages	Field Type string Description Required. Languages supported by the store.
supportedShipToCountries	Field Type string Description Countries that the store can ship to.
type	Field Type WebStoreType (enumeration of type string) Description Required. The type of store configuration, `B2C`, `B2B`, `or B2CE`. Default is B2B.

Declarative Metadata Sample Definition

The following is an example of a WebStoreBundle component.

1<?xml version="1.0" encoding="UTF-8"?>
2<WebStoreBundle xmlns="http://soap.sforce.com/2006/04/metadata">
3    <autoFacetingEnabled>false</autoFacetingEnabled>
4    <commerceEinsteinActivitiesTracked>false</commerceEinsteinActivitiesTracked>
5    <commerceEinsteinDeployed>false</commerceEinsteinDeployed>
6    <defaultTaxLocaleType>Net</defaultTaxLocaleType>
7    <guestBrowsingEnabled>true</guestBrowsingEnabled>
8    <pricingStrategy>Priority</pricingStrategy>
9    <skipAdditionalEntitlementCheckForSearch>true</skipAdditionalEntitlementCheckForSearch>
10    <skuDetectionEnabled>false</skuDetectionEnabled>
11    <type>B2B</type>
12    <cartToOrderAutoCustomFieldMapping>true</cartToOrderAutoCustomFieldMapping>
13    <country>US</country>
14    <description>WebStore description</description>
15    <guestCartTimeToLive>10</guestCartTimeToLive>
16    <orderLifeCycleType>MANAGED</orderLifeCycleType>
17    <productGrouping>VariationParent</productGrouping>
18    <supportedCurrencies>USD</supportedCurrencies>
19    <supportedShipToCountries>CA;US</supportedShipToCountries>
20    <label>WebStore</label>
21    <supportedLanguages>en_US</supportedLanguages>
22    <defaultLanguage>en_US</defaultLanguage>
23    <defaultCurrency>000</defaultCurrency>
24    <storeName>WebStore</storeName>
25</WebStoreBundle>

The following is an example package.xml that references the previous definition.

1<Package xmlns="http://soap.sforce.com/2006/04/metadata">
2    <types>
3        <name>WebStoreBundle</name>
4        <members>WebStore</members>
5    </types>
6    <version>60.0</version>
7</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.