/gets/tenders

POST /api/gets/tenders

Price: 1 credit

Get one New Zealand government tender notice from GETS by its RFx id or notice URL. Returns the notice title, reference, overview text, status, tender type, buyer organisation, department, UNSPSC categories, regions, exemption reason, pre-qualification requirement, contact person, open and close dates, and on completed notices the awarded suppliers with their addresses, the award date and any further award information.

How to use it

Use this to read the full notice behind an id from gets/tenders/search, which only carries the list columns. `status` is one of published, closed, awarded, completed and cancelled: `awarded` means the RFx Outcome names an award (`suppliers` and `awarded_date` are filled there), `completed` means the notice was closed out without one, and `award_notes` holds the free-text the agency published under either outcome. `related_tenders` lists the notices the agency linked to this one. Tender documents, questions and the eTender box need a GETS login and are not returned.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tender string required — GETS RFx id or notice URL (examples: "34780928", "https://www.gets.govt.nz/NZTAHNO/ExternalTenderDetails.htm?id=34780928"; minLength: 1)

Response

• @type string (default: "GetsTender")
• id string required
• reference string nullable
• description string nullable
• status string required
• stage string required
• tender_type string nullable
• tender_type_code string nullable
• coverage string nullable
• department string nullable
• buyer object nullable
  • @type string (default: "GetsBuyer")
  • name string required
  • code string nullable
  • id string nullable
• categories array (default: [])
  • @type string (default: "GetsCategory")
  • code string nullable
  • name string required
• regions array (default: [])
• exemption_reason string nullable
• justification string nullable
• prequalifications string nullable
• contact object nullable
  • @type string (default: "GetsContact")
  • name string nullable
  • email string nullable
  • phone string nullable
• agency_address string nullable
• alternate_delivery_address string nullable
• alternate_fax string nullable
• indicative_release_date string nullable
• project_status string nullable
• expected_value string nullable
• published_at integer nullable
• deadline_at integer nullable
• awarded_date string nullable
• completed_at integer nullable
• suppliers array (default: [])
  • @type string (default: "GetsSupplier")
  • name string required
  • address string nullable
• award_notes string nullable
• related_tenders array (default: [])
  • @type string (default: "GetsRelatedTender")
  • id string required
  • url string required
• country string (default: "NZ")
• url string required

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 — No GETS notice exists with that RFx id. 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.