Skip to main content

Get Listing Profile Schema

GET 

/api/v2/sales-channels/:salesChannel/listing-profiles/schema

The settings this channel's publish path reads from a listing profile, described as labelled, typed fields, with any choices fetched live from the channel folded into the same response.

Required scope: products:read

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

Each field carries key (the exact settings key), label, type (text, number, select, boolean, list), an optional default, help, group, and either static options or options_from — a dotted path into options for choices that come from the channel (eBay business policies). When a live choice is stored, label_key names the settings key that should also receive the chosen option's label.

fields is empty for a channel that declares no schema; treat any key as free-form there. error is set, with options empty, when the channel could not be reached for its live choices.

Authentication: Requires Bearer token.

Request

Responses

OK

Response Headers
    Content-Type