Documentation
Connector Configuration
States
  • Create
    The create state indicates that the Connector Configuration is in creation.
  • Active
    The active state indicates that the Connector Configuration is active and may be used.
  • Inactive
    The inactive state indicates that the Connector Configuration is inactive and may not be used.
  • Deleting
    The deleting state indicates that the Connector Configuration is in the process to be deleted.
  • Deleted
    The deleted state marks the entity for purging from the database.
Properties
  • Conditions
    If a transaction meet all selected conditions the connector configuration will be used to process the transaction otherwise the next connector configuration in line will be chosen according to the priorities.
  • Configuration Name
    The connector configuration name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
  • Connector
  • Enabled Sales Channels
    Defines the sales channels the connector configuration is enabled for. In case the set is empty, the connector configuration is enabled for all sales channels.
  • Enabled for Transaction Processing
    This property indicates if the connector is currently used for processing transactions. In case either the payment method configuration or the processor configuration is not active the connector will not be used even though the connector state is active.
  • Enabled for the Space Views
    The connector configuration is only enabled for the selected space views. In case the set is empty the connector configuration is enabled for all space views.
  • Id
    The ID is the primary key of the entity. The ID identifies the entity uniquely.
  • Linked Space ID
    The linked space id holds the ID of the space to which the entity belongs to.
  • Payment Method Configuration
  • Planned Purge Date
    The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  • Priority
    The priority will define the order of choice of the connector configurations. The lower the value, the higher the priority is going to be. This value can also be a negative number in case you are adding a new configuration that you want to have a high priority and you dont want to change the priority of all the other configurations.
  • Processor Configuration
  • State
  • Version
    The version number indicates the version of the entity. The version is incremented whenever the entity is changed.