Skip to main content
POST
Spree Seller SDK

Authorizations

Authorization
string
header
required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id
string
required

Body

application/json
type
enum<string>
required
Available options:
products
attachment_signed_id
string
required

The signed_id of the uploaded CSV, from POST /files with visibility: 'private'.

delimiter
string

CSV column separator. Defaults to a comma.

results_url
string

Absolute URL of the panel's imports view; the import-done email links back to it. Honored only when it matches one of the store's allowed origins.

Response

201 - application/json

import created in mapping state

id
string
required
number
string
required
rows_count
number
required
created_at
string
required
updated_at
string
required
type
string | null
required

Import type. Built-in: products, product_translations, customers, price_list_prices. Extensions may register more.

status
required

The values listed are the built-in ones; extensions may add more.

Available options:
pending,
mapping,
completed_mapping,
processing,
completed,
failed
store_id
string | null
required
seller_id
string | null
required
user_id
string | null
required
processing_errors
string | null
required
delimiter
string
required
original_filename
string | null
required
original_byte_size
number | null
required
original_file_url
string | null
required
completed_rows_count
number
required
failed_rows_count
number
required
schema_fields
object[]
required
csv_headers
string[]
required
sample_row
object
required
mappings
object[]
required