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

# Check Availability

> A liveness check for your storefront



## OpenAPI

````yaml platforms/api-reference/openapi.json GET /availability
openapi: 3.1.0
info:
  title: UniHop Platform API
  description: >-
    Book and track UniHop last-mile deliveries on behalf of the merchants on
    your platform. Your platform identifier lives in the URL; the merchant's own
    API key authenticates the request.
  version: 1.0.0
servers:
  - url: https://backend.unihop.app/api/v1/{platform}
    description: Production
    variables:
      platform:
        default: your_platform
        description: The platform identifier UniHop issued you at onboarding.
security:
  - apiKeyAuth: []
paths:
  /availability:
    get:
      summary: Check availability
      description: >-
        A cheap liveness check you can poll before showing UniHop as a delivery
        option.
      responses:
        '200':
          description: Current availability.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceAvailability'
        '401':
          description: The API key is missing, invalid, or not valid for this platform.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ServiceAvailability:
      type: object
      properties:
        service:
          type: string
          description: Name of the service provider
          example: UniHop
        available:
          type: boolean
          description: Whether the service is currently available
          example: true
      required:
        - service
        - available
    Error:
      type: object
      properties:
        code:
          type: string
          description: >-
            Machine-readable error code, e.g. `not_found`, `not_cancelable`,
            `invalid_api_key`.
        message:
          type: string
          description: A human-readable description of what went wrong.
      required:
        - code
        - message
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        The merchant's UniHop API key, sent as `Authorization: Bearer <key>`. It
        identifies the merchant and is what their deliveries are billed against.

````