Catalog overview
What the Catalog API does, prerequisites, quick start, common use cases, and errors.
Overview
The Catalog API looks up Samtec parts by exact part number, by the first characters of a part number, or by bulk export — returning current pricing, stock quantity, packaging, environmental compliance, and related-part data for each result. Use it to power a part-detail page, keep local inventory data in sync, or feed part data into your own procurement or design tools.
Three versions exist. V1 is deprecated and will be removed after remaining users migrate. V2 deprecated virtualStockQuantity in favor of stockQuantity. V3 — the version documented here — improved the underlying paging mechanism for faster traversal of the full catalog. See What's New for the V3 migration notice if you're still on V1 or V2.
Prerequisites
Every request needs two headers:
| Header | Value |
|---|---|
Authorization | Bearer <your token> |
client-app-name | 3–100 characters identifying your application |
See Authentication if you don't have a token yet. All Samtec APIs, including Catalog, are limited to 1,000 requests per second.
Quick start
curl "https://api.samtec.com/catalog/v3/TSW-110-08-T-D" \
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
-H "client-app-name: your-app-name"{
"part": "TSW-110-08-T-D",
"description": "TSW Series, 8 Position, Single Row, Straight, Through Hole, 0.100\" (2.54mm) Pitch, Socket Strip",
"stockQuantity": 184320,
"minimumOrderQuantity": 1,
"currency": "USD",
"price": [
{ "column": 1, "minimumQuantity": 1, "maximumQuantity": 24, "price": 1.42 },
{ "column": 2, "minimumQuantity": 25, "maximumQuantity": 99, "price": 1.08 }
],
"packaging": { "description": "Tube", "standardQuantity": 50, "fullIncrementRequired": false },
"lifecycleStatus": "Production"
}Common use cases
- Part-detail pages. Look up a single part by number (
GET /v3/{part}) to show live pricing, stock, packaging, and compliance data. - Part number lookup-as-you-type. Let a user find a part from the first characters of its part number (
GET /v3/search), with or without dashes. It matches the start of the part number only, not descriptions or keywords. By default it returns just the matching part numbers; setfullResponse=truefor full part details. - Local catalog sync. Page through the full catalog (
GET /v3) to build or refresh a local mirror, then useGET /v3/delta/availabilityafterward to pick up only what changed rather than re-fetching everything. - Bulk export. Download a full catalog or pricing file for offline processing (
GET /v1/export,GET /v1/export/{date}) instead of making one request per part. UsefileTypeOverrideon either endpoint to choose a file type; leave it blank for the default,catalog. File types includecatalog,catalogValid(active parts only),stdlead(standard lead times), and pricing variants (pricing,pricingValid,catalogPricingValid) — pricing types require a currency suffix (e.g.,pricing-USD; supported currencies:USD,EUR,GBP,CNY). Passlatestas the date to get the most recently generated version without looking up the exact date. The download link is time-limited, so fetch the file promptly.
Common errors
| Status | Meaning | How to resolve |
|---|---|---|
| 204 | No data to return — for GET /v3/{part}, the part number is well-formed but nothing is available for it; for GET /v1/export/{date}, no file exists for that date | Not an error; treat it as "not found." |
| 400 | Missing or invalid parameter — an empty part number, an unsupported isoCurrencyCode, or (for search) a missing query | Check the specific message in the response body; it names which parameter failed. |
| 401 | Missing or invalid JWT | See Authentication. |
| 403 | Valid JWT, but it doesn't have Catalog claims | Email apionboarding@samtec.com to request Catalog access. |
| 429 | Rate limit exceeded (1,000 req/s) | Retry with backoff. |
Related APIs
- Lead Time — once you've found a part here, check its next available shipment date before quoting a delivery window.
- Pricing — Catalog's
pricefield is book pricing; use Pricing for customer-specific quantity-break pricing on the same part. - Models — download a 3D model or footprint for any part you find here.
What's next?
- Catalog Reference — every endpoint, parameter, and response schema, with a live playground.
- Catalog Swagger UI — the API's own built-in Swagger page, served directly from the API.
- Lead Time — check when a part you just looked up will ship.
- Pricing — get customer-specific pricing for the same part.