Skip to main content

Get Pricing Sync Profile Coverage

GET 
/api/v2/sales-channels/:integrationInstance/prices/profile-coverage

How the channel's listings are distributed across pricing sync profiles — for each profile that governs at least one listing on this channel, how many listings it reaches and by which route.

Required scope: integrations:read

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

Authentication: Requires Bearer token.

Requires the integrations.view permission (API tokens: integrations:read scope).

Response data:

  • channel_default_profile_id (integer|null): the channel's default profile
  • listings_total (integer): active listings on the channel
  • inline_listings (integer): listings governed by no profile at any level — they push with the channel's inline settings
  • profiles (array): one entry per profile in use on the channel —
    • profile_id, name, summary
    • is_default (boolean): this profile is the channel default
    • is_archived (boolean): archived profiles still appear while they govern listings
    • listings_direct (integer): listings that carry this profile themselves
    • listings_via_product (integer): listings inheriting it from their product
    • listings_inherit (integer): listings inheriting it as the channel default
    • listings_total (integer): the sum of the three

The counts are cached for up to a minute; every assignment made through the API refreshes them.

Request​

Responses​

OK

Response Headers
    Content-Type