Method: offers.fetchPartnerEligibility

Page Summary

• The offers.fetchPartnerEligibility method is an unauthenticated method for external partners to check device offer eligibility.

• The HTTP request uses the GET method and requires offerType, eid, and imei as query parameters.

• The request body must be empty, and the response body contains a JSON object with a single boolean field isEligible.

• HTTP request
• Query parameters
• Request body
• Response body
  • JSON representation
• Try it!

An unauthenticated version of offers.fetchEligibility that external partners can call to check if their manufactured device is eligible for an offer.

HTTP request

GET https://fiwholesaleadaptor.googleapis.com/v1/offers:fetchPartnerEligibility

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
offerType	enum (OfferType) Required. The id of the offer to return with the device eligibility. If there is no matching offer found, a not found error will be returned.
eid	string Required. The EID of the eSIM on the device used to validate offer eligibility.
imei	string Required. The device identifier used to validate offer eligibility.

Request body

The request body must be empty.

Response body

Response for OfferService.FetchPartnerOfferEligibility.

If successful, the response body contains data with the following structure:

JSON representation
{ "isEligible": boolean }

Fields
isEligible	boolean Whether the device is eligible for the offer.