Magidoc

Organisation
Object

This object represents an organisation, usually a retailer. This object owns all the other data in the system for a given organisation.

Fields

#

allowCustomCSS

Boolean !
Non-null

allowCustomCSSRetailerChanges

Boolean !
Non-null

createdAt

UTCDateTime !
Non-null

The date and time this entity was created.

currentSubscription

SubscriptionRecord

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

customStockLevelAuthToken

String

customStockLevelURL

String

defaultCurrencyCode

CurrencyCode !
Non-null

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

deviceUptimeRecords

[ DeviceUptimeRecord !]!
Non-null

The uptime records which belong to this organisation.

devices

[ Device !]!
Non-null

The devices which belong to this organisation.

displayName

String !
Non-null

The display name for the organisation.

domainName

String !
Non-null

The domain name for the organisation.

eCommercePlatform

ECommercePlatform !
Non-null

eCommercePlatformConfiguration

[ KeyValuePair !]!
Non-null

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

String !
Non-null

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

effectiveFeatures

[ SubscriptionFeature !]!
Non-null

engagements

[ Session !]!
Non-null

fullTextSearchLanguage

ProductLanguage

hasPendingPublications

Boolean !
Non-null

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

hubspotDealId

String

hubspotId

String

id

GlobalId !
Non-null

A unique internal GlobalId for this entity.

installCompleted

Boolean !
Non-null

installInformation

InstallInformation !
Non-null

installSurveyAnswers

String

isClosed

Boolean !
Non-null

lastIngestionDataDate

UTCDateTime

The date and time this organisation received ingestion data

lastReportedCatalogStatsForImages

CatalogStats

lastReportedCatalogStatsForProductGroups

CatalogStats

lastReportedCatalogStatsForProducts

CatalogStats

lastReportedCatalogStatsForVariants

CatalogStats

lastSyncStatusUpdateReason

OrganisationSyncUpdateReason

locations

[ Location !]!
Non-null

The locations which belong to this organisation.

orders

[ Order !]!
Non-null

The orders which belong to this organisation.

paymentProviderAlmaApiKey

String

paymentProviderAlmaEnable

Boolean !
Non-null

paymentProviderAlmaIsTestMode

Boolean !
Non-null

paymentProviderCustomEnable

Boolean !
Non-null

paymentProviderCustomUrl

String

paymentProviderShopifyPOSEnable

Boolean !
Non-null

paymentProviderStripeApiKey

String

paymentProviderStripeEnable

Boolean !
Non-null

paymentProviderVivaWalletClientId

String

paymentProviderVivaWalletClientSecret

String

paymentProviderVivaWalletEnable

Boolean !
Non-null

paymentProviderVivaWalletIsTestMode

Boolean !
Non-null

plugins

[ Plugin !]!
Non-null

The plugin records which belong to this organisation.

productGroups

[ ProductGroup !]!
Non-null

The product groups which belong to this organisation.

productVariants

[ ProductVariant !]!
Non-null

The product variants which belong to this organisation.

products

[ Product !]!
Non-null

The products which belong to this organisation.

publishInProgress

Boolean !
Non-null

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

rfidGS1CompanyPrefixes

[ String !]!
Non-null

safetyStockNumber

Int !
Non-null

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

salesAssistantAllocation

Boolean !
Non-null

salesAssistantClearRule

ClearSalesAssistantRule !
Non-null

salesAssistantNameRule

SalesAssistantNameRule !
Non-null

salesAssistants

[ SalesAssistant !]!
Non-null

The sales assisatnts which belong to this organisation.

status

OrganisationStatus !
Non-null

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

syncStage

SyncStage !
Non-null

Indicates the current stage of the sync process.

uninstallStarted

Boolean !
Non-null

updatedAt

UTCDateTime !
Non-null

The date and time this entity was last updated.

users

[ User !]!
Non-null

variables

[ KeyValuePair !]!
Non-null

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

Usages

#

References

#