Newer Version Available

This content describes an older version of this product. View Latest

WebStore

Represents a B2B Commerce store. This object is available in API version 49.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

You must have the B2B Commerce license to create a store.

Fields

Field Details
CheckoutTimeToLive
Type
int
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Amount of time in minutes that a B2B 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
Create, Filter, Nillable, Sort, Update
Description
A time stamp in the default server timezone (GMT). All B2B 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.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The default value is USD. Possible values are:
  • USD—U.S. Dollar
DefaultLanguage
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The primary supported language for your store.
Possible values include:
  • da— Danish
  • de— German
  • en_US— English
  • es— Spanish
  • en_MX— Spanish (Mexico)
  • fi— Finnish
  • fr— French
  • it�� Italian
  • ja— Japanese
  • ko— Korean
  • nl_NL— Dutch
  • no— Norwegian
  • pt_BR— Portuguese (Brazil)
  • ru— Russian
  • sv— Swedish
  • th— Thai
  • zh_CN— Chinese (Simplified)
  • zh_TW— Chinese (Traditional)
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of the store.
GuestBuyerProfileId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the GuestBuyerProfile associated with the store. GuestBuyerProfile determines what buyer groups are part of the profile. The guest buyer groups then determine the entitlements and pricing of products for the guest buyer.
GuestCartTimeToLive
Type
int
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The time that a guest cart is to remain valid. This field is available in API version 52.0 and later.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
LocationId
Type
reference
Properties
Filter, Group, Sort
Description
The location associated with the address.
MaxValuesPerFacet
Type
int
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
The maximum number of values that can be added to a facet.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the catalog.
OptionsGuestBrowsingEnabled
Type
boolean
Properties
Create, Filter, Update
Description
Determines whether guest browsing is enabled for this store. Set the option to True to allow guest buyers access to products in the store.
OptionsSkipAdditionalEntitlementCheckForSearch
Type
boolean
Properties
Create, Filter, Update
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.
PaginationSize
Type
int
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Dimensions of the page.
PricingStrategy
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Possible values are:
  • LowestPrice— Best Price
  • Priority— Priority Price.

The default value is LowestPrice.

ProductGrouping
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
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.
StrikethroughPricebookId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the strikethrough price book.
SupportedCurrencies
Type
textarea
Properties
Create, Defaulted on create, Nillable, Update
Description
Currencies supported in the store.
SupportedLanguages
Type
textarea
Properties
Create, Defaulted on create, Nillable, Update
Description
Languages supported in the store.
Type
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Type of store that can be created.
Possible values are:
  • B2B
  • B2C
  • B2CE
  • OMS
The default value is B2B.