> ## Documentation Index
> Fetch the complete documentation index at: https://offergrid.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check address-level serviceability for on-screen offers

> Given a full street address, returns per-offer serviceability + exact price for offers whose markets reference an external serviceability source. Layered on top of ZIP coverage (not a gate) — offers without a source are simply absent from the result map. Unauthenticated.



## OpenAPI

````yaml /openapi/openapi-public.json post /public/shop/serviceability
openapi: 3.0.0
info:
  title: OfferGrid API
  description: >-
    **Public API** - Unauthenticated endpoints with no API key required.


    These power two public, no-login surfaces:

    - **Shareable links** (`/public/links/*`) - a reseller-branded landing page
    for a specific set of offers, used to collect an order from an end customer.

    - **Consumer shop** (`/public/shop/*`) - the offergrid.io/shop storefront,
    where consumers browse real offers by ZIP code and either check out directly
    or are redirected to a provider's own site.


    All endpoints here are rate-limited and validate/re-check coverage
    server-side; none require the `x-api-key` header used by the Provider and
    Reseller APIs.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.offergrid.io
    description: Production
security: []
tags:
  - name: public
    description: >-
      Public: Unauthenticated endpoints for shareable links and the /shop
      storefront
paths:
  /public/shop/serviceability:
    post:
      tags:
        - public
      summary: Check address-level serviceability for on-screen offers
      description: >-
        Given a full street address, returns per-offer serviceability + exact
        price for offers whose markets reference an external serviceability
        source. Layered on top of ZIP coverage (not a gate) — offers without a
        source are simply absent from the result map. Unauthenticated.
      operationId: PublicShopController_checkServiceability
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ShopServiceabilityDto'
      responses:
        '200':
          description: Per-offer serviceability detail keyed by offer id
        '500':
          description: Unexpected server error. Safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ShopServiceabilityDto:
      type: object
      properties:
        street:
          type: string
          example: 123 Main St
        unit:
          type: string
          example: Unit 4B
        zip:
          type: string
          example: '78701'
        city:
          type: string
          example: Austin
        state:
          type: string
          example: TX
        country:
          type: string
          example: US
          default: US
        category:
          type: string
          enum:
            - internet
            - electricity
            - other
          example: internet
        offerIds:
          description: Restrict the check to these offer ids (the cards on screen).
          type: array
          items:
            type: string
      required:
        - street
        - zip
      title: Shop Serviceability
    ErrorResponse:
      type: object
      title: Error
      description: Standard error envelope returned by every 4xx and 5xx response.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTP status code, repeated in the body.
          example: 404
        message:
          type: string
          description: Human-readable explanation of what went wrong.
          example: Offer not found
        error:
          type: string
          description: Short, stable name for the status code.
          example: Not Found

````