Skip to content

Commerzly App Publishing Guide

This document provides a structured and professional step-by-step guide for publishing an app in the Commerzly ecosystem. Follow these stages to ensure your app meets compliance requirements and achieves a smooth launch.

1. Partner Dashboard Setup

  • Create an account in the partner dashboard.
  • Retrieve your client ID and client secret, and configure them in your app's .env file.

2. App Configuration

  • Provide your app name and handle in the toml configuration file.
  • Define application URLs, including allowed redirection URLs.
  • Select embedding option (True/False) for Commerzly Admin and POS.
  • Configure compliance webhooks: Customer data request, Customer data erasure, Shop data erasure.
  • Upload your app icon.

3. App Distribution

  • Choose a distribution method: Public (global merchants) or Custom (specific stores/organizations).
  • For Public Distribution: Publish as listed or unlisted on the App Store.
  • For Custom Distribution: Generate custom install links for specific stores.

4. Compliance & Preliminary Steps

  • Check supported API versions (GraphQL/REST).
  • Fix configuration issues (URLs must not include 'Commerzly' or 'example').
  • Ensure app settings: unique icon and proper API contact email.
  • Add an emergency contact for your account.

5. App Listing Content

  • Provide App Name: Ensure uniqueness and alignment with app setup.
  • Upload App Icon: 1200x1200px, .jpg or .png, without text or seasonal elements.
  • Select App Category, supported Languages, and provide Store Listing Content.
  • Write App Introduction (2 clear sentences, no links/formatting).
  • Highlight Features and upload Feature Media (1600x900px, video ≤ 3 min).
  • Provide Screenshots (desktop/mobile/POS) with alt text.
  • Add Support Information: Email, portal URL, phone number (optional).
  • Include Resources: Privacy Policy, Developer Website, FAQs, Tutorials.

6. Pricing & Discovery

  • Define Pricing Plans: Include descriptive names and feature highlights.
  • Provide App Discovery Content: Subtitle, search terms, and install requirements.
  • Specify sales channel and geographic requirements.

7. Contact & Testing Information

  • Merchant Review Email and App Submission Email.
  • Provide test account credentials for app testing (username, password, account details).
  • Include a Screencast URL (video demo of onboarding and functionality).
  • Add Testing Instructions to guide reviewers.

8. Automated Checks & Compliance

  • Ensure immediate authentication and UI redirection after install.
  • Implement mandatory compliance webhooks with HMAC verification.
  • Use a valid TLS certificate.
  • Enable Embedded App Checks by interacting with the app on a development store.
  • Ensure the latest App Bridge script and session tokens for authentication.