> ## 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. # List imports > This seller's product CSV imports, queued or finished. Another seller's imports are never listed. ## Filters Filter with `q[_]=value`, for example `q[number_cont]=…`. Send a list as `q[_in][]=a&q[_in][]=b`. [How filters work](/docs/api-reference/admin-api/querying.md#which-filters-an-endpoint-accepts). | Attribute | Kind | Predicates | | - | - | - | | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` | | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` | | `number` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `seller_id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` | | `status` | One of `pending`, `mapping`, `completed_mapping`, `processing`, `completed`, `failed` | `eq` `not_eq` `in` `not_in` `null` `not_null` | | `type` | Type | `eq` `not_eq` `in` `not_in` `null` `not_null` | | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` | **Sort by:** `created_at`, `id`, `number`, `seller_id`, `status`, `type`, `updated_at`. Prefix a field with `-` to sort descending. ## OpenAPI ````yaml /api-reference/seller.yaml get /api/v3/seller/imports openapi: 3.0.3 info: title: Seller API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: | Spree Seller API v3 - the marketplace seller panel, where a seller runs their own shop inside someone else's marketplace. This is a branch of its own, not a narrowing of the Admin API. Every endpoint is scoped server-side to the seller the request acts as, which is what makes cross-seller access impossible by construction rather than by rule. Sellers never call the Admin API. ## Authentication Sign in at `POST /api/v3/seller/auth/login` and send the returned JWT as `Authorization: Bearer `. The token carries a `seller_api` audience — a token minted for the storefront or the back office is not accepted here, and vice versa. There is deliberately **no secret API key** for this branch: a credential that could act as a seller without a seller signing in is exactly what the separate audience exists to prevent. ### Choosing a seller A user may run more than one seller. Login returns the list; send the chosen seller's ID in the `X-Spree-Seller-Id` header on every authenticated request. The store is derived from the seller — never sent — so no header can widen what a seller reaches. A request that names no seller the caller belongs to is rejected with `403`. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. ## 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: Seller sign-in, token refresh, logout, and invitation acceptance - name: Account description: The signed-in user, the sellers they may act for, and what they may do - name: Countries description: Country and state reference data for the panel's address forms - name: Delivery Methods description: >- The seller's own ways to ship, and the marketplace methods shared with them - name: Delivery Profiles description: >- The marketplace's delivery vocabulary — what kind of goods a product is, which decides how it ships - name: Delivery Zones description: >- The marketplace's destinations, for narrowing where a seller's own method ships - name: Onboarding description: >- The marketplace checklist a seller completes before admission, and what they submit against it - name: Policies description: The seller's own legal documents, as the marketplace asks them to publish - name: Product Types description: The types a seller may list a product against, and what each adds - name: Products description: The seller's own catalog - name: Profile description: >- The seller's own record — presentation, contact details, addresses, and tax registration - name: Stock Locations description: Where the seller keeps stock, and so where their returns are sent - name: Team description: Who runs this seller, and the invitations nobody has accepted yet - name: Files description: Uploading the files a profile, a submission or an import uses paths: /api/v3/seller/imports: get: tags: - Imports summary: List imports description: >- This seller's product CSV imports, queued or finished. Another seller's imports are never listed. parameters: - name: X-Spree-Seller-Id in: header required: true schema: type: string - name: q[search] in: query required: false schema: type: string description: Matches any of number (partial, case-insensitive). - name: page in: query required: false description: Page number schema: type: integer - name: limit in: query required: false description: Records per page (max 100) schema: type: integer - name: q in: query required: false style: deepObject explode: true schema: type: object additionalProperties: true description: >- Attribute filters, as `q[_]=value`. See Filters above for the list. responses: '200': description: imports listed content: application/json: example: data: - id: imp_UkLWZg9DAJ number: IM1001 rows_count: 0 created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' type: products status: pending store_id: store_UkLWZg9DAJ seller_id: sel_UkLWZg9DAJ user_id: adm_UkLWZg9DAJ processing_errors: null delimiter: ',' original_filename: products_import.csv original_byte_size: 3627 original_file_url: /api/v3/seller/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: stock_location label: Stock Location required: false - name: tax_category label: Tax Category required: false - name: product_type label: Product Type required: false - name: hs_code label: HS Code required: false - name: country_of_origin label: Country of Origin required: false - name: customs_description label: Customs Description required: false - name: carton label: Carton required: false - name: units_per_carton label: Units per Carton required: false - name: carton_weight label: Carton Weight required: false - name: cartons_per_pallet label: Cartons per Pallet 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: [] meta: page: 1 limit: 25 count: 1 pages: 1 from: 1 to: 1 in: 1 previous: null next: null schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Import' meta: $ref: '#/components/schemas/PaginationMeta' required: - data - meta security: - bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Seller SDK source: |- import { createSellerClient } from '@spree/seller-sdk' const client = createSellerClient({ baseUrl: 'https://your-store.com', jwtToken: 'eyJhbGciOi...', sellerId: 'sel_UkLWZg9DAJ', }) const { data: imports } = await client.imports.list({ status_eq: 'completed', sort: '-created_at', }) components: schemas: Import: type: object properties: id: type: string number: type: string rows_count: type: number created_at: type: string updated_at: type: string type: type: string nullable: true description: >- Import type. Built-in: products, product_translations, customers, price_list_prices. Extensions may register more. status: anyOf: - type: string enum: - pending - mapping - completed_mapping - processing - completed - failed - type: string description: The values listed are the built-in ones; extensions may add more. store_id: type: string nullable: true seller_id: type: string nullable: true user_id: type: string nullable: true processing_errors: type: string nullable: true delimiter: type: string original_filename: type: string nullable: true original_byte_size: type: number nullable: true original_file_url: type: string nullable: true completed_rows_count: type: number failed_rows_count: type: number schema_fields: type: array items: $ref: '#/components/schemas/ImportSchemaField' csv_headers: type: array items: type: string sample_row: type: object mappings: type: array items: $ref: '#/components/schemas/ImportMapping' required: - id - number - rows_count - created_at - updated_at - type - status - store_id - seller_id - user_id - processing_errors - delimiter - original_filename - original_byte_size - original_file_url - completed_rows_count - failed_rows_count - schema_fields - csv_headers - sample_row - mappings x-typelizer: true PaginationMeta: type: object properties: page: type: integer example: 1 limit: type: integer example: 25 count: type: integer example: 100 description: Total number of records pages: type: integer example: 4 description: Total number of pages from: type: integer example: 1 description: Index of first record on this page to: type: integer example: 25 description: Index of last record on this page in: type: integer example: 25 description: Number of records on this page previous: type: integer nullable: true example: null description: Previous page number next: type: integer nullable: true example: 2 description: Next page number required: - page - limit - count - pages - from - to - in ImportSchemaField: type: object description: >- A canonical column of an import type, including per-store custom field columns properties: name: type: string description: Canonical field name used in mappings example: slug label: type: string description: Human-readable label example: Slug required: type: boolean description: Whether the field must be mapped before processing required: - name - label - required ImportMapping: type: object properties: id: type: string schema_field: type: string file_column: type: string nullable: true required: type: boolean required: - id - schema_field - file_column - required x-typelizer: true securitySchemes: bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for an authenticated seller session (`seller_api` audience) ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.