APappdirect
Marketplace Product Settings

Retrieve active settings for a given marketplace

Changed on

Retrieve the settings, sections, tabs that should be visible to end user on the marketplace product settings UI for a given marketplace.

get/v3/marketplaceProduct/activeSettings/{productId}

Request

Path parameters

productIdinteger required

The product identifier

Response

Success

showSettingsContainerboolean

Indicates whether settings are visible in UI.

showVisibleOnNetworkboolean

Indicates whether Visible On Network setting is visible in UI.

showVisibleOnMarketplaceboolean

Indicates whether Visible On Marketplace setting is visible in UI.

showSellDomainAsStandaloneboolean

Indicates whether Sell Domain As Standalone setting is visible in UI.

showAsComingSoonboolean

Indicates whether Coming Soon setting is visible in UI.

showCollectLeadsboolean

Indicates whether Collect Leads setting is visible in UI.

showCompanyGroupSegmentsContainerboolean

Indicates whether the segment group container is visible in the user interface

showHideAllPricingboolean

Indicates whether Hide All Pricing setting is visible in UI.

showDisableSelfServiceboolean

Indicates whether Disable Self Service setting is visible in UI.

showTermsOfServiceURLboolean

Indicates whether Terms Of Service URL setting is visible in UI.

showSortingRankboolean

Indicates whether Sorting Rank setting is visible in UI.

showAdditionalSettingsContainerboolean

Indicates whether Additional Settings are visible in UI.

showAPIHealthMaintenanceContainerboolean

Indicates whether API health maintenance settings are visible in UI.

showSKUsContainerboolean

Indicates whether SKUs settings are visible in UI.

showFID1Numberboolean

Indicates whether FID1Number setting is visible in UI.

showProductTabboolean

Indicates whether Product Tab is visible in UI.

showCategoriesContainerboolean

Indicates whether Categories settings are visible in UI.

showAttributesContainerboolean

Indicates whether Attributes settings are visible in UI.

showProductLinesContainerboolean

Indicates whether Product Lines settings are visible in UI.

showCustomerGroupsContainerboolean

Indicates whether Customer Groups settings are visible in UI.

showMerchandisingOptionsContainerboolean

Indicates whether Merchandising Options settings are visible in UI.

showBillingTabboolean

Indicates whether Billing Tab is visible in UI.

showBillingSettingsContainerboolean

Indicates whether Billing settings are visible in UI.

showSkipFirstPaymentboolean

Indicates whether Skip First Payment setting is visible in UI.

showTaxCodeboolean

Indicates whether Tax Code setting is visible in UI.

showSetupFeeTaxCodeboolean

Indicates whether Setup Fee Tax Code setting is visible in UI.

showBillingCycleStartDayboolean

Indicates whether Billing Cycle Start Day setting is visible in UI.

showFreeTrialBillingOptionsContainerboolean

Indicates whether Free Trial Billing Options settings are visible in UI.

showBillingPatternsContainerboolean

Indicates whether Billing Patterns settings are visible in UI.

Example response

{
  "productInformation": {
    "productName": "AUTO_WEBAPP_NEW",
    "appFromNetwork": false
  },
  "showSettingsContainer": true,
  "showVisibleOnNetwork": true,
  "showVisibleOnMarketplace": true,
  "showSellDomainAsStandalone": false,
  "showAsComingSoon": true,
  "showCollectLeads": true,
  "showCompanyGroupSegmentsContainer": true,
  "showHideAllPricing": true,
  "showDisableSelfService": false,
  "showTermsOfServiceURL": false,
  "showSortingRank": true,
  "showAdditionalSettingsContainer": false,
  "showAPIHealthMaintenanceContainer": true,
  "showSKUsContainer": false,
  "showFID1Number": false,
  "showProductTab": true,
  "showCategoriesContainer": true,
  "showAttributesContainer": true,
  "showProductLinesContainer": true,
  "showCustomerGroupsContainer": true,
  "showMerchandisingOptionsContainer": true,
  "showBillingTab": true,
  "showBillingSettingsContainer": true,
  "showSkipFirstPayment": false,
  "showTaxCode": true,
  "showSetupFeeTaxCode": false,
  "showBillingCycleStartDay": false,
  "showFreeTrialBillingOptionsContainer": true,
  "showBillingPatternsContainer": false
}

Changes