/usbif/products

POST /api/usbif/products

Price: 1 credit

Get one product from the USB-IF certified product list by its TID: the list record — model, company, category paths, speeds, features, port wattage and certification time — plus the device type, product revision, USB specifications supported, USB Type-C role, power rails and cable length and power where the product declares them.

How to use it

Pass the `tid` a usbif/products/search row returned, not that row's `id` — the two numbers differ, and for over 2000 rows the `id` also happens to equal a different row's `tid`, so passing an `id` here does not fail: it silently returns whatever product owns that number as a `tid`. A few TIDs are filed on two list rows, and the answer is the row the registry's own product page describes.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tid string required — The product's TID in the USB-IF certified product list (examples: "16227"; minLength: 1; maxLength: 20; pattern: ^\d+$)

Response

• @type string (default: "UsbifProductDetail")
• id string required
• tid string nullable
• name string nullable
• model_number string nullable
• company_name string nullable
• status string nullable
• segment string nullable
• category string nullable
• cable_marketing_category string nullable
• silicon_marketing_category string nullable
• power_marketing_category string nullable
• e_marker_marketing_category string nullable
• marketing_info string nullable
• connector_type string nullable
• max_speed string nullable
• cable_max_speed string nullable
• connector_max_speed string nullable
• xid string nullable
• total_wattage number nullable
• features array (default: [])
• certified_at integer nullable
• device_type string nullable
• revision string nullable
• marketing_names array (default: [])
• usb4_support array (default: [])
• type_c_role string nullable
• supported_pdos array (default: [])
• pps_voltage_rails array (default: [])
• cable_length number nullable
• cable_power_capability string nullable
• supported_specifications array (default: [])
• connector_tids array (default: [])
• e_marker_tids array (default: [])

Errors

• 422 — The TID is not a number Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No certified product is filed under this TID Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.