Create the OnboardingProcess of a contributor

POST/contributors/{contributorId}/onboarding-process/

API version

v2

Request method

POST

Operation ID

extension-create-contributor-onboarding-process

---

The OnboardingProcess is needed to publish paid extensions.

Request

• contributorIdstring (uuid)

  required
  Example:"907a24e9-0723-4566-b584-86578419e983"

Responses

Format

application/json

Description

The Process has been started.

Schema documentation

• contributorIdstring (uuid)
• onboardingLinkstring

Example

Content-Type: application/json

{
  "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "onboardingLink": "string"
}

JSON Schema

{
  "properties": {
    "contributorId": {
      "format": "uuid",
      "type": "string"
    },
    "onboardingLink": {
      "type": "string"
    }
  },
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"shippingCountryRestriction":"onlyDomestic"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/contributors/f0f86186-0a5a-45b2-aa33-502777496347/onboarding-process

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.marketplace.extensionCreateContributorOnboardingProcess({
  "contributorId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "shippingCountryRestriction": "onlyDomestic"
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionCreateContributorOnboardingProcess\ExtensionCreateContributorOnboardingProcessRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Marketplace\ExtensionCreateContributorOnboardingProcess\ExtensionCreateContributorOnboardingProcessRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// ExtensionCreateContributorOnboardingProcessRequestBody to learn how to construct a valid instance
$body = new ExtensionCreateContributorOnboardingProcessRequestBody(/* TODO: ... */);

$request = (new ExtensionCreateContributorOnboardingProcessRequest(
  contributorId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->marketplace()->extensionCreateContributorOnboardingProcess($request);

var_dump($response->getBody();