Articles in this section

See more

Create Seller Onboarding Processes

  • Updated

The seller onboarding process feature allows operators to define specific tasks that sellers need to complete during onboarding. These processes are manually triggered by sellers in the seller portal and can guide them to external URLs.

Operators can configure various fields for each onboarding process, ensuring tasks are clear, secure, and customized for individual sellers. The processes are managed through the Seller Onboarding Processes page in the operator portal.

How to create a seller onboarding process

  1. Sign in to the operator portal.
  2. Go to Configuration > Seller Onboarding Processes in the left nav dashboard.
  3. Click New Seller Onboarding Process.
  4. Configure the following fields:
    • Name: A unique and descriptive name for the onboarding process to help identify it.
    • Trigger Button Text: The text displayed on the button that sellers will click to start the process (for example, "Connect" or "Complete").
    • Description: A brief explanation of what the onboarding process does, shown to sellers to provide context.
    • URL: The backend endpoint URL where the POST API request will be sent.
    • Headers (optional): Additional headers in JSON format for API requests, often used for authentication.
    • HMAC Key (optional): A key used to encrypt the request for secure communication.
    • GraphQL (optional): The GraphQL query string used to retrieve seller-specific data or identify the seller triggering the process.
    • Action: Select Redirect to redirect sellers to an external page.
  5. Click Save.

The new onboarding process will appear in the seller portal under Setup Requirements.

Notes:

  • Ensure that the endpoint URL and configurations are correct to avoid errors during execution.
  • The endpoint you create should return the following: 
    {
    "result": "https://www.redirecthere.com"
    }
    You can use the sellerOnboardingProcessTrigger mutation to trigger the onboarding process using the API.
  • Use clear and concise descriptions and button text to minimize confusion for sellers.
  • Processes are triggered manually by sellers, so ensure the API response is ready to return the expected URL or information.
Was this article helpful?
0 out of 0 found this helpful

Related articles

On this page