Skip to main content
POST
Start a product file export

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
format
enum<string>
default:csv
Available options:
csv,
excel
export_template_id
integer | null
Required range: 0 < x <= 9223372036854776000
preset_code
string | null
Required string length: 1 - 64
use_default_template
boolean
default:true
product_ids
integer[] | null
Required array length: 1 - 1000 elements
Required range: x <= 9223372036854776000
skus
string[] | null
Required array length: 1 - 1000 elements
Required string length: 1 - 255
category_id
integer | null
Required range: 0 < x <= 9223372036854776000
export_locales
string[] | null
Required array length: 1 - 25 elements
Required string length: 1 - 32
uom_export_mode
enum<string> | null
Available options:
default,
append,
separate,
ignore
split_locale_files
boolean
default:false

Response

Accepted

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