Organisation

Object

aiSpendLast30DaysUsd

allowCustomCSS

allowCustomCSSRetailerChanges

canSync

Whether this organisation has a sync implementation (Shopify, or one of the supported custom connectors).

catalogAttributeErrors

Errors recorded during the most recent catalog attribute (product-type attributes) workflow run. Cleared at the start of each run and repopulated as failures occur.

createdAt

The date and time this entity was created.

currentSubscription

Returns the latest subscription (or null if the organisation has never subscribed)

customStockLevelAuthToken

customStockLevelURL

defaultCurrencyCode

The currency code to use for non-shopify stores. Shopify Stores will use the currency code provided by Shopify at runtime.

deviceUptimeRecords

The uptime records which belong to this organisation.

devices

The devices which belong to this organisation.

displayName

The display name for the organisation.

domainName

The domain name for the organisation.

eCommercePlatform

eCommercePlatformConfiguration

An array of KeyValuePairs which contain the configuration for the eCommerce platform. This is used to store any additional data required for the eCommerce platform.

eCommercePlatformDisplayName

The display name for the eCommerce platform, this is used for display purposes only when eCommercePlatform is custom.

effectiveFeatures

engagements

engineSessionTimeoutSeconds

The session timeout in seconds for the engine.

filterExtractionPending

filters

The product filters which belong to this organisation.

fullTextSearchLanguage

hasPendingPublications

Indicates if any entities (Organisation, Device, or Location) within this organisation have pending config publications.

hubspotDealId

hubspotId

ibvEnrichmentErrors

Errors recorded during the most recent IBV enrichment workflow run. Cleared at the start of each run and repopulated as failures occur.

id

A unique internal GlobalId for this entity.

includedFilterConfig

ingestionExemptionRules

Rules for omitting products/variants during custom-connector ingestion

installCompleted

installInformation

installMetadata

Versioned, platform-specific metadata captured during installation

installSurveyAnswers

isClosed

lastIngestionDataDate

The date and time this organisation received ingestion data

lastReportedCatalogStatsForImages

lastReportedCatalogStatsForProductGroups

lastReportedCatalogStatsForProducts

lastReportedCatalogStatsForVariants

lastSyncStatusUpdateReason

locations

The locations which belong to this organisation.

nextSyncAt

When an automated sync will next run for this organisation, using the pending retailer job or a custom-connector schedule, or null when no sync is scheduled.

orders

The orders which belong to this organisation.

orgType

The type of the organisation. Used by Cloudshelf staff for internal classification.

paginatedDeviceUptimeRecords

Returns a paginated array of the device uptime records belonging to this organisation, newest first, optionally filtered by creation date range.

paginatedEngagements

Returns a paginated array of the sessions belonging to this organisation, newest first, optionally filtered by creation date range.

paginatedOrders

Returns a paginated array of the orders belonging to this organisation, newest first, optionally filtered by creation date range and status.

paymentProviderAlmaApiKey

paymentProviderAlmaEnable

paymentProviderAlmaIsTestMode

paymentProviderCustomEnable

paymentProviderCustomUrl

paymentProviderShopifyPOSEnable

paymentProviderStripeApiKey

paymentProviderStripeEnable

paymentProviderVivaWalletClientId

paymentProviderVivaWalletClientSecret

paymentProviderVivaWalletEnable

paymentProviderVivaWalletIsTestMode

plugins

The plugin records which belong to this organisation.

productGroups

The product groups which belong to this organisation.

productVariants

The product variants which belong to this organisation.

products

The products which belong to this organisation.

publishInProgress

Indicates if config publishing is currently in progress for this organisation.

rfidGS1CompanyPrefixes

runIbvWorkflows

Whether IBV workflows are enabled for this organisation.

safetyStockNumber

The safety stock number for the organisation. Any stock level below this number will be considered out of stock.

salesAssistantAllocation

salesAssistantClearRule

salesAssistantNameRule

salesAssistants

The sales assisatnts which belong to this organisation.

status

The status of the organisation. This is used to determine if the organisation is active or idle.

subscriptions

Returns the full subscription history for this organisation (all statuses, oldest first).

supportsPartialSync

Whether this organisation supports a partial (delta) sync. Custom connectors always perform a full sync.

syncErrors

Errors recorded during the most recent sync run. Cleared at the start of each sync and repopulated at the end.

syncStage

Indicates the current stage of the sync process.

trackedUrlRequiresInteraction

When true, customers are expected to interact after scanning tracked URLs for deep linking purposes. When false, tracked URLs will automatically redirect.

uninstallStarted

updatedAt

The date and time this entity was last updated.

users

variables

An array of KeyValuePairs which contain user provided variables to be used by Cloudshelf or Cloudshelf Extensions.