Skip to main content

List Mappable Product Fields

GET 

/api/v2/listing-drafts/mappable-product-fields

Product columns you can use as a product_field mapping source in listing-draft field overrides and template field defaults. The list is served from the same definition the value resolver reads, so a picker can never offer a column that won't resolve.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

brand resolves through the product's brand relation. price resolves through the product's DEFAULT pricing tier.

The response also includes one entry per named pricing tier, with a value of pricing_tier:{id} and a label of Price — {tier name} tier. Use these to pin a specific tier (for example, always send wholesale pricing to one channel) instead of following whichever tier is the default. A product with no price on the selected tier resolves to null rather than 0, so a required channel field surfaces as missing instead of publishing a zero price. Tiers are per-account data, so this part of the list differs between accounts.

Each item includes type — the column's data type (text or number) — so a mapping picker can show what kind of value a column carries.

Authentication: Requires Bearer token.

Request

Responses

OK