APappdirect
Product

List all add-on products

Changed on

Lists add-on products visible on the current marketplace. An "add-on" is a separate catalog product linked to a parent product via an AppAssociation of type ADDON. Each entry contains the full add-on product payload (same shape as a /listing entry) plus a reference to the parent product. The parentProductId and parentProductUuid parameters are mutually exclusive — supplying both returns 400 Bad Request.

get/marketplace/v1/addons

Request

Query parameters

startinteger

Pagination offset (0-based). Combined with count, start + count is capped at 10,000.

countinteger

Maximum number of add-ons to return per page. Defaults to 50; capped at 500. Clients performing bulk synchronisation should opt in to a larger page size explicitly (e.g. count=500).

parentProductIdnumber

Filter by parent product numeric ID. Mutually exclusive with parentProductUuid.

parentProductUuidstring

Filter by parent product UUID. Mutually exclusive with parentProductId.

countrystring

Country code, forwarded to product display logic

currencystring

Currency code, forwarded to product display logic

localestring

Locale (e.g. en_US). Falls back to the channel default if not specified.

Response

List of add-on products

Example response

[
  {
    "product": {
      "addon": true,
      "billingFrequency": "...",
      "blurb": "...",
      "bundleUrl": [
        "...",
        "..."
      ],
      "buyable": true,
      "channelStartingPrice": {
        "free": true,
        "freeTrial": true,
        "prices": {
          "property1": {
            "duration": "THREE_YEARS",
            "price": 12345
          },
          "property2": {
            "duration": "THREE_YEARS",
            "price": 12345
          }
        }
      },
      "collectLeads": true,
      "description": "...",
      "developerName": "...",
      "discountDetails": {
        "discountedStartingPrice": "...",
        "highestFixedDiscount": {
          "AUD": 12345,
          "BRL": 12345,
          "CAD": 12345,
          "CHF": 12345,
          "CNY": 12345,
          "DKK": 12345,
          "EUR": 12345,
          "GBP": 12345,
          "GTQ": 12345,
          "INR": 12345,
          "JPY": 12345,
          "KRW": 12345,
          "MXN": 12345,
          "MYR": 12345,
          "NOK": 12345,
          "NZD": 12345,
          "PHP": 12345,
          "SAR": 12345,
          "SEK": 12345,
          "SGD": 12345,
          "USD": 12345,
          "ZAR": 12345
        },
        "highestPercentageDiscount": 12345,
        "startingPricePercentageDiscount": 12345
      },
      "downloadFileSize": 12345,
      "featured": true,
      "featuredSliderPosition": 12345,
      "free": true,
      "freeTrialOrEditionPresent": true,
      "hasLyncToPhone": true,
      "hidePricings": true,
      "href": "...",
      "iconSrcset": {
        "property1": "...",
        "property2": "..."
      },
      "iconUrl": "...",
      "id": 12345,
      "language": [
        "...",
        "..."
      ],
      "lastModified": 12345,
      "name": "...",
      "numRatings": 12345,
      "overview": "...",
      "overviewImageSrcset": {
        "property1": "...",
        "property2": "..."
      },
      "overviewImageUrl": "...",
      "popular": true,
      "popularity": 12345,
      "productRibbon": {},
      "productType": "...",
      "profileLogoSrcset": {
        "property1": "...",
        "property2": "..."
      },
      "profileLogoUrl": "...",
      "publishedOn": 12345,
      "rating": 12345,
      "referable": true,
      "showRating": true,
      "sortRank": 12345,
      "staffPick": true,
      "staffPickSliderPosition": 12345,
      "startingPrice": "...",
      "tag": [
        {
          "badge": "...",
          "description": "...",
          "id": 12345,
          "name": "...",
          "showBadge": true,
          "showOnNavigation": true,
          "tag": [
            {},
            {}
          ],
          "type": "..."
        },
        {
          "badge": "...",
          "description": "...",
          "id": 12345,
          "name": "...",
          "showBadge": true,
          "showOnNavigation": true,
          "tag": [
            {},
            {}
          ],
          "type": "..."
        }
      ],
      "url": "...",
      "uuid": "...",
      "vendorName": "..."
    }
  }
]

Changes