/guatecompras/tenders

POST /api/guatecompras/tenders

Price: 10 credits

One Guatemalan public procurement process by NOG or ocid as its compiled OCDS release: the buyer and every party with addresses, contacts and entity classification, the tender with its period, UNSPSC-classified items and documents, the bids, the awards with suppliers and values, and the contracts with their signed documents.

How to use it

The NOG is the number Guatecompras prints on every process and the tail of the ocid. `stage` is `contract` once `contracts` is non-empty, `award` once `awards` is non-empty and `tender` before that; `awarded_amount` is the sum of the award values.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — NOG or ocid of the process (examples: "25417029", "ocds-xqjsxa-16024362"; minLength: 1)

Response

• @type string (default: "GuatecomprasTender")
• ocid string required
• nog string required
• release_id string nullable
• status string nullable
• status_details string nullable
• stage string nullable
• buyer object nullable
  • @type string (default: "GuatecomprasPartyRef")
  • id string nullable
  • name string required
• buyer_unit_id string nullable
• procuring_entity object nullable
  • @type string (default: "GuatecomprasPartyRef")
  • id string nullable
  • name string required
• suppliers array (default: [])
  • @type string (default: "GuatecomprasPartyRef")
  • id string nullable
  • name string required
• tenderers array (default: [])
  • @type string (default: "GuatecomprasPartyRef")
  • id string nullable
  • name string required
• awarded_amount object nullable
  • @type string (default: "GuatecomprasValue")
  • amount number nullable
  • currency string nullable
• published_at integer nullable
• deadline_at integer nullable
• awarded_at integer nullable
• updated_at integer nullable
• classifications array (default: [])
  • @type string (default: "GuatecomprasClassification")
  • scheme string nullable
  • code string required
• country string (default: "GT")
• url string required
• tags array (default: [])
• initiation_type string nullable
• language string nullable
• procurement_method string nullable
• procurement_method_details string nullable
• main_procurement_category string nullable
• additional_procurement_categories array (default: [])
• number_of_tenderers integer nullable
• submission_methods array (default: [])
• tender_period object nullable
  • @type string (default: "GuatecomprasPeriod")
  • start_at integer nullable
  • end_at integer nullable
• line_items array (default: [])
  • @type string (default: "GuatecomprasItem")
  • id string required
  • description string nullable
  • classification object nullable
    • @type string (default: "GuatecomprasClassification")
    • scheme string nullable
    • code string required
  • quantity number nullable
  • unit string nullable
  • attributes array (default: [])
    • @type string (default: "GuatecomprasAttribute")
    • id string required
    • name string nullable
    • value string nullable
• documents array (default: [])
  • @type string (default: "GuatecomprasDocument")
  • id string required
  • document_type string nullable
  • document_type_details string nullable
  • url string nullable
  • mime_type string nullable
  • language string nullable
  • published_at integer nullable
• bids array (default: [])
  • @type string (default: "GuatecomprasBid")
  • id string required
  • status string nullable
  • bid_at integer nullable
  • value object nullable
    • @type string (default: "GuatecomprasValue")
    • amount number nullable
    • currency string nullable
  • tenderers array (default: [])
    • @type string (default: "GuatecomprasPartyRef")
    • id string nullable
    • name string required
• awards array (default: [])
  • @type string (default: "GuatecomprasAward")
  • id string required
  • status string nullable
  • status_details string nullable
  • awarded_at integer nullable
  • value object nullable
    • @type string (default: "GuatecomprasValue")
    • amount number nullable
    • currency string nullable
  • suppliers array (default: [])
    • @type string (default: "GuatecomprasPartyRef")
    • id string nullable
    • name string required
• contracts array (default: [])
  • @type string (default: "GuatecomprasContract")
  • id string required
  • award_id string nullable
  • contract_number string nullable
  • status string nullable
  • status_details string nullable
  • signed_at integer nullable
  • period object nullable
    • @type string (default: "GuatecomprasPeriod")
    • start_at integer nullable
    • end_at integer nullable
  • value object nullable
    • @type string (default: "GuatecomprasValue")
    • amount number nullable
    • currency string nullable
  • documents array (default: [])
    • @type string (default: "GuatecomprasDocument")
    • id string required
    • document_type string nullable
    • document_type_details string nullable
    • url string nullable
    • mime_type string nullable
    • language string nullable
    • published_at integer nullable
• parties array (default: [])
  • @type string (default: "GuatecomprasParty")
  • id string required
  • name string nullable
  • roles array (default: [])
  • identifier object nullable
    • @type string (default: "GuatecomprasIdentifier")
    • scheme string nullable
    • id string nullable
  • address object nullable
    • @type string (default: "GuatecomprasAddress")
    • street string nullable
    • locality string nullable
    • region string nullable
    • country_name string nullable
  • contact object nullable
    • @type string (default: "GuatecomprasContact")
    • name string nullable
    • email string nullable
    • telephone string nullable
    • fax string nullable
  • additional_contacts array (default: [])
    • @type string (default: "GuatecomprasContact")
    • name string nullable
    • email string nullable
    • telephone string nullable
    • fax string nullable
  • sector object nullable
    • @type string (default: "GuatecomprasCode")
    • id string required
    • description string nullable
  • entity_group object nullable
    • @type string (default: "GuatecomprasCode")
    • id string required
    • description string nullable
  • entity_level object nullable
    • @type string (default: "GuatecomprasCode")
    • id string required
    • description string nullable
  • legal_form object nullable
    • @type string (default: "GuatecomprasCode")
    • id string required
    • description string nullable
  • member_of array (default: [])
    • @type string (default: "GuatecomprasPartyRef")
    • id string nullable
    • name string required

Errors

• 422 — The id is neither a NOG number nor an ocds-xqjsxa-<NOG> 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 process under that NOG or 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.