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

# Get Import Sample

> Poche righe d'esempio rilette dal file finché c'è (§7.3, `api/sample.py`):
le celle delle sole colonne non personali né segrete e, con una mappatura
valida, la scheda del prodotto che ne nascerebbe. Sono VALORI del file:
servono `catalog` e il permesso dell'entità chiesta e di ogni entità della
mappatura. Il file non c'è più → 409 `import.run.file_missing`; run non
ancora analizzato → 409 `import.run.bad_state`; entità che la tappa non
importa → 422 `import.sample.entity_unsupported`.



## OpenAPI

````yaml https://api.vellaro.io/openapi/admin.json get /api/v1/admin/import-runs/{run_id}/sample
openapi: 3.1.0
info:
  title: Vellaro Admin API
  description: >-
    Store management under `/api/v1/admin`, for back ends and integrations.
    Every call takes `Authorization: Bearer <token>`: an admin API token or a
    staff user's token. The permissions of its role decide what it can do,
    always in its own store.
  version: 0.1.0
servers:
  - url: https://api.vellaro.io
    description: Produzione
security: []
tags:
  - name: Orders
    description: >-
      Orders and manual orders, payments, refunds, shipments, invoices, returns,
      customer subscriptions.
  - name: Products
    description: Products, variants, images, prices and discounts, product lookups.
  - name: Categories & catalog setup
    description: >-
      Categories, brands, attributes, options, filters, downloadable files,
      recurring profiles.
  - name: Inventory
    description: Stock of the variants and stock statuses.
  - name: Customers
    description: Customers, customer groups, custom fields.
  - name: Reviews & questions
    description: Moderation of product reviews and questions.
  - name: Promotions & coupons
    description: Coupons and gift vouchers.
  - name: Marketing
    description: Campaigns, newsletter subscribers, affiliates and their commissions.
  - name: Content
    description: >-
      CMS pages, menus, banners, information pages, flipbooks, media library,
      SEO URLs, email templates, translations.
  - name: Settings
    description: >-
      Store settings, email delivery, languages, currencies, physical stores,
      social login providers.
  - name: Shipping
    description: Couriers, shipping rates, weight and length classes.
  - name: Taxes & geo
    description: Tax classes, rates and rules; countries, zones and geo zones.
  - name: Integrations & modules
    description: >-
      Integrations, plugins and modules (Iute, extra warranty, Nextera, Financa
      5, WhatsApp, Firebase), outbound webhooks.
  - name: AI
    description: AI content generation and the settings of the AI shopping assistant.
  - name: Imports
    description: 'CSV imports and the universal import: runs, mappings, previews, undo.'
  - name: Reports & dashboard
    description: Dashboard figures and reports.
  - name: Users & API keys
    description: Staff users and roles, publishable keys, admin API tokens.
  - name: Audit
    description: The store's audit log.
paths:
  /api/v1/admin/import-runs/{run_id}/sample:
    get:
      tags:
        - Imports
      summary: Get Import Sample
      description: >-
        Poche righe d'esempio rilette dal file finché c'è (§7.3,
        `api/sample.py`):

        le celle delle sole colonne non personali né segrete e, con una
        mappatura

        valida, la scheda del prodotto che ne nascerebbe. Sono VALORI del file:

        servono `catalog` e il permesso dell'entità chiesta e di ogni entità
        della

        mappatura. Il file non c'è più → 409 `import.run.file_missing`; run non

        ancora analizzato → 409 `import.run.bad_state`; entità che la tappa non

        importa → 422 `import.sample.entity_unsupported`.
      operationId: get_import_sample_api_v1_admin_import_runs__run_id__sample_get
      parameters:
        - name: run_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Run Id
        - name: entity
          in: query
          required: false
          schema:
            type: string
            maxLength: 32
            default: product
            title: Entity
        - name: rows
          in: query
          required: false
          schema:
            type: integer
            maximum: 10
            minimum: 1
            default: 5
            title: Rows
        - name: table
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 1000
                minimum: 0
              - type: 'null'
            title: Table
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_SampleOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    ApiResponse_SampleOut_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/SampleOut'
            - type: 'null'
        meta:
          anyOf:
            - $ref: '#/components/schemas/PaginationMeta'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      title: ApiResponse[SampleOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SampleOut:
      properties:
        entity:
          type: string
          title: Entity
        table:
          type: integer
          title: Table
        mapping_valid:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Mapping Valid
        mapping_sha256:
          anyOf:
            - type: string
            - type: 'null'
          title: Mapping Sha256
        columns:
          items:
            $ref: '#/components/schemas/SampleColumnOut'
          type: array
          title: Columns
        rows:
          items:
            $ref: '#/components/schemas/SampleRowOut'
          type: array
          title: Rows
      type: object
      required:
        - entity
        - table
        - columns
        - rows
      title: SampleOut
      description: '`GET …/sample`: poche righe rilette dal file (`api/sample.py`).'
    PaginationMeta:
      properties:
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
        total:
          type: integer
          title: Total
        total_pages:
          type: integer
          title: Total Pages
      type: object
      required:
        - page
        - page_size
        - total
        - total_pages
      title: PaginationMeta
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SampleColumnOut:
      properties:
        letter:
          type: string
          title: Letter
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        classification:
          type: string
          title: Classification
        shown:
          type: boolean
          title: Shown
      type: object
      required:
        - letter
        - classification
        - shown
      title: SampleColumnOut
    SampleRowOut:
      properties:
        number:
          type: integer
          title: Number
        cells:
          additionalProperties:
            anyOf:
              - type: string
              - type: 'null'
          type: object
          title: Cells
        key:
          anyOf:
            - type: string
            - type: 'null'
          title: Key
        product:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Product
        problems:
          items:
            additionalProperties:
              anyOf:
                - type: string
                - type: 'null'
            type: object
          type: array
          title: Problems
          default: []
        anomalies:
          items:
            additionalProperties:
              anyOf:
                - type: string
                - type: 'null'
            type: object
          type: array
          title: Anomalies
          default: []
      type: object
      required:
        - number
        - cells
      title: SampleRowOut
      description: |-
        Una riga d'esempio: le celle mostrabili e, con una mappatura valida, la
        scheda del prodotto che ne nascerebbe (o i problemi per cui si salta).
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.