/jpportal/suppliers

POST /api/jpportal/suppliers

Price: 20 credits

One business from the Japanese government unified business register by corporate number: its name, postal code, head office address, representative's title and name, business type, its unified qualification (number, valid fiscal years, company size, grade and business items per qualification kind, bid regions, change history) and every award it won with case number, name, date, amount, organisation and method.

How to use it

Takes the 13-digit corporate number of a jpportal/suppliers/search row or an award winner. A business without a unified qualification comes back with the qualification fields empty.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Corporate number (examples: "4180001109208"; minLength: 13; maxLength: 13)

Response

• @type string (default: "JpportalSupplier")
• id string required
• name string nullable
• postal_code string nullable
• address string nullable
• representative_title string nullable
• representative_name string nullable
• business_type string nullable
• qualification_number string nullable
• qualification_fiscal_years array (default: [])
• company_size string nullable
• qualification_kinds array (default: [])
  • @type string (default: "JpportalQualificationKind")
  • kind string required
  • grade string nullable
  • business_items array (default: [])
• bid_regions array (default: [])
• qualification_changes array (default: [])
  • @type string (default: "JpportalQualificationChange")
  • changed_date string nullable
  • description string nullable
• awards array (default: [])
  • @type string (default: "JpportalSupplierAward")
  • procurement_number string nullable
  • awarded_date string nullable
  • amount number nullable
  • currency string nullable
  • org_name string nullable
  • method string nullable
  • fiscal_year integer 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 register holds no business under that corporate number 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.