{
  "opencollection": "1.0.0",
  "info": {
    "name": "Companies AI Embed Marketplace Product Settings API",
    "version": "v296.0-SNAPSHOT"
  },
  "items": [
    {
      "info": {
        "name": "Marketplace Product Settings",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve active settings for a given marketplace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/v3/marketplaceProduct/activeSettings/:productId",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "The product identifier"
              }
            ]
          },
          "docs": "Retrieve the settings, sections, tabs that should be visible to end user on the marketplace product settings UI for a given marketplace."
        },
        {
          "info": {
            "name": "Retrieve product settings on a given marketplace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/v3/marketplaceProduct/productSettings/:productId",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "The product identifier"
              }
            ]
          },
          "docs": "Retrieve product settings, including product information, general settings, product group, and billing settings for a product on a given marketplace."
        },
        {
          "info": {
            "name": "Update product settings on a given marketplace",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://marketplace.appdirect.com/api/v3/marketplaceProduct/productSettings/:productId",
            "params": [
              {
                "name": "productId",
                "value": "",
                "type": "path",
                "description": "The product identifier"
              },
              {
                "name": "addToCatalog",
                "value": "",
                "type": "query",
                "description": "When true, the product is automatically added to the production catalog if it is not already present. Defaults to false. Callers that intend to publish a product to the catalog (e.g. the Admin UI) should set this to true."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update product settings for a product on a given marketplace. When addToCatalog is set to true, the product will be automatically added to the production catalog if it is not already present."
        },
        {
          "info": {
            "name": "Retrieve product settings on a given marketplace by product reference ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://marketplace.appdirect.com/api/v3/marketplaceProduct/productSettings/readByRefId/:productRefId",
            "params": [
              {
                "name": "productRefId",
                "value": "",
                "type": "path",
                "description": "The product reference identifier"
              }
            ]
          },
          "docs": "Retrieve product settings, including product information, general settings, product group, and billing settings for a product on a given marketplace."
        },
        {
          "info": {
            "name": "Update product settings on a given marketplace by product reference ID",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://marketplace.appdirect.com/api/v3/marketplaceProduct/productSettings/updateByRefId/:productRefId",
            "params": [
              {
                "name": "productRefId",
                "value": "",
                "type": "path",
                "description": "The product reference identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update product settings for a product on a given marketplace. This endpoint does not support automatic addition to the production catalog; use the PUT /{productId} endpoint with the addToCatalog parameter for that behavior."
        }
      ]
    }
  ],
  "bundled": true
}