Spree Seller SDK
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',
})curl --request GET \
--url http://{defaultHost}/api/v3/seller/imports \
--header 'Authorization: Bearer <token>' \
--header 'X-Spree-Seller-Id: <x-spree-seller-id>'{
"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
}
}List imports
This seller’s product CSV imports, queued or finished. Another seller’s imports are never listed.
GET
/
api
/
v3
/
seller
/
imports
Spree Seller SDK
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',
})curl --request GET \
--url http://{defaultHost}/api/v3/seller/imports \
--header 'Authorization: Bearer <token>' \
--header 'X-Spree-Seller-Id: <x-spree-seller-id>'{
"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
}
}Filters
Filter withq[<attribute>_<predicate>]=value, for example q[number_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.
| 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 |
created_at, id, number, seller_id, status, type, updated_at. Prefix a field with - to sort descending.Authorizations
JWT token for an authenticated seller session (seller_api audience)
Headers
Query Parameters
Matches any of number (partial, case-insensitive).
Page number
Records per page (max 100)
Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.
Was this page helpful?
⌘I

