Skip to main content
GET
Returns the complete record for a single catalog item. By default this includes pricing, category data, and supplier information. Pass ExtendedDetails=true to also receive the full long description, technical specifications, linked PDF and video resources, and additional image URLs. When ItemType is Labor or CustomItem, the item is sourced from your account’s private library rather than the shared catalog.
The Catalog endpoints require separate authorization. Contact your Portal.io representative to confirm your account has catalog API access enabled.
A 204 response (not 404) is returned when the ItemId does not match any catalog item. Check for this status code in your error handling logic.

Authorizations

X-MSS-API-APPID
string
header
required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY
string
header
required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE
string
header
required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE
string
header
required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Path Parameters

ItemId
null | integer<int32>
required

Item Id

Query Parameters

ExtendedDetails
boolean

Provides additional details like full description, specs, linked resources

ItemType
enum<string>
Available options:
Part,
Labor,
CustomItem,
Fee

Response

Success

Full catalog item detail model

id
integer<int32>
required

Unique part identifier.

parentCategoryId
integer<int32>
required

Parent category identifier.

categoryId
integer<int32>
required

Leaf category identifier.

categories
string[]
required

Category breadcrumb or category labels associated with the item.

isFavorite
boolean
required

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

isDiscontinued
boolean
required

Whether the item is discontinued.

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.

msrp
PublicMsrpModel · object

MSRP information returned for a catalog item.

defaultCost
PublicSupplierPriceModel · object

Supplier-specific cost information for a catalog item.

sellPrice
PublicSellPriceModel · object

Sell-price information returned for a catalog item.

rank
integer<int32>

Item rank within the search result ordering.

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
string[]

Additional image URLs for the catalog item

Linked PDF resources for the catalog item

Linked video resources for the catalog item

specs
PublicSpecDetailsModel · object[]

Specification name/value pairs for the catalog item

suppliers
PublicSupplierInfoModel · object[]

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.