Magento Marketplace User Guide
Complete the Extension Profile

The profile shows the current status of the extension or theme, and provides the content that appears in the Magento Marketplace listing. The following instructions walk you through each field of the form that must be complete before the extension is uploaded for Marketing Review.


Extensions
  • Read-Only Information

    Field

    Description

    Name

    The name was entered when the extension was submitted.

    Version Number

    The Version Number that was entered when the extension was submitted.

    Review Status Indicator

    Indicates the current position of the extension in the submission workflow.

    In Technical Review

    Requires Developer Action

    Ready for Marketing Review

    Product ID

    The Product ID is generated when the extension is submitted, and is unique to this version of the extension.

    Supported Platform

    Indicates the platform(s) supported by this extension.

    Integration

    Indicates if the extension is standalone or an integration with other products or services.

    Package Details

    Re-upload

    Uploads a new version of the package. For example, if you want to change the extension title, you must re-upload the package. Uploading a package restarts the technical review process, and might take up to five days.

    Package Name

    The name of the zip file that was uploaded when the package was submitted.

    Last Uploaded

    The date and time the package was last submitted.

    Review Status

    Indicates the status of the package in the review workflow, with links to the results, if available.

    View the Technical Report

    Displays the results of Technical Review.

    Shared Packages

    To update the selection of shared packages that are needed for this extensino, click the “Choose existing shared packages that should be included with this extension” link.

  • Field Descriptions

    Field

    Description

    Version Title

    The title for this specific version of the extension. This field initially displays the title that was entered during the initial interview. You can leave it “as is,” or update it as needed, according to the guidelines.

    Short Description

    A couple of sentences in English that provides a quick summary of what the extension does. The short description appears at the top of the page next to the title, and should not include the extension name. Maximum characters: 150.

    Long Description

    Provides the detailed description that appears on the Overview tab of the extension listing. Begin with an introductory paragraph that provides an overview of the extension, followed by more detailed information. Maximum characters: 10,000.

    • Use the default body style for the opening paragraph, and do not begin with a heading. Use boldface text only for pricing information. Any additional fees or subscription pricing — including fees charged by a third-party company for integrated services — must be included in the opening paragraph with bold formatting.
    • Use bullets to list features, and make sure to convert all URLs to functioning hyperlinks.
    • You can use simple HTML tags to format the text.

    Product Thumbnail

    The product thumbnail is used as an icon to represent the extension in Marketplace search results and listings. You can upload one thumbnail image to the profile. Maximum size: 5 MB; File types: JPG (JPEG), PNG

    Product Images

    You can upload up to fifteen images to the extension profile. The first image uploaded is used as the main image for the profile, and is featured in extensions listings. Maximum size: 5 MB; File types: JPG (JPEG), PNG

    Links to YouTube Videos

    (Optional) You can include links to up to two YouTube videos from your extension profile. Paste the full URL of each video.

    Version Information

    Categories

    Choose up to three categories for the extension listing.

    Magento Edition & Version

    Choose each edition and version of Magento that is supported by the extension.

    Supported  Browsers

    (Optional) Identities the platform and versions of each browser that the extension supports. Click the Choose link, and mark the checkbox of each supported version. You can hover over each browser icon to list the supported versions. Options:

    Firefox

    Chrome

    Safari

    IE

    Opera

    Documentation

    You can upload one PDF of each of the following types of documentation. A user guide is required for all extensions.Additional documentation might be required, depending on the license.

    User Guide

    A user guide is presented in the order a user might approach the subject, and typically includes step-by-step instructions and screenshots.

    Installation Guide

    Installation instructions are required if the extension is distributed under the GNU Lesser General Public License 3.0.

    Reference Guide

    A reference guide typically follows the structure of the product, and is designed to help you find specific information.

    Make sure to reduce the size of the PDF before uploading it to the profile. Maximum file size for each PDF: 5 MB

    License Type

    Identifies the license type that defines the terms of use. To learn more, see the Open Source Initiative’s Licenses by Name. Options:

    Academic Free License 3.0

    The Academic Free License 3.0 (AFL) is an open source license that permits the free distribution and reuse of proprietary software and derivative works, provided that the source code is made available.

    Apache License 2.0

    The Apache License 2.0 describes the terms of use, reproduction, and distribution of third-party software products that include portions of Apache software. It requires clear attribution to The Apache Software Foundation for any distributions that include Apache software.

    BSD 2-Clause License

    The Berkeley Software Distribution 2-Clause License requires the copyright notice to appear in all source code, but imposes minimal restrictions on the redistribution of open source software. The 2-clause license was derived from the original 4-clause BSD license which requires a notice to appear in all advertising and prohibits the use of the contributor names in endorsements without prior written permission.

    GNU General Public License 3.0

    The GNU General Public License 3.0 (GLP-3.0) is widely used and based on the GNU open source license, and allows for the redistribution of software received from the copyright holder within the provisions outlined in the agreement. Any improved version of the software must be made available for free. To learn more, see: Frequently Asked Questions about GNU Licenses.

    GNU Lesser General Public License 3.0

    The GNU Lesser General Public License 3.0 (LGPL-3.0) is widely used and based on the GNU open source license. LGPL03.0 is somewhat less restrictive than the standard GLP-3.0, and also requires that you provide installation instructions. To learn more, see: Frequently Asked Questions about GNU Licenses.

    MIT License

    The Massachusetts Institute of Technology License (MIT) allows for the reuse, modification, distribution, sublicensing, and sale of proprietary software, provided that all copies include the MIT license and copyright notice.

    Mozilla Public License 1.1

    The Mozilla Public License 1.1 (MPL-1.1) is an open source license that includes explicit patent rights and allows extensions of the code to be licensed in non-open ways. There is no requirement for a derivative work to be distributed under the same license.

    Open Software License 3.0

    The Open Software License 3.0 (OSL-3.0) is a worldwide, royalty-free, non-exclusive license that allows sublicensing and derivative work, provided that they are distributed under the same license.

    Custom License

    To use a custom license, enter the Name of the license, and the License URL, where customers can read the terms of use.

    Stability

    Describes the extension’s current stage of development. Only extensions at the beta or stable stage can be uploaded to Magento Marketplace. Options:

    Beta Build

    Internal testing is complete, and the extension is released to the public to help identify any outstanding issues.

    Stable Build

    Any major issues found during the beta release stage have been resolved, and the extension is ready for market.

    Additional Details

    Mark the checkbox of each applicable item:

    Released with Setup Scripts

    Included Service Contracts

    Included External Service Contracts

    Custom Implementation UI

    Support Web API

    Support Test Coverage

    Supports Responsive Design

    Release Notes

    Describes the current release, including any changes from the previous release and known issues. Click the Edit Release Notes link to update the content. Maximum characters: 10,000 including spaces.

    Extension and Service Pricing

    Extension Price

    Specifies the price that is charged for each supported edition of the extension in U. S. currency. The price must reflect fair market value, with a minimum of $25. If the extension is also available for sale on your site, the prices must be the same. If the extension is available for free, Leave the default price of zero.

    Any additional fees or subscription pricing — including fees charged by a third-party company for integrated services — must be included in the opening paragraph of the Long Description with bold formatting. For example:

    "Additional fees apply for the _____ services / account. Click here for detailed pricing information."

    Installation Details and Price

    (Optional) Determines the price that is charged for installation services, if applicable. If you want to offer installation services for the extension, mark the checkbox, and enter the Installation Price.

    Support Details and Price

    (Optional) Determines the price that is charged on a monthly basis for ongoing Community or Enterprise Edition support. You can define up to three tiers of support pricing. If you want to sell support, mark the checkbox for the applicable version. Then, complete the Support Tier information, as applicable.