Documentation
Documentation
    • English (United States)
Space
Close API Documentation
Space

Spaces store configurations and data. We recommend to use a space per webshop. It is not possible to share data between spaces.

If you want to have different configuration inside the space then use space views (for example different payment methods for different country stores).

When to use space views?

If you have one webshop that sells into different countries using the same database, then you should use the concept of space views.

When to use different spaces?

In case you have completely separated webshops that have a different database, then use two different spaces.

States
  • Create
    The create state indicates that the Space is in creation.
  • Active
    The active state indicates that the Space is active and may be used.
  • Inactive
    The inactive state indicates that the Space is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Space is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Account
    The account to which the space belongs to.
  • Active
    Active means that this account and all accounts in the hierarchy are active.
  • Active Or Restricted Active
    This property is true when all accounts in the hierarchy are active or restricted active.
  • Created By
    The ID of the user who created this entity.
  • Created On
    The date and time when this entity was created.
  • Database
    The database in which the space's data are stored in.
  • Deleted By
    The ID of a user that deleted this entity.
  • Deleted On
    The date and time when this entity was deleted.
  • ID
    A unique identifier for the object.
  • Last Modified Date
    The date and time when the object was last modified.
  • Name
    The space name is used internally to identify the space in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • Planned Purge Date
    The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
  • Postal Address
    The address to use in communication with clients for example in email, documents etc.
  • Primary Currency
    This is the currency that is used to display aggregated amounts in the space.
  • Request Limit
    The request limit defines the maximum number of API request accepted within 2 minutes for this space. This limit can only be changed with special privileges.
  • Restricted Active
    Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.
  • State
    The object's current state.

    A Space can have the following states:

    Active

    When the state is set to Active you are able to access and use all the configurations you set up for this specific space and its corresponding space views.

    Inactive

    When the state is set to Inactive all the corresponding configurations in this space are ignored. However, all the information is not deleted and you can reactivate the space at any moment.

    Deleting

    The space is in the process of deletion. This may take some time until the space is marked as Deleting before being marked as Deleted.

    Deleted

    The space is deleted. Since the space is linked with data which cannot be deleted immediately, we need to keep the space until all the data can be removed.

  • Technical Contact Addresses
    The email address provided as contact addresses will be informed about technical issues or errors triggered by the space.
  • Time Zone
    The time zone assigned to the space determines the time offset for calculating dates within the space. This is typically used for background processed which needs to be triggered on a specific hour within the day. Changing the space time zone will not change the display of dates.
  • Version
    The version is used for optimistic locking and incremented whenever the object is updated.