/zppa/tenders/search

POST /api/zppa/tenders/search

Price: 20 credits

List Zambian public procurement records from the ZPPA OCDS publication, ordered by ocid, creation or processing date, optionally narrowed to ocids containing a substring. Returns each record as its full compiled OCDS release.

How to use it

The only upstream filter is a substring of the ocid; there is no title, buyer, status, date or value filter. `sort: created, descending: true` lists the newest records first. Every row is the full record, so zppa/tenders is only needed to refresh one ocid later.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• ocid string nullable — Part of the ocid (examples: "2403", "ocds-23g63a01-24035443"; minLength: 1)
• sort string — Field the records are ordered by (default: "ocid"; one of: "ocid", "created", "processed")
• descending boolean — Reverse the order (default: false)
• count integer required — Max number of records to return (min: 1; max: 1000)

Response

• @type string (default: "ZppaTender")
• ocid string required
• record_id string nullable
• description string nullable
• status string nullable
• stage string nullable
• buyer object nullable
  • @type string (default: "ZppaOrganization")
  • name string required
  • identifier object nullable
    • @type string (default: "ZppaIdentifier")
    • scheme string nullable
    • id string nullable
    • legal_name string nullable
    • uri string nullable
  • address object nullable
    • @type string (default: "ZppaAddress")
    • street string nullable
    • locality string nullable
    • region string nullable
    • postal_code string nullable
    • country_name string nullable
  • contact object nullable
    • @type string (default: "ZppaContact")
    • email string nullable
    • telephone string nullable
    • fax string nullable
    • url string nullable
• procuring_entity object nullable
  • @type string (default: "ZppaOrganization")
  • name string required
  • identifier object nullable
    • @type string (default: "ZppaIdentifier")
    • scheme string nullable
    • id string nullable
    • legal_name string nullable
    • uri string nullable
  • address object nullable
    • @type string (default: "ZppaAddress")
    • street string nullable
    • locality string nullable
    • region string nullable
    • postal_code string nullable
    • country_name string nullable
  • contact object nullable
    • @type string (default: "ZppaContact")
    • email string nullable
    • telephone string nullable
    • fax string nullable
    • url string nullable
• suppliers array (default: [])
  • @type string (default: "ZppaOrganization")
  • name string required
  • identifier object nullable
    • @type string (default: "ZppaIdentifier")
    • scheme string nullable
    • id string nullable
    • legal_name string nullable
    • uri string nullable
  • address object nullable
    • @type string (default: "ZppaAddress")
    • street string nullable
    • locality string nullable
    • region string nullable
    • postal_code string nullable
    • country_name string nullable
  • contact object nullable
    • @type string (default: "ZppaContact")
    • email string nullable
    • telephone string nullable
    • fax string nullable
    • url string nullable
• tenderers array (default: [])
  • @type string (default: "ZppaOrganization")
  • name string required
  • identifier object nullable
    • @type string (default: "ZppaIdentifier")
    • scheme string nullable
    • id string nullable
    • legal_name string nullable
    • uri string nullable
  • address object nullable
    • @type string (default: "ZppaAddress")
    • street string nullable
    • locality string nullable
    • region string nullable
    • postal_code string nullable
    • country_name string nullable
  • contact object nullable
    • @type string (default: "ZppaContact")
    • email string nullable
    • telephone string nullable
    • fax string nullable
    • url string nullable
• value object nullable
  • @type string (default: "ZppaValue")
  • amount number nullable
  • currency string nullable
• min_value object nullable
  • @type string (default: "ZppaValue")
  • amount number nullable
  • currency string nullable
• published_at integer nullable
• deadline_at integer nullable
• awarded_at integer nullable
• classifications array (default: [])
  • @type string (default: "ZppaClassification")
  • scheme string nullable
  • code string required
  • description string nullable
• country string (default: "ZM")
• url string required
• initiation_type string nullable
• language string nullable
• procurement_method string nullable
• procurement_method_rationale string nullable
• number_of_tenderers integer nullable
• submission_methods array (default: [])
• submission_method_details string nullable
• award_criteria string nullable
• award_criteria_details string nullable
• eligibility_criteria string nullable
• has_enquiries boolean nullable
• tender_period object nullable
  • @type string (default: "ZppaPeriod")
  • start_at integer nullable
  • end_at integer nullable
• enquiry_period object nullable
  • @type string (default: "ZppaPeriod")
  • start_at integer nullable
  • end_at integer nullable
• award_period object nullable
  • @type string (default: "ZppaPeriod")
  • start_at integer nullable
  • end_at integer nullable
• line_items array (default: [])
  • @type string (default: "ZppaItem")
  • id string required
  • description string nullable
  • classification object nullable
    • @type string (default: "ZppaClassification")
    • scheme string nullable
    • code string required
    • description string nullable
  • quantity number nullable
  • unit string nullable
• documents array (default: [])
  • @type string (default: "ZppaDocument")
  • id string required
  • description string nullable
  • document_type string nullable
  • url string nullable
  • mime_type string nullable
  • language string nullable
  • published_at integer nullable
  • modified_at integer nullable
• budget object nullable
  • @type string (default: "ZppaBudget")
  • id string nullable
  • project string nullable
  • project_id string nullable
  • description string nullable
  • amount object nullable
    • @type string (default: "ZppaValue")
    • amount number nullable
    • currency string nullable
• rationale string nullable
• awards array (default: [])
  • @type string (default: "ZppaAward")
  • id string required
  • description string nullable
  • status string nullable
  • awarded_at integer nullable
  • value object nullable
    • @type string (default: "ZppaValue")
    • amount number nullable
    • currency string nullable
  • suppliers array (default: [])
    • @type string (default: "ZppaOrganization")
    • name string required
    • identifier object nullable (see schema ZppaIdentifier)
    • address object nullable (see schema ZppaAddress)
    • contact object nullable (see schema ZppaContact)
  • line_items array (default: [])
    • @type string (default: "ZppaItem")
    • id string required
    • description string nullable
    • classification object nullable (see schema ZppaClassification)
    • quantity number nullable
    • unit string nullable
• contracts array (default: [])
  • @type string (default: "ZppaContract")
  • id string required
  • award_id string nullable
  • description string nullable
  • status string nullable
  • signed_at integer nullable
  • value object nullable
    • @type string (default: "ZppaValue")
    • amount number nullable
    • currency string nullable
  • line_items array (default: [])
    • @type string (default: "ZppaItem")
    • id string required
    • description string nullable
    • classification object nullable (see schema ZppaClassification)
    • quantity number nullable
    • unit string nullable
• record_status string nullable
• record_created_at integer nullable
• record_processed_at 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 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.