Magidoc

Cloudshelf
Object

Fields

#

addScannedProductsToBasket

Boolean !
Non-null

additionalNamedStockLocation

Location

additionalNamedStockLocationPlatformProvidedId

String

The platform provided ID of the additional named stock location

allocationStatus

CloudshelfAllocationStatus

The allocation status of this cloudshelf, including device allocation and live status

anyLocationWithOnlineFulfillmentIsStockRelevant

Boolean !
Non-null

attractLoopEnforceSync

Boolean !
Non-null

attractLoopHomeScreenPlacementX

Int !
Non-null

attractLoopIncludeBanners

Boolean !
Non-null

attractLoopIncludeHomeScreen

Boolean !
Non-null

attractLoopIncludeProductGroups

Boolean !
Non-null

attractLoopIncludeProducts

Boolean !
Non-null

attractLoopItemMinimumDuration

Int !
Non-null

attractLoopItemSyncDuration

Int !
Non-null

attractLoopProductCount

Int !
Non-null

attractLoopProductImageCount

Int !
Non-null

attractLoopProductIncludeBrand

Boolean !
Non-null

attractLoopProductIncludeButtonInteractive

Boolean !
Non-null

attractLoopProductIncludeName

Boolean !
Non-null

attractLoopProductIncludePrice

Boolean !
Non-null

attractLoopProductIncludeQRDisplay

Boolean !
Non-null

attractLoopProductSelectionMethod

AttractLoopProductSelectionMethod !
Non-null

background

CloudshelfBackground !
Non-null

banners

[ Banner !]!
Non-null

buyersGuides

[ BuyersGuide !]!
Non-null

callToActionExperience

CloudshelfExperienceType !
Non-null

checkoutExperience

CheckoutExperience !
Non-null

Legacy checkout mode flag retained for compatibility. Prefer callToActionExperience.

checkoutFlow

CheckoutFlowOptions !
Non-null

comparisonEnabled

Boolean !
Non-null

comparisonFields

[ ComparisonField !]!
Non-null

content

[ CloudshelfContent !]!
Non-null

createdAt

UTCDateTime !
Non-null

The date and time this entity was created.

deviceCount

Int

The number of devices linked to this cloudshelf.

deviceCountInternal

Int

The number of internal devices linked to this cloudshelf.

deviceLocationIsStockRelevant

Boolean !
Non-null

devices

[ Device !]!
Non-null

displayDiscountCodeEntry

Boolean !
Non-null

displayHomeFrame

Boolean !
Non-null

displayInStockLabel

Boolean !
Non-null

displayLimitedSelectionLabel

Boolean !
Non-null

displayName

String !
Non-null

displayOnOrderLabel

Boolean !
Non-null

displaySoldOutLabel

Boolean !
Non-null

displayStockCount

Boolean !
Non-null

engagementCountInLastSevenDays

Int

The number of engagements (sessions) for this cloudshelf in the last 7 days.

engagements

[ Session !]!
Non-null

homeFrameCallToAction

String !
Non-null

homeFrameCallToActionAlignment

Alignment !
Non-null

homeFrameCallToActionSize

Size !
Non-null

id

GlobalId !
Non-null

A unique internal GlobalId for this entity.

inStockLabel

String

inStockLocalLabel

String

includeOnOrderProducts

Boolean !
Non-null

includeOutOfStockProducts

Boolean !
Non-null

includeProductsInStockInAnyRelevantLocation

Boolean !
Non-null

includeProductsOutOfStockInAllRelevantLocationsButAvailableForSale

Boolean !
Non-null

includeProductsOutOfStockInAllRelevantLocationsButNotAvailableForSale

Boolean !
Non-null

labels

CloudshelfLabels !
Non-null

limitedSelectionLabel

String

namedLocationIsStockRelevant

Boolean !
Non-null

onOrderLabel

String

owningOrganisation

Organisation !
Non-null

pdpBlocks

[ PDPBlockUnion !]!
Non-null

pdpIncludeSuggestedItems

Boolean !
Non-null

platformProvidedId

GlobalId

An externally provided GlobalId

productGridIncludeBrand

Boolean !
Non-null

selectVariantByDefault

Boolean !
Non-null

soldOutLabel

String

textSearchDescription

Boolean !
Non-null

textSearchMetadata

Boolean !
Non-null

textSearchTags

Boolean !
Non-null

theme

Theme !
Non-null

updatedAt

UTCDateTime !
Non-null

The date and time this entity was last updated.

useLocalStock

Boolean !
Non-null

useOnlineSearch

Boolean !
Non-null

wishlistEmailSeeMoreEnabled

Boolean !
Non-null

Whether the wishlist email should render a "See more" link for each item.

wishlistEmailSeeMoreLabel

String !
Non-null

The button label used for the "See more" link in the wishlist email.

Usages

#

References

#