Skip to main content

OfferResult

Possible responses when querying an offer. The response will be either the offer details or an error explaining why the offer couldn't be retrieved.

union OfferResult = Offer | OfferNotFoundError

Possible types​

OfferResult.Offer object​

Information about an offer. This query is still a work in progress at this point and will include more details in the future. This query should be used to get the offer PDF link.

OfferResult.OfferNotFoundError object​

Error indicating that the requested offer could not be found or accessed.

Common causes:

  • Invalid or expired offer ID
  • Offer exists but belongs to a different broker
  • Insufficient permissions to access the offer
  • On test environment, the offers reset every thursday and offers created before that date are not available anymore.

Returned By​

offer query