Hotels

Best Price Guarantee: read the result of a request

Read a request submitted with POST /v1/best_price_guarantee. The answer carries the state of the request in status: pending while the review runs, then offered with the new offer, or declined with the reason. A decline is a 200: it is an answer, not a failure of the call. A request of another key's tenant is answered 404, the same as one that does not exist.

get/v1/best_price_guarantee/{id}

Request

  • Base URL
    https://api.gojinko.com
  • URL
    https://api.gojinko.com/v1/best_price_guarantee/{id}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

idstring required
Example:ngo_mfrggzdfmztwq2lknnwg23tpob

Query parameters

wait_secondsinteger nullable

How long this call waits for a request that is still pending, 0–20 seconds (default 0).

Example:15

Response

The state of the request

idstring

Identifies the request; read its result with GET /v1/best_price_guarantee/{id}. Absent when the submission was declined before being recorded (feature_disabled, an unknown product).

statusstring required

pending: the review is still running — read the request again; this is not a decline. It can take up to a few minutes when the reference page is checked. offered: offer holds the new offer. declined: no offer, see decline.reason. expired: an offer was made and not used before expires_at. Treat any other value as pending.

poll_after_secondsinteger

Present while status is pending: a suggested pause before reading again.

Example response

{
  "id": "ngo_mfrggzdfmztwq2lknnwg23tpob",
  "status": "offered",
  "offer": {
    "trip_item_token": "htl_neg_ogydqmrsgaydamjqgezdgnbvgy",
    "offer_id": "htl_neg_ogydqmrsgaydamjqgezdgnbvgy",
    "price_money": {
      "value": 41250,
      "currency": "USD",
      "decimal_places": 2,
      "display": "USD 412.50"
    },
    "original": {
      "kind": "offer",
      "trip_item_token": "htl_8f3c1d5e9a7b2c40",
      "offer_id": "htl_8f3c1d5e9a7b2c40",
      "total_money": {
        "value": 43780,
        "currency": "USD",
        "decimal_places": 2,
        "display": "USD 437.80"
      }
    },
    "reference": {
      "total_money": {
        "value": 41250,
        "currency": "USD",
        "decimal_places": 2,
        "display": "USD 412.50"
      },
      "verified": true
    },
    "saving_money": {
      "value": 2530,
      "currency": "USD",
      "decimal_places": 2,
      "display": "USD 25.30"
    },
    "expires_at": "2026-10-12T10:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.