/saetenders/tenders

POST /api/saetenders/tenders

Price: 10 credits

One South African public tender as its compiled OCDS release, by eTenders id or ocid: buyer, category, province, procurement method and type, tender period, briefing session, buyer contact, bid documents, the award with its supplier and value once made, and the signed contract with its period, value and documents where the buyer published one.

How to use it

`status` is `active` while the tender is advertised and stays `active` after an award, `complete` once closed and `cancelled` when withdrawn; an award is a non-empty `awards` list, and `contracts` is filled only on the awarded releases whose buyer also published the signed contract. The tender's own `amount` is not published, so it is null; the money is in `awards[].amount` and, when present, `contracts[].amount`. `published_at` equals `released_at` on every release.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — eTenders tender id or its OCDS ocid (examples: "100000", "ocds-9t57fa-171088"; minLength: 1)

Response

• @type string (default: "SaetendersTender")
• ocid string required
• release_id string nullable
• id integer required
• tender_number string nullable
• status string nullable
• category string nullable
• tender_type string nullable
• procurement_method string nullable
• main_procurement_category string nullable
• additional_procurement_categories array (default: [])
• province string nullable
• delivery_location string nullable
• special_conditions string nullable
• buyer object nullable
  • @type string (default: "SaetendersOrganisation")
  • id string nullable
  • name string required
• procuring_entity object nullable
  • @type string (default: "SaetendersOrganisation")
  • id string nullable
  • name string required
• amount number nullable
• currency string nullable
• released_at integer nullable
• published_at integer nullable
• closing_at integer nullable
• has_briefing_session boolean nullable
• is_briefing_compulsory boolean nullable
• briefing_at integer nullable
• briefing_venue string nullable
• contact_name string nullable
• contact_email string nullable
• contact_telephone string nullable
• contact_fax string nullable
• planning_rationale string nullable
• budget_description string nullable
• documents array (default: [])
  • @type string (default: "SaetendersReleaseDocument")
  • id string required
  • document_type string nullable
  • description string nullable
  • url string nullable
  • file_format string nullable
  • language string nullable
  • published_at integer nullable
  • modified_at integer nullable
• tenderers array (default: [])
  • @type string (default: "SaetendersOrganisation")
  • id string nullable
  • name string required
• parties array (default: [])
  • @type string (default: "SaetendersParty")
  • id string nullable
  • name string nullable
  • legal_name string nullable
  • country string nullable
  • roles array (default: [])
  • contact_name string nullable
  • contact_email string nullable
  • contact_telephone string nullable
  • contact_fax string nullable
  • website string nullable
• awards array (default: [])
  • @type string (default: "SaetendersReleaseAward")
  • id string required
  • supplier string nullable
  • status string nullable
  • enterprise_type string nullable
  • amount number nullable
  • currency string nullable
  • suppliers array (default: [])
    • @type string (default: "SaetendersOrganisation")
    • id string nullable
    • name string required
• contracts array (default: [])
  • @type string (default: "SaetendersContract")
  • id string required
  • award_id string nullable
  • description string nullable
  • status string nullable
  • amount number nullable
  • currency string nullable
  • signed_at integer nullable
  • start_at integer nullable
  • end_at integer nullable
  • max_extent_at integer nullable
  • duration_days integer nullable
  • documents array (default: [])
    • @type string (default: "SaetendersReleaseDocument")
    • id string required
    • document_type string nullable
    • description string nullable
    • url string nullable
    • file_format string nullable
    • language string nullable
    • published_at integer nullable
    • modified_at integer nullable
• tags array (default: [])
• initiation_type string nullable
• language string nullable
• url string required

Errors

• 422 — The id is neither a numeric eTenders id nor an ocds-9t57fa- ocid 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 release exists under that ocid 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.