WebStoreTemplate

Represents a configuration for creating commerce stores.

Version 

Introduced in API version 49.0.

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 

CheckoutTimeToLive 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 51.0

• 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.

CheckoutValidAfterDate 

• Type: datetime

• Required: No

• Properties: Filter, Nillable, Sort

• Introduced: API version 51.0

• 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.

Country 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 56.0

• 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.

• Possible values:

  • AF — Afghanistan

  • AX — Aland Islands

  • AL — Albania

  • DZ — Algeria

  • AD — Andorra

  • AO — Angola

  • AI — Anguilla

  • AQ — Antarctica

  • AG — Antigua and Barbuda

  • AR — Argentina

  • AM — Armenia

  • AW — Aruba

  • AU — Australia

  • AT — Austria

  • AZ — Azerbaijan

  • BS — Bahamas

  • BH — Bahrain

  • BD — Bangladesh

  • BB — Barbados

  • BY — Belarus

  • BE — Belgium

  • BZ — Belize

  • BJ — Benin

  • BM — Bermuda

  • BT — Bhutan

  • BO — Bolivia, Plurinational State of

  • BQ — Bonaire, Sint Eustatius and Saba

  • BA — Bosnia and Herzegovina

  • BW — Botswana

  • BV — Bouvet Island

  • BR — Brazil

  • IO — British Indian Ocean Territory

  • BN — Brunei Darussalam

  • BG — Bulgaria

  • BF — Burkina Faso

  • BI — Burundi

  • KH — Cambodia

  • CM — Cameroon

  • CA — Canada

  • CV — Cape Verde

  • KY — Cayman Islands

  • CF — Central African Republic

  • TD — Chad

  • CL — Chile

  • CN — China (Hong Kong Only)

  • CX — Christmas Island

  • CC — Cocos (Keeling) Islands

  • CO — Colombia

  • KM — Comoros

  • CG — Congo

  • CD — Congo, the Democratic Republic of the

  • CK — Cook Islands

  • CR — Costa Rica

  • CI — Cote d’Ivoire

  • HR — Croatia

  • CW — Curaçao

  • CY — Cyprus

  • CZ — Czechia

  • DK — Denmark

  • DJ — Djibouti

  • DM — Dominica

  • DO — Dominican Republic

  • EC — Ecuador

  • EG — Egypt

  • SV — El Salvador

  • GQ — Equatorial Guinea

  • ER — Eritrea

  • EE — Estonia

  • SZ — Eswatini

  • ET — Ethiopia

  • FK — Falkland Islands (Malvinas)

  • FO — Faroe Islands

  • FJ — Fiji

  • FI — Finland

  • FR — France

  • GF — French Guiana

  • PF — French Polynesia

  • TF — French Southern Territories

  • GA — Gabon

  • GM — Gambia

  • GE — Georgia

  • DE — Germany

  • GH — Ghana

  • GI — Gibraltar

  • GR — Greece

  • GL — Greenland

  • GD — Grenada

  • GP — Guadeloupe

  • GT — Guatemala

  • GG — Guernsey

  • GN — Guinea

  • GW — Guinea-Bissau

  • GY — Guyana

  • HT — Haiti

  • HM — Heard Island and McDonald Islands

  • VA — Holy See (Vatican City State)

  • HN — Honduras

  • HU — Hungary

  • IS — Iceland

  • IN — India

  • ID — Indonesia

  • IQ — Iraq

  • IE — Ireland

  • IM — Isle of Man

  • IL — Israel

  • IT — Italy

  • JM — Jamaica

  • JP — Japan

  • JE — Jersey

  • JO — Jordan

  • KZ — Kazakhstan

  • KE — Kenya

  • KI — Kiribati

  • KR — Korea, Republic of

  • XK — Kosovo

  • KW — Kuwait

  • KG — Kyrgyzstan

  • LA — Lao People’s Democratic Republic

  • LV — Latvia

  • LB — Lebanon

  • LS — Lesotho

  • LR — Liberia

  • LY — Libya

  • LI — Liechtenstein

  • LT — Lithuania

  • LU — Luxembourg

  • MO — Macao

  • MG — Madagascar

  • MW — Malawi

  • MY — Malaysia

  • MV — Maldives

  • ML — Mali

  • MT — Malta

  • MQ — Martinique

  • MR — Mauritania

  • MU — Mauritius

  • YT — Mayotte

  • MX — Mexico

  • MD — Moldova, Republic of

  • MC — Monaco

  • MN — Mongolia

  • ME — Montenegro

  • MS — Montserrat

  • MA — Morocco

  • MZ — Mozambique

  • MM — Myanmar

  • NA — Namibia

  • NR — Nauru

  • NP — Nepal

  • NL — Netherlands

  • NC — New Caledonia

  • NZ — New Zealand

  • NI — Nicaragua

  • NE — Niger

  • NG — Nigeria

  • NU — Niue

  • NF — Norfolk Island

  • MK — North Macedonia

  • NO — Norway

  • OM — Oman

  • PK — Pakistan

  • PS — Palestine

  • PA — Panama

  • PG — Papua New Guinea

  • PY — Paraguay

  • PE — Peru

  • PH — Philippines

  • PN — Pitcairn

  • PL — Poland

  • PT — Portugal

  • QA — Qatar

  • RE — Reunion

  • RO — Romania

  • RU — Russian Federation

  • RW — Rwanda

  • BL — Saint Barthélemy

  • SH — Saint Helena, Ascension and Tristan da Cunha

  • KN — Saint Kitts and Nevis

  • LC — Saint Lucia

  • MF — Saint Martin (French part)

  • PM — Saint Pierre and Miquelon

  • VC — Saint Vincent and the Grenadines

  • WS — Samoa

  • SM — San Marino

  • ST — Sao Tome and Principe

  • SA — Saudi Arabia

  • SN — Senegal

  • RS — Serbia

  • SC — Seychelles

  • SL — Sierra Leone

  • SG — Singapore

  • SX — Sint Maarten (Dutch part)

  • SK — Slovakia

  • SI — Slovenia

  • SB — Solomon Islands

  • SO — Somalia

  • ZA — South Africa

  • GS — South Georgia and the South Sandwich Islands

  • SS — South Sudan

  • ES — Spain

  • LK — Sri Lanka

  • SR — Suriname

  • SJ — Svalbard and Jan Mayen

  • SE — Sweden

  • CH — Switzerland

  • TW — Taiwan

  • TJ — Tajikistan

  • TZ — Tanzania, United Republic of

  • TH — Thailand

  • TL — Timor-Leste

  • TG — Togo

  • TK — Tokelau

  • TO — Tonga

  • TT — Trinidad and Tobago

  • TN — Tunisia

  • TR — Türkiye

  • TM — Turkmenistan

  • TC — Turks and Caicos Islands

  • TV — Tuvalu

  • UG — Uganda

  • UA — Ukraine

  • AE — United Arab Emirates

  • GB — United Kingdom

  • US — United States

  • UY — Uruguay

  • UZ — Uzbekistan

  • VU — Vanuatu

  • VE — Venezuela, Bolivarian Republic of

  • VN — Vietnam

  • VG — Virgin Islands, British

  • WF — Wallis and Futuna

  • EH — Western Sahara

  • YE — Yemen

  • ZM — Zambia

  • ZW — Zimbabwe

