Skip to main content
POST
Create export-templates

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 until key deletion. Different requests with the same key return 409.

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

Body

application/json
name
string
required

Human-readable name for this template

Maximum string length: 255
code
string
required

Unique identifier for this template within the project

Maximum string length: 100
description
string

Optional description of the template's purpose

Maximum string length: 100000
target_platform
string

Target platform this template is designed for

Maximum string length: 50
include_product_fields
string[]

Ordered list of product model field names to include in the export

column_mappings
Column Mappings · object

Maps internal field/attribute codes to output column names

export_locale
string

Default locale for resolving localized values. Leave empty to use the project's primary locale.

Maximum string length: 20
additional_locales
string[]

Additional locales to include as separate columns alongside the primary

attribute_layout
string

How attributes are laid out in the export. 'columnar' = one column per attribute (default). 'numbered_triplets' = Attribute Name N / Value N / UOM N slots.

Maximum string length: 30
max_attribute_slots
integer

Number of attribute triplet slots for numbered_triplets layout. 0 = auto-detect from data (use the max attribute count across products).

feature_field_mapping
Feature Field Mapping · object

Config for numbered feature columns. Two source modes: {'source': 'short_description', 'max_slots': 20, 'column_prefix': 'ITEM_FEATURES_', 'split_on': 'newline'} splits a product field by delimiter; {'source': 'attributes', 'attribute_prefix': 'feature_', 'max_slots': 20, 'column_prefix': 'ITEM_FEATURES_'} reads dedicated feature_N attributes from the PAV store.

promoted_attribute_columns
Promoted Attribute Columns · object[]

Dynamic attributes emitted as dedicated columns (e.g., Country of sale → Country_of_Sale) instead of numbered triplet slots. List of dicts with attribute_code, column_name, and optional join_separator (for list values).

category_columns
Category Columns · object[]

Category columns sourced from each product's primary ProductCategory. List of dicts with source (e.g. 'primary.external_code', 'primary.name'), column_name, and optional localizable flag.

is_default
boolean

Whether this is the default template for its target platform

is_active
boolean
families
integer[]

Limit export to products in these families. Leave empty for all.

Maximum array length: 500

Response

Created

name
string
required

Human-readable name for this template

Maximum string length: 255
code
string
required

Unique identifier for this template within the project

Maximum string length: 100
description
string
required

Optional description of the template's purpose

target_platform
string
required

Target platform this template is designed for

Maximum string length: 50
include_product_fields
any
required

Ordered list of product model field names to include in the export

column_mappings
any
required

Maps internal field/attribute codes to output column names

export_locale
string
required

Default locale for resolving localized values. Leave empty to use the project's primary locale.

Maximum string length: 20
additional_locales
any
required

Additional locales to include as separate columns alongside the primary

attribute_layout
string
required

How attributes are laid out in the export. 'columnar' = one column per attribute (default). 'numbered_triplets' = Attribute Name N / Value N / UOM N slots.

Maximum string length: 30
max_attribute_slots
integer
required

Number of attribute triplet slots for numbered_triplets layout. 0 = auto-detect from data (use the max attribute count across products).

feature_field_mapping
any
required

Config for numbered feature columns. Two source modes: {'source': 'short_description', 'max_slots': 20, 'column_prefix': 'ITEM_FEATURES_', 'split_on': 'newline'} splits a product field by delimiter; {'source': 'attributes', 'attribute_prefix': 'feature_', 'max_slots': 20, 'column_prefix': 'ITEM_FEATURES_'} reads dedicated feature_N attributes from the PAV store.

promoted_attribute_columns
any
required

Dynamic attributes emitted as dedicated columns (e.g., Country of sale → Country_of_Sale) instead of numbered triplet slots. List of dicts with attribute_code, column_name, and optional join_separator (for list values).

category_columns
any
required

Category columns sourced from each product's primary ProductCategory. List of dicts with source (e.g. 'primary.external_code', 'primary.name'), column_name, and optional localizable flag.

is_default
boolean
required

Whether this is the default template for its target platform

is_active
boolean
required
families
integer[]
required

Limit export to products in these families. Leave empty for all.

id
integer
required