Skip to main content

Update Price Push Settings

PATCH 
/api/v2/sales-channels/:integrationInstance/prices/settings

Update the push cadence and price guardrails for an integration instance.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Guardrails are applied to every price immediately before it is sent, on every path — scheduled, manual and repricing-driven.

Authentication: Requires Bearer token.

Fields:

  • cadence_minutes (required, integer): how often the scheduled push runs. One of 15, 30, 60, 180, 360, 720, 1440.
  • floor_type (required, string): none, amount or margin_pct.
  • floor_value (required unless floor_type is none, number): the floor amount, or the minimum margin percentage.
  • ceiling_type (required, string): none, amount or markup_pct.
  • ceiling_value (required unless ceiling_type is none, number): the ceiling amount, or the maximum markup percentage.
  • max_delta_pct (optional, number, 0-1000): refuse a price that moves more than this percentage from the last value sent. Omit or null to disable.
  • max_delta_action (required, string): skip to refuse only that listing, or block_run to stop the whole run before anything is sent.
  • require_dry_run_first (optional, boolean): require a preview before the first live push.

A margin floor cannot be verified without a landed cost, and a listing with no cost is blocked rather than sent. A margin floor of 100% or more is rejected as unsatisfiable.

Requires the integrations.update permission.

Pricing-level bounds. floor_type / ceiling_type also accept tier, which reads the bound from the product's price in the pricing level named by floor_tier_id / ceiling_tier_id (MAP and MSRP are the usual cases). A product with no price in that level simply has NO bound — it is not blocked, unlike a margin_pct rule on a product with no landed cost.

floor_action / ceiling_action choose what happens when a price violates the bound: adjust moves the price to the bound and transmits it, block refuses the listing. Omit them (or send null) to get the type's default — adjust for tier, block for amount and the percentage types. An adjusted price is reported as a pushed line whose detail names the bound that moved it, and the maximum-change limit is measured on the ADJUSTED figure.

Request​

Responses​

OK

Response Headers
    Content-Type