Skip to main content

Intro

The following guide will go into more detail on how to interface with the addons.

This ecosystem consists out of two types of interfacing:

  • Mapped interfacing
  • Unmapped interfacing

Mapped interfacing​

Mapped interfacing means that the interface is unified. For example, if the order data is needed it may come in from different sources and will have different kind of data structures. By using a unified interface the codebase will be more consistent and easier to maintain.

The following sub-types are currently unified:

TypeSub-typeUnifiedMap version
integrationfinanceβœ…unified version
integrationprovider🚧unified version
integrationcarrierβœ…unified version
integrationmarketplace🚧unified version
integrationparcelshop🚧unified version
toollogging❌
tooldb❌

More information can be found withtin then documentation of the appropriate addons.

note

Each sub-type has it's own 'map version', which is the version of the unified interface for that sub-type.

Unmapped interfacing​

Unmapped interfacing means that the interface is not unified. For example, if the order data is needed it may come in from different sources and will have different kind of data structures. This will mostly occure in specific addons that are primarly focused on a specific platform and usage within CSS webapps. Or with addons that don't share thier sub-type with other interfaces.

It is still possible to use them in your project but keep in mind that interfacing them will be a bit more complex or require more adjustments in your code. More information can be found withtin then documentation of the appropriate addons.