Skip to main content

Get Price Rail Examples

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

One real product each price rail would move — the sequence editor's preview line ("Raise to MAP — e.g. RQ-1: its $22.00 level price is sent as $25.00 (its MAP)").

Required scope: integrations:read

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

Read-only. Takes the sequence and the rails as currently edited rather than as saved, so the editor can show a concrete consequence before the settings are committed.

Authentication: Requires Bearer token. Permission: integrations.view. PAT scope: integrations:read.

Response fields:

  • floor (object|null): null when floor_tier_id was not sent, or when no product's winning sequence price is below its floor-level price. Otherwise the first such product by SKU —
    • product_id, sku, name
    • level_price (number): the price the sequence chose for the product.
    • bound_price (number): the product's price at the floor level — what the rail sends instead (or the value it is blocked against).
  • ceiling (object|null): the same shape for the ceiling level — the first product by SKU whose winning price is above its ceiling-level price.

Products with no usable (> 0) price at the bound level are never examples: the rail does not apply to them.

Request​

Responses​

OK

Response Headers
    Content-Type