/jpportal/suppliers/search

POST /api/jpportal/suppliers/search

Price: 10 credits

Search the Japanese government unified business register on the p-portal by business name, corporate number, head office address, legal form, company scale, qualification grade, bid region, qualification kind and business item. Each row is the corporate number, name, its kana reading and the head office address.

How to use it

The source serves at most the first 500 matches of a query. Pass a row's `id` to jpportal/suppliers for the representative, business type, qualification and award history.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string nullable — Words in the business name (examples: "トヨタ"; minLength: 1)
• corporate_number string nullable — Corporate number (examples: "4180001109208"; minLength: 13; maxLength: 13)
• address string nullable — Words in the head office address (examples: "名古屋市"; minLength: 1)
• company_scale array nullable — Company scales of the qualification (one of: "large", "medium_small", "small", "other", "new_small"; examples: ["large"])
• qualification_grade array nullable — Qualification grades (one of: "A", "B", "C", "D"; examples: ["A","B"])
• bid_region array nullable — Regions the business may bid in (one of: "hokkaido", "tohoku", "kanto_koshinetsu", "tokai_hokuriku", "kinki", "chugoku", "shikoku", "kyushu_okinawa"; examples: ["kinki"])
• qualification_kind array nullable — Qualification kinds, any business item within them (one of: "goods_manufacturing", "goods_sales", "services", "goods_purchase"; examples: ["services"])
• business_item array nullable — Business item codes of the qualification (examples: ["304","306"])
• corporation_type array nullable — Legal forms; not combinable with the qualification filters (one of: "kabushiki_kaisha", "yugen_kaisha", "partnership_company", "other_registered_corporation", "foreign_company", "national_agency", "local_government", "other"; examples: ["kabushiki_kaisha"])
• count integer required — Max number of businesses to return (min: 1; max: 500)

Response

• @type string (default: "JpportalSupplierListing")
• id string required
• name string nullable
• name_kana string nullable
• address string nullable

Errors

• 422 — The request body did not validate 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 — The entity was not found, or a precondition failed 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.