---
schema_version: "1"
id: 29a041233a00769653deac3a41d706c4c54adbe0d8d8a5d391b96338179f35ab
title: WebStoreInventorySource
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_webstoreinventorysource.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_webstoreinventorysource.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: f1ca46438b6e39f903fef1de6ce22cc19ea4864abc4e7ced7fc7a3db664cd22c
description: Used to configure the inventory source for a webstore. This object is available in API version 57.0 and later.
---
# WebStoreInventorySource

Used to configure the inventory source for a webstore. This object is available in API version 57.0 and later.

## Supported Calls

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

## Fields

| Field | Details |
| --- | --- |
| DoesAllowGuestInventoryLevel | 
Type

boolean

Properties

Create, Filter, Group, Sort, Update

Description

Indicates whether guest users can view a product’s inventory levels when guest checkout is disabled.



 |
| InventoryCacheTtl | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Amount of time in seconds before cache expires.



 |
| InventoryDimension | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

Specifies which field within inventory levels to use to determine availability.

Possible values are AvailableToFulfill,AvailableToOrder,OnHand.



 |
| IsBopisEnabled | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

Description

Indicates whether the location supports buy online, pick up in store.

The default value is false.



 |
| IsChkInvOnActiveCartEnabled | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

Description

Indicates whether the inventory is checked when a customer adds or edits an item in the active cart.

If an admin wants to enable the inventory check feature for their store, they must set this value to true.

The default value is true.



 |
| IsDefault | 

Type

boolean

Properties

Defaulted on create, Filter, Group, Sort

Description

Indicates whether this is the default inventory source value (true) or not (false).

The default value is false.



 |
| IsEnabled | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Indicates whether the default inventory source is active.

The default value is false.



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



 |
| LocationSourceExtRef | 

Type

string

Properties

Group, Nillable

Description

The external reference identifier associated with the LocationSourceId.



 |
| LocationSourceId | 

Type

reference

Properties

Create, Filter, Group, Sort, Update

Description

The location ID or location group ID for this webstore.

This field is a polymorphic relationship field.

Relationship Name

LocationSource

Relationship Type

Lookup

Refers To

Location, LocationGroup



 |
| Name | 

Type

string

Properties

Autonumber, Defaulted on create, Filter, idLookup, Sort

Description

The source name for this entity.



 |
| ReservationDurationInSeconds | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The amount of time in seconds that a reservation stays active and doesn’t expire. Required for implementations using Omnichannel Inventory.



 |
| ShowGuestInventoryLevel | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Displays the inventory level to guest users, even when guest checkout is disabled.

The default value is false.

This field is available in API version 65.0 and later.



 |
| WebStoreId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

The unique store ID related to this inventory source.

This field is a relationship field.

Relationship Name

WebStore

Relationship Type

Lookup

Refers To

WebStore



 |