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

# Get a shop widget



## OpenAPI

````yaml /api/openapi.yaml get /ecommerce-widgets/{id}
openapi: 3.1.0
info:
  title: Formitto API
  version: 1.0.0
  description: >
    The Formitto public API (v1). Read and manage your forms, submissions,
    calendars, bookings, shop widgets, and orders programmatically.

    Authenticate with an API key created in the Formitto dashboard (Settings →
    API keys). Pass it as a Bearer token: `Authorization: Bearer fmt_live_...`.
    Keys are scoped — a key only reaches the endpoints its scopes allow (e.g.
    `read:forms`, `write:submissions`).

    All responses are JSON. List endpoints return a `{ data, pagination }`
    envelope; single-resource endpoints return the object directly. Requests are
    rate-limited per API key; see the `X-RateLimit-*` response headers.
  contact:
    name: Formitto Support
    url: https://formitto.com
  license:
    name: Proprietary
    url: https://formitto.com/terms
servers:
  - url: https://formitto.com/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: forms
    description: Create, read, update, and archive forms.
  - name: submissions
    description: Read and programmatically ingest form submissions.
  - name: calendars
    description: Read calendar widgets.
  - name: bookings
    description: Read calendar bookings.
  - name: ecommerce
    description: Read shop widgets.
  - name: orders
    description: Read shop orders.
  - name: webhooks
    description: Manage event subscriptions (REST Hooks) for integrations.
paths:
  /ecommerce-widgets/{id}:
    parameters:
      - $ref: '#/components/parameters/ResourceId'
    get:
      tags:
        - ecommerce
      summary: Get a shop widget
      operationId: getEcommerceWidget
      responses:
        '200':
          description: The shop widget.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EcommerceWidget'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    ResourceId:
      name: id
      in: path
      description: The resource id.
      required: true
      schema:
        type: integer
  headers:
    RateLimitLimit:
      description: The per-API-key request budget for the current 1-hour window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests remaining in the current window after this request.
      schema:
        type: integer
    RateLimitReset:
      description: Unix timestamp (seconds) at which the rate-limit window resets.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying. Present on 429 responses.
      schema:
        type: integer
  schemas:
    EcommerceWidget:
      type: object
      required:
        - id
        - name
        - type
        - productName
        - currency
        - fulfilmentType
        - createdAt
        - updatedAt
      properties:
        id:
          type: integer
        name:
          type: string
        type:
          type: string
          enum:
            - one_time
            - subscription
            - donation
        productName:
          type: string
        description:
          type:
            - string
            - 'null'
        priceCents:
          type:
            - integer
            - 'null'
        currency:
          type: string
        fulfilmentType:
          type: string
          enum:
            - digital
            - service
            - physical
        imageUrl:
          type:
            - string
            - 'null'
          format: uri
        domain:
          oneOf:
            - $ref: '#/components/schemas/DomainRef'
            - type: 'null'
        orderCount:
          type: integer
          description: Present on list responses.
        imageUrls:
          type: array
          description: Present on the detail view.
          items:
            type: string
            format: uri
        interval:
          type:
            - string
            - 'null'
          description: Subscription billing interval. Present on the detail view.
        trialDays:
          type:
            - integer
            - 'null'
          description: Present on the detail view.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    DomainRef:
      type: object
      description: The registered domain a resource is bound to.
      required:
        - id
        - domain
      properties:
        id:
          type: integer
        domain:
          type: string
          examples:
            - example.com
    Error:
      type: object
      description: >
        Standard error envelope. `code` is a stable machine-readable string
        (e.g. invalid_api_key, insufficient_scope, not_found, rate_limited,
        domain_required, forbidden_field). Some errors carry extra context
        fields (candidates, required, fields, invalid, retryAfter).
      required:
        - error
      additionalProperties: true
      properties:
        error:
          type: string
          description: Human-readable message.
        code:
          type: string
          description: Stable machine-readable error code.
  responses:
    Unauthorized:
      description: The API key is missing, malformed, revoked, or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: The API key is valid but lacks the scope this endpoint requires.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        No such resource on this account (also returned for resources owned by
        another account).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: The per-API-key request budget for the current window is exhausted.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: An unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: fmt_live_*
      description: >
        A Formitto API key created in the dashboard (Settings → API keys). Pass
        it as `Authorization: Bearer fmt_live_...`.

````