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

#

createdAt

DateTime !
Non-null

The date and time this entity was created.

currentSubscription

SubscriptionRecord

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

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.

id

GlobalId !
Non-null

A unique internal GlobalId for this entity.

installCompleted

Boolean !
Non-null

installInformation

InstallInformation !
Non-null

installSurveyAnswers

String

locations

[ Location !]!
Non-null

The locations which belong to this organisation.

orders

[ Order !]!
Non-null

The orders which belong to this organisation.

productGroups

[ ProductGroup !]!
Non-null

The product groups which belong to this organisation.

products

[ Product !]!
Non-null

The products which belong to this organisation.

salesAssistantClearRule

ClearSalesAssistantRule !
Non-null

salesAssistantNameRule

SalesAssistantNameRule !
Non-null

uninstallStarted

Boolean !
Non-null

updatedAt

DateTime !
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

#

  • Field owningOrganisation from Device