Product

List all products

Changed on

This call lists products based on specific parameters such as attribute, category, date, or type.

get/marketplace/v1/listing

Request

Query parameters

anumber[]

Only return products for these attribute ids

approvalAfternumber

Search products published after this date in milliseconds

approvalBeforenumber

Search products published before this date in milliseconds

publishedAfternumber

Filter products last modified after this date (epoch milliseconds). Use with publishedBefore to define a date range.

publishedBeforenumber

Filter products last modified before this date (epoch milliseconds). Use with publishedAfter to define a date range.

cnumber[]

Only return products for these categories

countstring

Limit number of products returned

filterstring[]

Only return products for these characteristics

snumber[]

Only return products for these sub category ids

order'ALPHABETICAL' | 'NEWEST_FIRST' | 'NEWEST_PUBLISHED' | 'POPULARITY' | 'RATING'

Ordering type

plnumber[]
platformstring[]
qstring

Search term used to search on different fields of an product

snumber[]

Only return products for these category ids

startinteger

Start to return product after this offset

typestring[]

Only return product for these product types

vendorstring[]

Only return products for the specified vendor IDs

localestring

Specify the locale context

Response

List of products

addonboolean

Is an add-on product

billingFrequencystring

Billing frequency

blurbstring nullable

Short description

bundleUrlstring[]

List of bundle URLs

buyableboolean

Is buyable

collectLeadsboolean

Collect lead

descriptionstring nullable

Description

developerNamestring

Developer name

downloadFileSizenumber nullable

Download file size for downloadable product

featuredboolean

Is featured

featuredSliderPositionnumber nullable

Featured slider position

freeboolean

Is free

freeTrialOrEditionPresentboolean

Is free trial or edition present

hasLyncToPhoneboolean

Has lync to phone add-on

hidePricingsboolean

Hide pricings

hrefstring

URL to get product detail

iconSrcsetobject

Icon Srcset

iconUrlstring nullable

Icon URL

idnumber

ID

languagestring[]

List of supported languages

lastModifiednumber

Last modified date

namestring

Name

numRatingsnumber nullable

Number of ratings

overviewstring nullable

Overview

overviewImageSrcsetobject

Overview image Srcset

overviewImageUrlstring nullable

Overview image URL

popularboolean

Is populare

popularitynumber nullable

Poplarity rank

productTypestring

Product type

profileLogoSrcsetobject

Profile logo Srcset

profileLogoUrlstring nullable

Profile logo URL

publishedOnnumber

Publication date

ratingnumber nullable

User-submitted total rating

referableboolean

Is a referable product

showRatingboolean

Must show the rating

sortRanknumber

Sort rank

staffPickboolean

Is staff pick

staffPickSliderPositionnumber nullable

Staff pick slider position

startingPricestring

Starting price

urlstring nullable

URL to product profile

uuidstring

Unique identifier

vendorNamestring

Vendor company name

Example response

[
  {
    "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