Product Profile completion guidelines

You can manage, update, and publish your products on the marketplace either through a user interface (UI) or by using APIs.

To request publication, product profiles must reach a 100% completion score. However, not all fields are mandatory to achieve this score. The sections below describe the scoring criteria, the key areas that contribute to profile completion, and technical details.

For more details on the overall publication process, refer to the Understanding product publication guide.

Overview of completion scoring

The completion score is calculated based on several key segments:

1. Integration: The most critical segment, accounts for over half of the completion score. These are the configurations that define how to handle product provisioning and fulfillment.
2. Listing and Profile: This segment includes fields necessary for displaying the product properly on the storefront, enhancing its discoverability. Optional fields can be filled in as needed but they won't contribute to the score.
3. Editions: While this has the lowest weight, products cannot be published without defining editions (or variants) and their pricing.

The weight of each field and its impact on the completion score may vary depending on the product type and marketplace configuration. This topic describes which fields are necessary to reach 100% and not specific percentages.

For REST API references, refer to Marketplace Product API, unless specified otherwise.

Note: These are read APIs for products already published on the marketplace.

1. Listing

Field Name on UI	GraphQL Field	REST API	Notes
Company name	vendorName	provider.name
Product name	name	name
Categories	N/A	productGroup.categories	The field's requirement depends on marketplace configuration. See Edit category settings.
5-word description	shortDescription	blurb
Brief overview and SEO description	description	overview

2. Profile

Field Name on UI	GraphQL Field	REST API
Splash title	overview.splashTitle	overview.splashTitle
Splash description	overview.splashDescription	overview.splashDescription
Overview image	overview.image	overview.imageUrl

3. Features

Both the title and description are required for the feature to impact the completion percentage.

Field Name on UI	GraphQL Field	REST API
Feature title	features[x].title	features[X].header
Feature description	features[x].description	features[X].description

4. Support

These fields are mandatory only if the marketplace is configured to require them. Only one is required; adding more won’t increase the score.

Field Name on UI	GraphQL Field	REST API
Support phone number	support.phoneNumber	support.phone
Support email address	support.emailAddress	support.email
Knowledge base	support.helpCenterUrl	support.knowledgebaseUrl

5. Editions

Editions (or variants) are critical for publication. For physical products, variants are generated automatically.

Field Name on UI	GraphQL Field	REST API	Notes
Edition name	editions[x].name	pricing.editions[x].name	For variants, the equivalent is auto-generated.
Edition code	editions[x].code	pricing.editions[x].code	For variants, the equivalent is auto-generated.
Pricing plan	editions[x].pricing	pricing.editions[x].plans

6. Integration

Not all products are fully integrated, and these fields are not required for those products (e.g. manual web app).

Field Name on UI	GraphQL Field	REST API	Notes
Subscription create notification URL	createUrl	N/A	Use createProductIntegration and updateProductIntegration.
Subscription cancel notification URL	cancelUrl	N/A	See above.
User Assignment Notification URL (multi-user apps)	assignUrl	N/A	Only applicable for multi-user products. See above.
User Unassignment Notification URL (multi-user apps)	unassignUrl	N/A	See above.
Credentials	inboundClientId, integration.outboundCredentials	N/A	This does not impact the completion percentage directly but is required to enable other steps that do.
Edit authentication	addProductIntegrationOpenIdConnectConfiguration, addProductIntegrationSamlConfiguration addProductIntegratio.	N/A	This does not impact the completion percentage directly but is required to enable other steps that do.
Run ping tests	triggerProductIntegrationPingTest	N/A
Integration report completed	N/A	N/A	Can only be run manually through the UI; not supported for physical products.