Skip to main content
POST
Start a CSV or Excel product import

Authorizations

Authorization
string
header
required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Headers

Idempotency-Key
string

Reuse this key for retries of the same write. Scoped to this API key; retained for 30 days, after which the key may be reused. Different requests with the same key return 409.

Required string length: 1 - 128
Pattern: ^[!-~]+$

Body

application/json
import_template_id
integer
required
Required range: x <= 9223372036854776000
file_url
string | null
Required string length: 8 - 2048
file_base64
string | null
Minimum string length: 1
file_name
string | null
Required string length: 1 - 255
sheet_name
string | null
Required string length: 1 - 255
duplicate_handling
DuplicateHandlingIn · object | null

Response

Accepted

task_id
string
required
task_type
string
required
status
string
required
total_items
integer
required