Skip to main content

List Channel Field Names

GET 

/api/v2/sales-channels/:salesChannel/attribute-mappings/field-names

The channel's field vocabulary for channel-wide attribute mappings. First come the channel's core listing fields (is_core: true), which apply to every category: for example Title, Description and Price, plus channel-specific fields such as a Shopify store's metafields (named metafield.{namespace}.{key} or variant_metafield.{namespace}.{key}, filed under group). Then comes every distinct field name across the channel's synced categories, with how many categories carry it and in how many it is required.

Required scope: products:read

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

A mapping is keyed on a NAME and matched case-insensitively against each listing's fields when its values are resolved, so a name that recurs across hundreds of categories is worth mapping once, while a one-off belongs on that category's template.

Category fields are ordered by category count, descending, and capped at 500 names.

Authentication: Requires Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type