Skip to main content

Get Pricing Level Coverage

GET 
/api/v2/sales-channels/:integrationInstance/prices/pricing-tiers/coverage

How much of the catalogue each pricing level in a sequence actually covers.

Required scope: integrations:read

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

Read-only, and takes the sequence as currently edited rather than as saved.

Authentication: Requires Bearer token.

Response fields:

  • total_products (integer): products carrying a price at any level — or, when scoped to a lane, products with a listing in that lane on this instance.
  • fulfillment_channel (string|null): the lane the counts are scoped to, or null for the whole catalogue.
  • tiers (array): one entry per level requested, in sequence order —
    • id, name, pricing_type, currency_code
    • is_archived (boolean): archived levels are hidden from the pickers but still supply prices to a sequence they are already in.
    • priced_count (integer): products this level prices, ignoring the sequence.
    • wins_count (integer): products this level actually supplies once the levels before it have taken theirs. A step whose earlier steps already cover everything reports 0 here — that is how an unreachable step is identified as a fact rather than a guess.
  • sequence (array of integers): the levels as evaluated.
  • covered_count (integer): products the sequence prices in total. Levels can overlap partially, so this is resolved order-aware and is NOT derivable by arithmetic on priced_count.
  • unpriced_count (integer): products no level in the sequence prices. These are reported as not_priced and nothing is sent for them.

Requires the integrations.view permission.

Scoping to a fulfillment-channel lane. Pass fulfillment_channel (e.g. MFN on Amazon) to measure a lane's own sequence over the products that have a listing in that lane on this instance, rather than over the whole catalogue — total_products, each level's priced_count and wins_count, covered_count and unpriced_count are all taken over that set. The response echoes the lane in fulfillment_channel (null when not scoped). A lane the channel does not support returns 422.

Request​

Responses​

OK

Response Headers
    Content-Type