WebStoreTemplate

Represents a configuration for creating commerce stores. This object is available in API version 49.0 and later.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve()

Supported REST API Methods

DELETE, GET, HEAD, POST, Query

Special Access Rules

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

Fields

Field	Details
CheckoutTimeToLive	Type int Properties Filter, Group, Nillable, Sort Description Amount of time in minutes that a checkout stays active and doesn’t expire. If you use a `Null` value, your checkout never expires. If you use a `0` value, checkout is disabled. This field is available in API version 50.0 and later.
CheckoutValidAfterDate	Type dateTime Properties Filter, Nillable, Sort Description A timestamp in the default server timezone (GMT). All checkouts that start before this date are considered expired. A `Null` value means that all checkouts are valid. Example format: 2020-07-14T14:27:00.000Z. This field is available in API version 50.0 and later.
Country	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort 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	Type string Properties Filter, Group, Sort Description The template’s default currency setting for new records.
DefaultLanguage	Type string Properties Filter, Group, Sort Description Required. The template’s default language setting for new records.
DefaultTaxLocaleType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The template’s default tax type for your webstore. Possible values include: `Gross` `Net` This field is available in API version 55.0 and later.
Description	Type textarea Properties Nillable Description The description of the template.
DeveloperName	Type string Properties Filter, Group, Sort Description Required. The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name.
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated WebStoreTemplate in Metadata API. The full name can include a namespaceprefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
GuestCartTimeToLive	Type int Properties Filter, Group, Nillable, Sort Description The time that a guest cart is to remain valid before it expires. The default value is 168 hours (7 days), and the maximum value is 720 hours (30 days). This field is available in API version 52.0 and later.
Language	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The language of the WebStoreTemplate.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
MasterLabel	Type string Properties Filter, Group, Sort Description Label for the WebStoreTemplate.
MaxValuesPerFacet	Type int Properties Filter, Group, Nillable, Sort Description Maximum number of values that can be added to a facet.
Metadata	Type WebStoreTemplate Properties Create, Nillable, Update Description The metadata for the WebStoreTemplate.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
OptionsAutoFacetingEnabled	Type boolean Properties Filter Description 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.
OptionsCartAsyncProcessingEnabled	Type boolean Properties Filter Description Indicates whether add-to-cart requests are processed asynchronously (`True`) or not (`False`). The default value is `True`. This field is available in API version 59.0 or later.
OptionsCartCalculateEnabled	Type boolean Properties Filter Description Indicates whether the cart calculate extension is enabled (`True`) or not (`False`). The default value is `False`. This field is available in API version 59.0 or later.
OptionsCartToOrderAutoCustomFieldMapping	Type boolean Properties Filter 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.
OptionsCommerceEinsteinActivitiesTracked	Type boolean Properties Filter Description Indicates whether Commerce Einstein activities tracking is enabled (`true`) or not (`false`).
OptionsCommerceEinsteinDeployed	Type boolean Properties Filter Description Indicates whether Commerce Einstein is deployed (`true`) or not (`false`).
OptionsDuplicateCartItemsEnabled	Type boolean Properties Filter Description Indicates whether a cart can include multiple items with the same product ID (True) or not (False). The default value is `False`. This field is available in API version 59.0 or later.
OptionsGuestBrowsingEnabled	Type boolean Properties Filter Description Indicates whether guest browsing is enabled for this store. Set the option to `True` to allow guest buyers access to products in the store.
OptionsGuestCartEnabled	Type boolean Properties Filter Description Required. Indicates whether guest cart access is enabled for a store created with an LWR template. Set the option to `True` to allow guest buyers access to products in the store. This field is available in API version 58.0 and later.
OptionsGuestCheckoutEnabled	Type boolean Properties Filter Description Required. Indicates whether guest checkout access is enabled for a store created with an LWR template. Set the option to `True` to allow guest buyers access to products in the store. This field is available in API version 58.0 and later.
OptionsPreserveGuestCartEnabled	Type boolean Properties Filter Description Required. Indicates whether cart contents are preserved when a guest logs in to the store. Set the option to `True` to preserve guest carts. This field is available in API version 60.0 and later.
OptionsSkipAdditionalEntitlementCheckForSearch	Type boolean Properties Filter 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.
OptionsSkuDetectionEnabled	Type boolean Properties Filter Description Indicates whether SKU detection is enabled (`true`) or not (`false`).
OptionsSplitShipmentEnabled	Type boolean Properties Filter Description Required. Indicates whether split shipments are enabled (`true`) or not (`false`).
OrderActivationStatus	Type string Properties Filter, Group, Nillable, Sort Description Status of the order. Possible values include: `Activated` `Draft`
OrderLifeCycleType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The order life cycle type. Possible values include: `MANAGED` `UNMANAGED`
PaginationSize	Type int Properties Filter, Group, Nillable, Sort Description Number of results displayed per search results page.
PricingStrategy	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. The price selected to display to buyers. Possible values include: `LowestPrice` `Priority` The default value is `LowestPrice`.
ProductGrouping	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort 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.
SupportedCurrencies	Type textarea Properties Description Currencies supported for store template.
SupportedLanguages	Type textarea Properties Description Required. Languages supported for store template.
SupportedShipToCountries	Type textarea Properties Nillable Description Countries that a store created from the template can ship to.
Type	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Required. Possible values are: `B2B` `B2C` `B2CE` `OMS` The default value is `B2B`.

Tooling API

WebStoreTemplate

Supported SOAP API Calls

Supported REST API Methods

Special Access Rules

Fields