/marchesbj/procurement-plans

POST /api/marchesbj/procurement-plans

Price: 20 credits

Get the procurement plan of one Beninese contracting authority for a year, with its number, version, validation and publication dates, and every planned contract with its reference, subject, contract type, procurement method, funding type, implementing service, estimated value in CFA francs and its planned schedule from tender preparation to contract start.

How to use it

Without year and version the plan returned is the latest version of the current year; available_years and available_versions list what else can be requested. A planned contract's reference becomes the reference of its call for tenders on marchesbj/tenders/search once launched.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• plan_id string required — Plan id from marchesbj/procurement-plans/search (examples: "ABDT-687874")
• year integer nullable — Plan year (examples: 2026; min: 2022; max: 2100)
• version integer nullable — Plan version (examples: 1; min: 1)

Response

• @type string (default: "MarchesbjPlan")
• id string required
• plan_number string nullable
• year integer nullable
• version integer nullable
• revision_reason string nullable
• status string nullable
• buyer object nullable
  • @type string (default: "MarchesbjBuyer")
  • id string required
  • name string nullable
  • abbreviation string nullable
  • buyer_type object nullable
    • @type string (default: "MarchesbjCode")
    • id string nullable
    • code string nullable
    • name string nullable
  • email string nullable
  • phone string nullable
  • fax string nullable
  • website_url string nullable
  • manager_name string nullable
• period_start_date string nullable
• period_end_date string nullable
• created_date string nullable
• submitted_for_validation_date string nullable
• validated_date string nullable
• published_date string nullable
• rejected_date string nullable
• submission_reference string nullable
• submission_document_url string nullable
• compliance_reference string nullable
• compliance_document_url string nullable
• available_years array (default: [])
• available_versions array (default: [])
• planned_contract_count integer nullable
• planned_contracts array (default: [])
  • @type string (default: "MarchesbjPlanItem")
  • reference string required
  • subject string nullable
  • contract_type object nullable
    • @type string (default: "MarchesbjCode")
    • id string nullable
    • code string nullable
    • name string nullable
  • contract_type_group string nullable
  • procurement_method object nullable
    • @type string (default: "MarchesbjCode")
    • id string nullable
    • code string nullable
    • name string nullable
  • funding_type object nullable
    • @type string (default: "MarchesbjCode")
    • id string nullable
    • code string nullable
    • name string nullable
  • service object nullable
    • @type string (default: "MarchesbjService")
    • id string nullable
    • code string nullable
    • name string nullable
    • description string nullable
  • estimated_value number nullable
  • currency string nullable
  • lot_count integer nullable
  • execution_period integer nullable
  • revision_status string nullable
  • requires_ccmp_review boolean nullable
  • requires_dncmp_review boolean nullable
  • requires_donor_review boolean nullable
  • is_relaunch boolean nullable
  • tender_documents_preparation_date string nullable
  • terms_of_reference_preparation_date string nullable
  • proposal_request_preparation_date string nullable
  • launch_date string nullable
  • bid_opening_date string nullable
  • opening_date string nullable
  • proposal_opening_date string nullable
  • expression_of_interest_opening_date string nullable
  • start_date 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 — No record with this id on the Benin public procurement portal 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.