/omantender/suppliers/search

POST /api/omantender/suppliers/search

Price: 5 credits

Search the suppliers registered with the Oman Tender Board (etendering.tenderboard.gov.om) by company name, registration number, registered category, sub-category and grade, and company type. Each row carries the company name, Tender Board or commercial registration number, address, phone, fax, registered category, registration expiry date and company type.

How to use it

Pass a row's `id` to omantender/suppliers for every category, sub-category and grade the company is registered in; rows without an `id` have no activity record. `subcategory` is a code inside `category` (602, cleaning, under Z6) and `grade` narrows a sub-category.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• name string nullable — Word in the company name (examples: "الخليج"; minLength: 1)
• registration_number string nullable — Tender Board or commercial registration number (examples: "00013962"; minLength: 1)
• category string nullable — Registered procurement category (one of: "Z1", "Z2", "Z3", "Z4", "Z5", "Z6", "Z7", "Z8", "C1", "C2", "T1", "I1")
• subcategory string nullable — Registered sub-category code (examples: "602"; minLength: 1)
• grade string nullable — Registered grade (one of: "1", "2", "3", "4", "5")
• company_type string nullable — Company type (one of: "0", "1", "2", "3", "6", "7")
• count integer required — Max number of suppliers to return (min: 1; max: 2000)

Response

• @type string (default: "OmantenderSupplierSummary")
• id string nullable
• name string nullable
• registration_number string nullable
• address string nullable
• phone string nullable
• fax string nullable
• registered_category array (default: [])
• registration_expiry_date string nullable
• company_type 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.