actions

Check whether NMLP picks up books in a given ZIP code

Returns the service-area coverage tier, whether free pickup is offered (pickupAvailable), the minimum quantity, and a human-readable scheduling message (pickups are scheduled by route; never quote a pickup date or day count). Outside the pickup area the message points to the 24/7 drop box or donor-paid mail-in. Use this before calling /api/schedule-pickup to give the user honest expectations.

get/api/check-coverage

Request

  • Base URL: https://newmexicoliteracyproject.org
  • URL: https://newmexicoliteracyproject.org/api/check-coverage
  • Auth: none declared

Query parameters

zipstring required
Example:87107

Five-digit US ZIP code, e.g. 87107

Response

Coverage decision

zipstring required

The queried ZIP code

citystring

Approximate city or area name for that ZIP

coveredboolean required

True if NMLP serves the ZIP at all (pickup OR the 24/7 drop box / mail-in). Branch on pickupAvailable to decide whether a pickup can be requested.

pickupAvailableboolean

True only when free in-home pickup is offered at this ZIP; branch on this before calling /api/schedule-pickup.

tier'core_metro' | 'metro' | 'near_metro' | 'drop_off_only' | 'out_of_area' required

Coverage tier

minimumQuantityinteger

Minimum boxes for pickup at this tier (0 means no minimum)

typicalPickupWindowDaysinteger nullable

Deprecated — always null. Pickups are scheduled by route; see message.

messagestring required

Human-readable message to display to the user

callbackPhonestring required

Phone for direct scheduling — always 505-250-3804

callbackUrlstring

Web URL for direct scheduling

Changes

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