We've launched a new documentation site. Visit docs.portal.io for the latest version.
logo
Powered by Redocly

Catalog

**These endpoints require separate authorization**

The Catalog service provides access to all items in the Portal catalog, including information about their MSRP, cost, sell prices and suppliers.

Search & Get Catalog Items

Searches the catalog using the provided category, brand, supplier, industry, stock, favorite, price, and item type filters. CategoryId and CategoryIds are mutually exclusive, and ParentCategoryId and ParentCategoryIds are mutually exclusive. If SearchText is omitted it is treated as an empty string. ItemType defaults to Part.

Request
query Parameters
SearchText
string
ParentCategoryId
integer <int32>
ParentCategoryIds
Array of integers <int32>
CategoryId
integer <int32>
CategoryIds
Array of integers <int32>
Brands
Array of strings
Suppliers
Array of strings
Industries
Array of integers <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
InUseOnly
boolean
header Parameters
Accept
required
string

Accept Header

Value: "application/json"
X-MSS-API-APPID
required
string

Application Id

X-MSS-CUSTOM-DATE
required
string

A date timestamp of the request

X-MSS-SIGNATURE
required
string

A signature for the request

X-MSS-API-USERKEY
required
string

User API Key

Responses
200

Success

Response Schema: application/json
Array of objects (PublicBrowsePartModel)

Catalog part items matching the search criteria

Array of objects (PublicBrowsePartModel)

Favorite catalog part items matching the search criteria

Array of objects (PublicFacetModel)

Category facet values with result counts

Array of objects (PublicFacetModel)

Brand facet values with result counts

Array of objects (PublicFacetModel)

Supplier facet values with result counts

totalItemCount
required
integer <int32>

Total number of matching results across all pages

processingTimeMS
required
integer <int32>

Search processing time in milliseconds

favoriteItemCount
required
integer <int32>

Total number of favorite items matching the search criteria

Array of objects (LibraryModel)

Labor library items matching the search criteria

Array of objects (PublicLibraryModel)

Custom library items matching the search criteria

401

Not Authorized to access this endpoint or your HMAC hash was incorrect.

402

This action requires an active subscription.

403

You do not have permission for this API call.

500

Internal error.

get/public/catalog
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "favoriteItems": [
    ],
  • "categoryFacets": [
    ],
  • "brandFacets": [
    ],
  • "supplierFacets": [
    ],
  • "totalItemCount": 0,
  • "processingTimeMS": 0,
  • "favoriteItemCount": 0,
  • "labors": [
    ],
  • "customItems": [
    ]
}
Category List
Returns the catalog category hierarchy grouped by industry, including category image URLs when available.


Request 
header Parameters
Accept
required
string
Accept Header


 Value: "application/json"  
X-MSS-API-APPID
required
string
Application Id


 
X-MSS-CUSTOM-DATE
required
string
A date timestamp of the request


 
X-MSS-SIGNATURE
required
string
A signature for the request


 
X-MSS-API-USERKEY
required
string
User API Key


 
Responses 
200
A catalog response


Response Schema: application/json
 Array 
id
required
integer <int32> 
Unique numeric identifier of the industry


 
name
required
string
Industry display name


 
Array of objects (PublicCategoryItemResponse) 
Categories returned for the industry


 
401
Not Authorized to access this endpoint or your HMAC hash was incorrect.


402
This action requires an active subscription.


403
You do not have permission for this API call.


500
Internal error.


get/public/catalog/categories
Request samples 
Response samples 
application/json
[
  • {
    }
]
Get Catalog Item Details
Returns details for the requested catalog item. When ItemType is Labor or CustomItem, the item is returned from the current account's library; otherwise a standard catalog item is returned. ExtendedDetails adds extra information to standard catalog item responses.


Request 
path Parameters
ItemId
required
integer <int32> 
Item Id


 
query Parameters
ExtendedDetails
boolean
Provides additional details like full description, specs, linked resources


 
ItemType
string
 
header Parameters
Accept
required
string
Accept Header


 Value: "application/json"  
X-MSS-API-APPID
required
string
Application Id


 
X-MSS-CUSTOM-DATE
required
string
A date timestamp of the request


 
X-MSS-SIGNATURE
required
string
A signature for the request


 
X-MSS-API-USERKEY
required
string
User API Key


 
Responses 
200
Success


Response Schema: application/json
description
string
Long description of the catalog item


 
productUrl
string
Portal product page URL when available


 
manufacturerProductUrl
string
Manufacturer product page URL when available


 
additionalImageUrls
Array of strings
Additional image URLs for the catalog item


 
Array of objects (LinkResource) 
Linked PDF resources for the catalog item


 
Array of objects (LinkResource) 
Linked video resources for the catalog item


 
Array of objects (PublicSpecDetailsModel) 
Specification name/value pairs for the catalog item


 
Array of objects (PublicSupplierInfoModel) 
Supplier-specific entries for this catalog item, limited to the suppliers your company is linked to. isDefault marks your company's default supplier for the item, cost is left out when your account has no cost for that supplier, and isInStock is false when stock is not available to your account.


 
id
required
integer <int32> 
Unique part identifier.


 
brand
string
Brand or manufacturer name.


 
model
string
Model number.


 
shortDescription
string
Short description shown in search results.


 
primaryImageUrl
string
Primary image URL for the catalog item.


 
parentCategoryId
required
integer <int32> 
Parent category identifier.


 
categoryId
required
integer <int32> 
Leaf category identifier.


 
categories
required
Array of strings
Category breadcrumb or category labels associated with the item.


 
isFavorite
required
boolean
Whether the item is marked as a favorite for the authenticated account.


 
isDiscontinued
required
boolean
Whether the item is discontinued.


 
object (PublicMsrpModel) 
MSRP information returned for a catalog item.


 
object (PublicSupplierPriceModel) 
Supplier-specific cost information for a catalog item.


 
object (PublicSellPriceModel) 
Sell-price information returned for a catalog item.


 
rank
integer <int32> 
Item rank within the search result ordering.


 
204
The requested item doesn't exist


401
Not Authorized to access this endpoint or your HMAC hash was incorrect.


402
This action requires an active subscription.


403
You do not have permission for this API call.


get/public/catalog/{ItemId}
Request samples 
Response samples 
application/json
{
  • "description": "string",
  • "productUrl": "string",
  • "manufacturerProductUrl": "string",
  • "additionalImageUrls": [
    ],
  • "pdfResourceLinks": [
    ],
  • "videoResourceLinks": [
    ],
  • "specs": [
    ],
  • "suppliers": [
    ],
  • "id": 0,
  • "brand": "string",
  • "model": "string",
  • "shortDescription": "string",
  • "primaryImageUrl": "string",
  • "parentCategoryId": 0,
  • "categoryId": 0,
  • "categories": [
    ],
  • "isFavorite": true,
  • "isDiscontinued": true,
  • "msrp": {
    },
  • "defaultCost": {
    },
  • "sellPrice": {
    },
  • "rank": 0
}
➔ Next to Users