Skip to main content
GET
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.

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required
Example:

"ngo_mfrggzdfmztwq2lknnwg23tpob"

Query Parameters

wait_seconds
integer | null

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

Required range: 0 <= x <= 20
Example:

15

Response

The state of the request

status
string
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.

Example:

"offered"

id
string

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).

Example:

"ngo_mfrggzdfmztwq2lknnwg23tpob"

poll_after_seconds
integer

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

Example:

2

offer
object
decline
object

Present when status is declined.