Docs

Docs / Data Feed / Pricing rules

For Data Feed stores
Endpoint · Read the pricing settings

GET/pricing-settings

Your store-wide pricing settings: the margin for a product no rule matches, how every price is rounded, and the MAP floor.

Needs Pricing rules: ReadBase URL https://backend.fflmonkey.com/api/v1Counts 1 toward 120 a minute

Fields

None. Needs Pricing rules: Read, a permission of Data Feed stores.

The three store-wide settings every price is built with, beside your pricing rules: the card above the rules on your Pricing screen. They come under Pricing rules because they are the rules' fallback and finish, not a permission of their own. When one changes, here or on the screen, GET /changes and your webhook carry pricing_settings.updated with all three.

What it answers

FieldMeaning
default_marginThe margin for a product no pricing rule matches: a percentage over cost, as a decimal string such as "25". Null: no margin, so such a product is priced at cost.
price_roundingHow every price is rounded, as a decimal string. Below 1 it is an ending, rounded up to: "0.99" makes 122.50 into 122.99. From 1 it is a step, rounded to the nearest: "5" makes 123.40 into 125.00. Null: no rounding.
enforce_map_floortrue: never publish a price below the distributor's MAP. A pricing rule's own enforce_map_floor overrides it for the products the rule prices. On by default, but stores that predate the setting were given it off, so read it rather than assume.

How a price is built

  1. The markup. A product no enabled rule matches is its cost plus default_margin, rounded to the cent. A product a rule matches is marked up by the rule instead.
  2. The rounding of price_rounding, on every price.
  3. The MAP floor, last, so rounding can never leave a price under MAP. It only ever raises a price.

Worked through for an offer no rule matches, costing 100.00 with a MAP of 119.00: "25" makes it 125.00, "0.99" makes that 125.99, which is above MAP, so the price is 125.99. With a margin of "10" it would be 110.00, then 110.99, and the floor would raise it to 119.00.

Returns

  • 200The settings, in data.

This endpoint can also answer 401 invalid_api_key, 403 license_not_active, 403 product_not_included, 403 insufficient_scope and 429 rate_limited.

Example

FFL Monkey Data Feed API, version 1. Questions: Support in your FFL Monkey account, or [email protected].