mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, Extension Create Contributor Onboarding Process, is designed to initiate an onboarding process for a contributor within a marketplace environment. It allows users to create and configure the onboarding workflow specifically for contributors who will be part of a marketplace extension.

Typical use cases include:

  • Automating the setup steps required when a new contributor joins a marketplace.
  • Enforcing shipping restrictions based on geographic location during contributor onboarding.
  • Streamlining contributor management by integrating onboarding directly into workflow automation.

For example, a marketplace administrator can use this node to start the onboarding process for a new contributor while restricting their shipping options to domestic countries only.

Properties

Name Meaning
Contributor Id The unique identifier of the contributor for whom the onboarding process is created.
Shipping Country Restriction Restricts shipping destinations for customers; currently supports "Only Domestic".

Output

The node outputs JSON data representing the result of the onboarding process creation. This typically includes confirmation details such as the status of the onboarding initiation, any identifiers related to the onboarding process, and possibly metadata about the contributor or restrictions applied.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential to authenticate with the external mittwald mStudio API.
  • The node communicates with the mittwald API endpoint at https://api.mittwald.de.
  • The node depends on the bundled OpenAPI specification (openapi.json) and uses an OpenAPI client library to build requests.

Troubleshooting

  • Missing Contributor Id: Since the contributor ID is required, omitting it will likely cause errors. Ensure this property is always provided.
  • Invalid Shipping Country Restriction: Currently, only "Only Domestic" is supported. Using unsupported values may lead to request failures.
  • Authentication Errors: If the API key credential is missing or invalid, the node will fail to authenticate with the mittwald API.
  • Network Issues: Connectivity problems to https://api.mittwald.de will prevent the node from functioning correctly.

To resolve these issues:

  • Verify all required properties are set correctly.
  • Confirm that the API key credential is configured and valid.
  • Check network connectivity and firewall settings.

Links and References

Discussion