Get Sales Channel Category Fields

GET 
/api/v2/sales-channels/:salesChannel/categories/:category/fields

Lists the fields a sales channel asks for in one of its categories, in the channel's priority order (required, recommended, optional).

Required scope: products:read

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

Fields are cached and refreshed from the channel when the cached copy is more than 7 days old, or immediately with force=1.

• If an automatic refresh fails (for example, the channel connection needs re-authorizing), the response still returns 200 with the fields already cached, and sync_error explains why the refresh failed.
• If a forced refresh (force=1) fails, the response is 422 with the reason in message.
• sync_error is null when the fields are current.

Returns 404 when the category does not belong to the sales channel.

Authentication: Requires Bearer token with the listings scope.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

404

Not Found

Response Headers

Content-Type

422

Unprocessable Content

Response Headers

Content-Type

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.