> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Show an import > Returns import status and row counters. The admin dashboard polls this endpoint while `status` is `completed_mapping` or `processing`; `rows_count`, `completed_rows_count` and `failed_rows_count` drive the progress bar. The mapping payload (`csv_headers`, `sample_row`) is only present while `status` is `mapping`. **Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml get /api/v3/admin/imports/{id} openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Exports description: Async CSV exports of admin resources - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, store credit categories - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/imports/{id}: get: tags: - Imports summary: Show an import description: >- Returns import status and row counters. The admin dashboard polls this endpoint while `status` is `completed_mapping` or `processing`; `rows_count`, `completed_rows_count` and `failed_rows_count` drive the progress bar. The mapping payload (`csv_headers`, `sample_row`) is only present while `status` is `mapping`. **Required scope:** the write scope of the imported resource — `write_products` for product imports, `write_customers` for customer imports, etc. (for API-key authentication). parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string - name: id in: path required: true schema: type: string responses: '200': description: import found content: application/json: example: id: imp_UkLWZg9DAJ number: IM319626141 type: Spree::Imports::Products rows_count: 0 created_at: '2026-07-24T18:11:04.072Z' updated_at: '2026-07-24T18:11:04.089Z' status: pending owner_type: Spree::Store owner_id: store_UkLWZg9DAJ user_id: admin_UkLWZg9DAJ processing_errors: null preferred_delimiter: ',' original_filename: products_import.csv original_byte_size: 3612 original_file_url: /api/v3/admin/imports/imp_UkLWZg9DAJ/download completed_rows_count: 0 failed_rows_count: 0 schema_fields: - name: slug label: Slug required: true - name: sku label: SKU required: true - name: name label: Name required: true - name: price label: Price required: true - name: status label: Status required: false - name: description label: Description required: false - name: meta_title label: Meta Title required: false - name: meta_description label: Meta Description required: false - name: meta_keywords label: Meta Keywords required: false - name: tags label: Tags required: false - name: compare_at_price label: Compare at Price required: false - name: currency label: Currency required: false - name: width label: Width required: false - name: height label: Height required: false - name: depth label: Depth required: false - name: dimensions_unit label: Dimensions Unit required: false - name: weight label: Weight required: false - name: weight_unit label: Weight Unit required: false - name: available_on label: Available On required: false - name: discontinue_on label: Discontinue On required: false - name: track_inventory label: Track Inventory required: false - name: inventory_count label: Inventory Count required: false - name: inventory_backorderable label: Inventory Backorderable required: false - name: tax_category label: Tax Category required: false - name: shipping_category label: Shipping Category required: false - name: image1_src label: Image 1 URL required: false - name: image2_src label: Image 2 URL required: false - name: image3_src label: Image 3 URL required: false - name: option1_name label: Option 1 Name required: false - name: option1_value label: Option 1 Value required: false - name: option2_name label: Option 2 Name required: false - name: option2_value label: Option 2 Value required: false - name: option3_name label: Option 3 Name required: false - name: option3_value label: Option 3 Value required: false - name: category1 label: Category 1 required: false - name: category2 label: Category 2 required: false - name: category3 label: Category 3 required: false csv_headers: [] sample_row: {} mappings: [] security: - api_key: [] bearer_auth: [] components: securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ````