How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AppDirect Marketplace Product Settings API

The Marketplace Product Settings API from AppDirect — 4 operation(s) for marketplace product settings.

AppDirect Marketplace Product Settings API is one of 75 APIs that AppDirect publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Marketplace Product Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 4 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version v296.0-SNAPSHOT.

Requests are made against 2 base URLs: https://marketplace.appdirect.com/api, https://virtserver.swaggerhub.com.

5 operations 4 paths 39 schemas 3 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v296.0-SNAPSHOT
Base URL
https://marketplace.appdirect.com/api
Resource Areas
1

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Marketplace Product Settings 5
GET
/v3/marketplaceProduct/activeSettings/{productId}
Retrieve active settings for a given marketplace
resource_Product_Active_Setting_readSettings_GET 1 param → 200401404500
GET
/v3/marketplaceProduct/productSettings/{productId}
Retrieve product settings on a given marketplace
resource_Product_Setting_readSettings_GET 1 param → 200401404500
PUT
/v3/marketplaceProduct/productSettings/{productId}
Update product settings on a given marketplace
resource_Product_Setting_updateSettings_PUT 2 params body → 200401404500
GET
/v3/marketplaceProduct/productSettings/readByRefId/{productRefId}
Retrieve product settings on a given marketplace by product reference ID
resource_Product_Setting_readSettingsByRefId_GET 1 param → 200401404500
PUT
/v3/marketplaceProduct/productSettings/updateByRefId/{productRefId}
Update product settings on a given marketplace by product reference ID
resource_Product_Setting_updateSettingsByRefId_PUT 1 param body → 200401404500

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are MarketplaceProductSettingActiveComponentsWS (30 properties), AvailabilitySettingsWS (10 properties), SettingValidationWS (8 properties), ProductGroupsWS (6 properties). Each schema is shown below with its type and property counts.

CategorySelectionsWS
object
Information about the tooltip, attribute, and list of categories associated to the product.
4 properties
SubCategoryOptionWS
object
Subcategories further refine the categories to make it easier for users to find or filter the products.
2 properties
EditionPricingItemSkuWS
object
Payment plans for an edition and related SKUs.
3 properties
SkuWS
object
Information about SKUs associated with a payment plan for the edition.
4 properties
MarketplaceProductSettingsWS
object
Product setting information
4 properties
MarketplaceProductSettingActiveComponentsWS
object
Information about the active component for product setting UI on marketplace.
30 properties
BillingCycleStartDayOption
string
Billing cycle start day options.
MerchandisingOptionsWS
object
Information about the badges and ribbons added to the product.
2 properties
CategoryOptionWS
object
Customers can filter products by category.
3 properties
UserAttributeChoiceWS
object
Customer group options available for the product.
5 properties
Segments
object
A characteristic shared by segment group members
2 properties
MerchandisingBadgeSelectionsWS
object
Information about promotional image badges available for the product.
2 properties
MerchandisingRibbonSelectionWS
object
Information about promotional text ribbons available for the product.
2 properties
CustomSettingWS
object
Details of the custom settings for the product. The custom setting value can be string or boolean.
3 properties
MerchandisingBadgeOptionWS
object
Information about the badge option for this product.
4 properties
SegmentSelection
object
Information about segment groups and segments
2 properties
BillingSettingsWS
object
Information related to billing settings for the product.
5 properties
ProductInformationWS
object
Information about the product, such as the name, icon URL, and if it is a network product.
3 properties
MerchandisingRibbonOptionWS
object
Details of the ribbon option for the product.
4 properties
ApiHealthMaintenanceSettingsWS
object
Information about API maintenance that includes assign/unassign users, update subscription, single sign-on product and purchase product.
4 properties
CategoryChoiceWS
object
Information about categories for the product.
2 properties
WorkingEndpointWS
object
Information about the API endpoints availability.
3 properties
ProductLineChoiceWS
object
Product lines are used to promote a specific developer or a specific product type. It organizes products on their own listing page which can be included as a l…
3 properties
SettingValidationWS
object
Information about the validation applied to a setting.
8 properties
SortingRankWS
object
The ranking of the product in numerical order. Products with a higher rank appear above those with a lower rank on the marketplace homepage and in search resul…
2 properties
IndustryChoiceWS
object
Details of industry choice options.
3 properties
AttributeChoiceWS
object
Attributes are inherent characteristics of a product. To find the products that best meet their needs, customers can filter products by the attributes that you…
4 properties
BillingCycleOptionsWS
object
Information regarding the billing cycle of the product.
3 properties
AvailabilitySettingsWS
object
Allow specific information to appear on the product profile page and whether customers can purchase the product or submit lead information.
10 properties
SkuSettingsWS
object
Information regarding the SKUs for the product.
2 properties
CollectLeadsOptions
string
Lead options include In Addition to Purchase or Instead of Purchase.
FreeTrialEditionWS
object
These settings impact the billing information and conversion requirements for free trials.
4 properties
CompanyGroups
object
Segment group and segments
3 properties
BillingWS
object
Information about the billing settings, free trials, billing patterns, or SKU settings of the product.
3 properties
CollectLeadsWS
object
Information about the lead is collected, such as first name, last name, email, and so on.
4 properties
AttributeOptionChoiceWS
object
Details about the attribute option.
3 properties
ProductGroupsWS
object
Information about the tooltip, attribute, and list of categories associated to the product.
6 properties
GeneralSettingsWS
object
Information about the availability of the product, API health maintenance, and additional settings.
3 properties
AdditionalSettingsWS
object
Information about additional settings for a product.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

appdirect-marketplace-product-settings-api-openapi.yml Raw ↑

Other APIs AppDirect publishes across the network.

AppDirect AI Embed API
AppDirect AI Management API
AppDirect AI Models API
AppDirect AI User Inputs API
AppDirect Answer API
AppDirect API Keys API
AppDirect AppResellerAccount API
AppDirect AppResellerAssignment API
AppDirect AppResellerCatalog API
AppDirect AppResellerCompanyAssociation API
AppDirect AppResellerLeads API
AppDirect AppResellerOpportunities API
Where this information came from

This is an independent, third-party profile of AppDirect Marketplace Product Settings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.