Skip to main content
GET
/
public
/
catalog
curl -i -X GET \
  'https://api.portal.io/public/catalog?SearchText=receiver&PageNumber=1&PageSize=10' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'
{
  "items": [
    {
      "id": 8821,
      "brand": "Denon",
      "model": "AVR-X3800H",
      "shortDescription": "9.4-Channel 105W 8K AV Receiver",
      "primaryImageUrl": "https://images.portal.io/catalog/8821/primary.jpg",
      "parentCategoryId": 12,
      "categoryId": 47,
      "categories": ["Audio", "AV Receivers"],
      "isFavorite": false,
      "isDiscontinued": false,
      "msrp": {
        "msrpUsd": 1299.00,
        "value": 1299.00,
        "regularValue": 1299.00,
        "isCustom": false,
        "currency": { "code": "USD", "symbol": "$" },
        "lastModifiedDate": "2026-01-15T00:00:00Z"
      },
      "defaultCost": {
        "supplierName": "D&H Distributing",
        "supplierSku": "AVR-X3800H",
        "value": 975.00,
        "isInStock": true,
        "isPromo": false,
        "currency": { "code": "USD", "symbol": "$" }
      }
    }
  ],
  "totalItemCount": 1,
  "processingTimeMS": 42,
  "favoriteItemCount": 0,
  "favoriteItems": [],
  "categoryFacets": [
    { "value": "AV Receivers", "count": 1 }
  ],
  "brandFacets": [
    { "value": "Denon", "count": 1 }
  ],
  "supplierFacets": [
    { "value": "D&H Distributing", "count": 1 }
  ],
  "labors": [],
  "customItems": []
}
The Catalog search endpoint provides full access to the Portal.io catalog with rich filtering options. You can narrow results by free-text search, category hierarchy (CategoryId, CategoryIds, ParentCategoryId, ParentCategoryIds), brand, supplier, industry, price range, stock availability, favorites, and item type. CategoryId and CategoryIds are mutually exclusive, as are ParentCategoryId and ParentCategoryIds. When SearchText is omitted it is treated as an empty string. ItemType defaults to Part.
The Catalog endpoints require separate authorization. Contact your Portal.io representative to confirm your account has catalog API access enabled.
curl -i -X GET \
  'https://api.portal.io/public/catalog?SearchText=receiver&PageNumber=1&PageSize=10' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'
{
  "items": [
    {
      "id": 8821,
      "brand": "Denon",
      "model": "AVR-X3800H",
      "shortDescription": "9.4-Channel 105W 8K AV Receiver",
      "primaryImageUrl": "https://images.portal.io/catalog/8821/primary.jpg",
      "parentCategoryId": 12,
      "categoryId": 47,
      "categories": ["Audio", "AV Receivers"],
      "isFavorite": false,
      "isDiscontinued": false,
      "msrp": {
        "msrpUsd": 1299.00,
        "value": 1299.00,
        "regularValue": 1299.00,
        "isCustom": false,
        "currency": { "code": "USD", "symbol": "$" },
        "lastModifiedDate": "2026-01-15T00:00:00Z"
      },
      "defaultCost": {
        "supplierName": "D&H Distributing",
        "supplierSku": "AVR-X3800H",
        "value": 975.00,
        "isInStock": true,
        "isPromo": false,
        "currency": { "code": "USD", "symbol": "$" }
      }
    }
  ],
  "totalItemCount": 1,
  "processingTimeMS": 42,
  "favoriteItemCount": 0,
  "favoriteItems": [],
  "categoryFacets": [
    { "value": "AV Receivers", "count": 1 }
  ],
  "brandFacets": [
    { "value": "Denon", "count": 1 }
  ],
  "supplierFacets": [
    { "value": "D&H Distributing", "count": 1 }
  ],
  "labors": [],
  "customItems": []
}

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json
X-MSS-API-APPID
string
required

Application Id

X-MSS-CUSTOM-DATE
string
required

A date timestamp of the request

X-MSS-SIGNATURE
string
required

A signature for the request

X-MSS-API-USERKEY
string
required

User API Key

Query Parameters

SearchText
string
ParentCategoryId
integer<int32>
ParentCategoryIds
integer<int32>[]
CategoryId
integer<int32>
CategoryIds
integer<int32>[]
Brands
string[]
Suppliers
string[]
Industries
integer<int32>[]
IsInStock
boolean
IsFavorite
boolean
IsAuthorized
boolean
IsDiscontinued
boolean
IsIndustrialFavorite
boolean
MinMsrp
number<double>

Filter for products with an MSRP (of the users current country currency. If it doesn't exist then USD MSRP is used.) greater than this amount.

MaxMsrp
number<double>

Filter for products with an MSRP (of the users current country currency. If it doesn't exist then USD MSRP is used.) less than this amount.

PageNumber
integer<int32>
PageSize
integer<int32>

Limit the number of results

IncludeImageUrl
boolean
ItemType
string

Response

Success

Catalog search response

totalItemCount
integer<int32>
required

Total number of matching results across all pages

processingTimeMS
integer<int32>
required

Search processing time in milliseconds

favoriteItemCount
integer<int32>
required

Total number of favorite items matching the search criteria

items
PublicBrowsePartModel · object[]

Catalog part items matching the search criteria

favoriteItems
PublicBrowsePartModel · object[]

Favorite catalog part items matching the search criteria

categoryFacets
PublicFacetModel · object[]

Category facet values with result counts

brandFacets
PublicFacetModel · object[]

Brand facet values with result counts

supplierFacets
PublicFacetModel · object[]

Supplier facet values with result counts

labors
LibraryModel · object[]

Labor library items matching the search criteria

customItems
PublicLibraryModel · object[]

Custom library items matching the search criteria