Mapping product fields

This section provides instructions on mapping product fields from the UI to GraphQL APIs.

Unless otherwise specified, the fields are Product object fields. For more information, refer to https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html.

Create new product screen

Location	Field name	GraphQL Field	Schema Reference
Create New Product	Product Name	name	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Service Type	addon	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Product Type	type	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producttype.doc.html
	Integration Type	referable	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Usage Model	usageType	https://d1f7kt971hq16q.cloudfront.net/api/graphql/usagetype.doc.html
	Revenue Model		See Pricing
	Product is stackable	allowMultiplePurchases	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html

Profile & Branding related fields

Location	Field name	GraphQL Field	Schema Reference
Listing Info - Basic information	Company name	vendorName	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Product name	name	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	5 word description	shortDescription	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Brief Overview and SEO Description	description	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Starting Price		See Pricing
Listing Info - Currencies	Marketplace Currencies		See Pricing
	Network Currencies		See Pricing
Listing Info - Legal	Link to Privacy Policy	privacyPolicyLink	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	Link to Terms and Conditions	termsAndConditionsLink	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
Listing Info - Logos	App listing logo	listingLogo [READ-ONLY]	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
	App profile logo	profileLogo [READ-ONLY]	https://d1f7kt971hq16q.cloudfront.net/api/graphql/product.doc.html
Listing Info - Categorization	Attributes	Available REST API	See Marketplace product settings
	Categories	Available REST API	See Marketplace product settings

Location	Field name	GraphQL Field	Schema Reference
Profile - Overview	Splash title	overview.splashTitle	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productoverview.doc.html
	Splash description	overview.splashDescription	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productoverview.doc.html
	Overview image	overview.image [READ-ONLY]	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productimage.doc.html
	Embedded Video URL	overview.videoLink	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productoverview.doc.html
	Documentation Link	overview.documentationLink	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productoverview.doc.html
Profile - Screenshots	Screnshots	Coming soon [READ-ONLY]

Location	Field name	GraphQL Field	Schema Reference
Profile - Benefits	Benefits title	benefits[x].title	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productbenefit.doc.html
	Benefits description	benefits[x].description	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productbenefit.doc.html
Profile - Custom attributes	Product Custom Attributes	Coming soon

Location	Field name	GraphQL Field	Schema Reference
Features - Feature Information	Title	features[x].title	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeature.doc.html
	Slogan	features[x].slogan	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeature.doc.html
	Description	features[x].description	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeature.doc.html
	Position	features[x].position	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeature.doc.html
	Image	Coming soon

Location	Field name	GraphQL Field	Schema Reference
Features - Feature Characteristics	Characteristics position	features[x].characteristics[y].position	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeaturecharacteristic.doc.html
	Characteristics title	features[x].characteristics[y].title	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeaturecharacteristic.doc.html
	Move above picture	features[x].characteristics[y].isDisplayedAbovePicture	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeaturecharacteristic.doc.html
	Description Highlight - Description	features[x].characteristics[y].highlights[z].description	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeaturecharacteristichighlight.doc.html
	Description Highlight - Show checkmark	features[x].characteristics[y].highlights[z].isCheckmarkDisplayed	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productfeaturecharacteristichighlight.doc.html

Location	Field name	GraphQL Field	Schema Reference
Customers & Media - Companies	Company	Coming soon
Customers & Media - Articles & Reviews	Media source	media[x].source	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productmedia.doc.html
	Link	media[x].link	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productmedia.doc.html
	Quote or description	media[x].description	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productmedia.doc.html

Location	Field name	GraphQL Field	Schema Reference
Support	Support phone number	support.phoneNumber	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productsupport.doc.html
	Support email address	support.emailAddress	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productsupport.doc.html
	Knowledge base/Help center URL	support.helpCenterUrl	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productsupport.doc.html
	Support details	support.details	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productsupport.doc.html

Editions and Pricing related fields

Location	Field name	GraphQL Field	Schema Reference
Editions	Name	editions[x].name	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productedition.doc.html
	Edition Code	editions[x].code	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productedition.doc.html
	Target Audience	Not available	See Editions
	Position	Not available	See Editions
	Purchase Options	Not available	See Editions
Editions - Legal	Link to Privacy Policy	editions[x].legalAndCompliance.privacyUrl	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producteditionlegalandcompliance.doc.html
	Link to Terms and Conditions	editions[x].legalAndCompliance.termsAndConditionsUrl	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producteditionlegalandcompliance.doc.html
Editions - Payment Plans		editions[x].pricing	https://d1f7kt971hq16q.cloudfront.net/api/graphql/editionpricing.doc.html
Editions - Features and Benefits	Text	editions[x].features[y].title	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producteditionfeature.doc.html
	Additional Information	editions[x].features[y].description	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producteditionfeature.doc.html
Shared Features & Footnotes	Shared features	editionSharedInformation.features	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producteditionsharedinformationinput.doc.html
	Footnotes	editionSharedInformation.footnotes	https://d1f7kt971hq16q.cloudfront.net/api/graphql/producteditionsharedinformationinput.doc.html
Marketplace Pricing			See Custom pricing guide

Integration related fields

Location	Field name	GraphQL Field	Schema Reference
Credentials - Inbound Credentials	various	integration.inboundClientId
Credentials - Outbound Credentials	various	integration.outboundCredentials	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productintegrationoutboundcredentials.doc.html
Edit Integration	various	integration	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productintegration.doc.html
Edit Authentication	various	integration.singleSignOnConfigurations	https://d1f7kt971hq16q.cloudfront.net/api/graphql/productintegrationsinglesignonconfiguration.doc.html
Run Ping Tests	various		https://d1f7kt971hq16q.cloudfront.net/api/graphql/triggerproductintegrationpingtest.doc.html

Pricing

Revenue model, starting price, marketplace currencies, network currencies are encapsulated within the Pricing APIs, refer to: https://d1f7kt971hq16q.cloudfront.net/api/graphql/createpricingplan.doc.html and https://d1f7kt971hq16q.cloudfront.net/api/graphql/updatepricingplan.doc.html.

Marketplace product settings

You can configure a product's categories and attributes using the REST APIs if you have the ROLE_CHANNEL_ADMIN scope. Also, you can configure only for the published products.

For more details about Marketplace product settings and the publication process, refer to: https://developer.appdirect.com/user-guides/product-information/graphql-api/publish.