Skip to main content
POST
Check parts

Authorizations

X-API-Key
string
header
required

Your ProvenMetal API key (pm_live_...). Authorization: Bearer <key> also works.

Body

application/json

A part list (or a BOM file's text) and how many boards will be built.

boards
integer
required

How many boards will be built.

Required range: 1 <= x <= 100000
parts
DesignPart · object[] | null

The BOM lines (at most 300): reference, quantity per board, and mpn with manufacturer, or lcsc, or value with footprint for a resistor, capacitor or inductor. digikey, mouser and description help.

bom_csv
string | null

A BOM file's text, instead of parts.

wait_s
integer
default:20

Seconds to wait for the distributors' answer. 0 returns JLCPCB's answer at once (about two seconds); the default covers most boards.

Required range: 0 <= x <= 50
itar
boolean
default:false

true if the design is ITAR-controlled: it is refused before anything is read.

Response

Successful Response

ok
boolean
required
phase
enum<string>
required

jlcpcb: JLCPCB's stock only so far; complete: distributors too.

Available options:
jlcpcb,
complete
boards
integer
required
parts
Parts · object[]
required

Each part: reference, part, quantity_per_board, verdict (ok, check, problem, checking), source, jlcpcb_code, jlcpcb_library, supplier, cost_usd (for the whole build), stock, lead_time_days, lifecycle, why, similar_part.

summary
Summary · object
required
retry_after_s
integer | null

Parts still checking: send the same check again then.