DefaultCurrency 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: The template’s default currency setting for new records.

DefaultLanguage 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Required. The template’s default language setting for new records.

DefaultTaxLocaleType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Restricted picklist, Sort

• Introduced: API version 55.0

• Description: Required. The template’s default tax type for your webstore. Possible values include: This field is available in API version 55.0 and later.

• Possible values:

  • Net — Net

  • Gross — Gross

  • Automatic — Automatic

Description 

• Type: textarea

• Required: No

• Properties: Nillable

• Description: The description of the template.

DeveloperName 

• Type: string

• Required: No

• 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

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 49.0

• 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

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 52.0

• 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).

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Description: The language of the WebStoreTemplate.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• 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

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Label for the WebStoreTemplate.

MaxValuesPerFacet 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Maximum number of values that can be added to a facet.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 49.0

• Description: The metadata for the WebStoreTemplate.

NamespacePrefix 

• Type: string

• Required: No

• 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

• Required: No

• Properties: Filter

• Introduced: API version 50.0

• 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.

OptionsCartAsyncProcessingEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 59.0

• Description: Indicates whether add-to-cart requests are processed asynchronously (True) or not (False). The default value is True.

OptionsCartCalculateEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 59.0

• Description: Indicates whether the cart calculate extension is enabled (True) or not (False). The default value is False.

OptionsCartToOrderAutoCustomFieldMapping 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 57.0

• Description: Indicates whether custom field mapping for cart and order objects is enabled (True) or not (False). The default value is True.

OptionsCommerceEinsteinActivitiesTracked 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether Commerce Einstein activities tracking is enabled (true) or not (false).

OptionsCommerceEinsteinDeployed 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether Commerce Einstein is deployed (true) or not (false).

OptionsDuplicateCartItemsEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 59.0

• Description: Indicates whether a cart can include multiple items with the same product ID (True) or not (False). The default value is False.

OptionsGuestBrowsingEnabled 

• Type: boolean

• Required: No

• 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

• Required: No

• Properties: Filter

• Introduced: API version 58.0

• 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.

OptionsGuestCheckoutEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 58.0

• 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.

OptionsPreserveGuestCartEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 60.0

• 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.

OptionsSkipAdditionalEntitlementCheckForSearch 

• Type: boolean

• Required: No

• Properties: Filter

• Introduced: API version 52.0

• 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.

OptionsSkuDetectionEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Indicates whether SKU detection is enabled (true) or not (false).

OptionsSplitShipmentEnabled 

• Type: boolean

• Required: No

• Properties: Filter

• Description: Required. Indicates whether split shipments are enabled (true) or not (false).

OrderActivationStatus 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 55.0

• Description: Status of the order. Possible values include:

• Activated

• Draft

OrderLifeCycleType 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 55.0

• Description: The order life cycle type. Possible values include:

• Possible values:

  • MANAGED — Managed

  • UNMANAGED — Unmanaged

PaginationSize 

• Type: int

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Number of results displayed per search results page.

PricingStrategy 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Description: Required. The price selected to display to buyers. Possible values include: The default value is LowestPrice.

• Possible values:

  • LowestPrice — Best Price (default)

  • Priority — Priority Price

• Default value: LowestPrice

ProductGrouping 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Introduced: API version 51.0

• Description: Determines whether product variations are listed individually in search results or are represented by the parent product, which links to its children. The default value is VariationParent.

• Possible values:

  • BestMatch — Show best match product only (default)

  • VariationParent — Show parent product only — The parent product is returned in search results with a link to its children.

  • NoGrouping — Show all product variations — Variations are listed individually in search results.

• Default value: BestMatch

SupportedCurrencies 

• Type: textarea

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Currencies supported for store template.

SupportedLanguages 

• Type: textarea

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: Required. Languages supported for store template.

SupportedShipToCountries 

• Type: textarea

• Required: No

• Properties: Nillable

• Introduced: API version 57.0

• Description: Countries that a store created from the template can ship to.

Type 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Description: Required.

The default value is B2B.

• Possible values:

  • B2B — B2B (default)

  • B2C — B2C

  • B2CE — B2C Enterprise

  • OMS — OMS

• Default value: B2B