{"info":{"name":"Pricemaster API","description":"Every endpoint of the Pricemaster API (1.0), generated from https://api.pricemaster.ai/openapi.json.\n\n**Getting started**\n1. In Pricemaster, open Settings → API access and create a key (you need the Developer API switched on for your workspace).\n2. Open this collection's Variables tab and paste the key into `api_key` (current value). Save.\n3. Send Workspace → GET /me. It returns the key's scopes and the workspace it unlocks.\n4. Send Products → List products, copy an `id` into the `product_id` variable, and every product request works.\n\nEvery price on the wire is `{ex_tax, inc_tax}` as decimal strings; the response envelope carries `currency` and `tax_rate`. Lists are keyset-paged: pass `next_cursor` as `cursor`.\nWrite requests need the write scopes on the key and 'Allow API writes' on the workspace; price pushes also need 'Allow API price pushes'. Nothing here can switch on automatic pushing.\n\nGuide: https://pricemaster.ai/docs/api","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json","version":"1.0"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{api_key}}","type":"string"}]},"event":[{"listen":"test","script":{"type":"text/javascript","exec":["const rid = pm.response.headers.get('Pricemaster-Request-Id');","if (rid) pm.collectionVariables.set('last_request_id', rid);","pm.test('Pricemaster answered (not a 5xx)', () => pm.expect(pm.response.code).to.be.below(500));","if (pm.response.code === 401) console.log('401 from Pricemaster: set the collection variable api_key to a key from Settings → API access.');","if (pm.response.code === 403) console.log('403 from Pricemaster: ' + (pm.response.json().error || {}).message);"]}}],"variable":[{"key":"base_url","value":"https://api.pricemaster.ai/v1","description":"The API base. Leave as is."},{"key":"api_key","value":"","type":"string","description":"SECRET. Your workspace key (pmk_live_…) from Settings → API access in Pricemaster. Keep it in the current value only; never export or share a collection with it filled in."},{"key":"product_id","value":"","description":"A product id from GET /products (or GET /products/by-sku/{sku})."},{"key":"listing_id","value":"","description":"A competitor listing id from GET /products/{id}/offers."},{"key":"seller_id","value":"","description":"A seller id from GET /sellers."},{"key":"rule_id","value":"","description":"A rule id from GET /rules."},{"key":"tag_id","value":"","description":"A tag id from GET /tags."},{"key":"band_id","value":"","description":"A cost-band id from GET /min-margins."},{"key":"group_id","value":"","description":"A product-group id from GET /min-margins."},{"key":"push_id","value":"","description":"A push operation id from GET /pushes."},{"key":"sku","value":"","description":"One of your SKUs, for GET /products/by-sku/{sku}."},{"key":"last_request_id","value":"","description":"Set automatically after every call: the Pricemaster-Request-Id to quote to support."}],"item":[{"name":"Workspace","description":"The key and its workspace.","item":[{"name":"The key and the one workspace it unlocks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/me","host":["{{base_url}}"],"path":["me"]},"description":"The key and the one workspace it unlocks.\n\nWorks with any valid key regardless of scopes. Use it to confirm a key, see its scopes, and read the workspace's currency, tax rate and modules.\n\nAny valid key.\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Products","description":"Your products: identity, cost, prices, stock, tags, rule.","item":[{"name":"List products","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products","host":["{{base_url}}"],"path":["products"],"query":[{"key":"limit","value":"50","description":"Page size.","disabled":true},{"key":"cursor","value":"","description":"Opaque cursor from the previous page's next_cursor.","disabled":true},{"key":"q","value":"","description":"Free text over SKU, title and barcode.","disabled":true},{"key":"sku","value":"","description":"Exact SKU (case and punctuation insensitive).","disabled":true},{"key":"gtin","value":"","description":"Barcode (EAN/UPC/GTIN, any length; zero-padded to 14).","disabled":true},{"key":"tag","value":"","description":"Only products carrying this tag name.","disabled":true},{"key":"brand","value":"","description":"Exact brand (case insensitive).","disabled":true},{"key":"psin","value":"1","description":"Only products matched to this global product id.","disabled":true},{"key":"enabled","value":"true","description":"Filter on enabled.","disabled":true},{"key":"monitor_only","value":"true","description":"Filter on monitor-only.","disabled":true},{"key":"updated_since","value":"","description":"Only products changed at or after this time; switches the ordering to (updated_at, id).","disabled":true},{"key":"expand","value":"","description":"Comma list of `rule`, `tags`.","disabled":true}]},"description":"List products.\n\nKeyset-paged on id. With `updated_since` the order becomes (updated_at, id) so a poller can fetch changes since its last run. `expand=rule,tags` adds the pricing rule and tags per product.\n\nScope required: `products:read` (Read your products: SKU, title, identifiers, cost, prices, stock, tags and market position.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"One product with its tags and pricing rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/:id","host":["{{base_url}}"],"path":["products",":id"],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."}]},"description":"One product with its tags and pricing rule.\n\nScope required: `products:read` (Read your products: SKU, title, identifiers, cost, prices, stock, tags and market position.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Update product facts","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/products/:id","host":["{{base_url}}"],"path":["products",":id"],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."}]},"body":{"mode":"raw","raw":"{\n  \"cost\": 62.5,\n  \"stock\": 14\n}","options":{"raw":{"language":"json"}}},"description":"Update product facts.\n\nChanges cost, price (what your store charges now: an observation, NOT a push), special_price, rrp, map_price, stock, enabled, monitor_only. Money inputs are ex tax when given as a number; `{\"ex_tax\":…}` or `{\"inc_tax\":…}` objects are accepted. Needs the workspace's API-writes setting. Send an Idempotency-Key header to make retries safe. Every change is written to the workspace audit log.\n\nScope required: `products:write` (Update product facts: cost, stock, RRP, MAP, enabled and monitor-only. Never sends a price to your store.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Look a product up by SKU","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/by-sku/:sku","host":["{{base_url}}"],"path":["products","by-sku",":sku"],"variable":[{"key":"sku","value":"{{sku}}","description":"SKU, URL-encoded. Case and punctuation insensitive."}]},"description":"Look a product up by SKU.\n\nScope required: `products:read` (Read your products: SKU, title, identifiers, cost, prices, stock, tags and market position.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Your own daily price for a product","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/:id/price-history","host":["{{base_url}}"],"path":["products",":id","price-history"],"query":[{"key":"from","value":"2026-10-01","description":"Start date (ISO-8601). Default: 90 days before `to`.","disabled":true},{"key":"to","value":"2026-10-01","description":"End date (ISO-8601). Default: today. The range may span at most 400 days.","disabled":true}],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."}]},"description":"Your own daily price for a product.\n\nScope required: `products:read` (Read your products: SKU, title, identifiers, cost, prices, stock, tags and market position.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Market","description":"Competitor offers, price history, sellers and the engine's recommendation.","item":[{"name":"Competitor offers for a product","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/:id/offers","host":["{{base_url}}"],"path":["products",":id","offers"],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."}]},"description":"Competitor offers for a product.\n\nOne offer per seller: the same market view the pricing engine and the product page use. Sellers and listings the workspace has switched off, and dead or quarantined pages, are already excluded. `difference_ex_tax` is their price minus yours.\n\nScope required: `market:read` (Read competitor offers, competitor price history, the sellers tracked for the workspace and price recommendations.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Daily price history of one competitor listing","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/:id/offers/:listing_id/history","host":["{{base_url}}"],"path":["products",":id","offers",":listing_id","history"],"query":[{"key":"from","value":"2026-10-01","description":"Start date (ISO-8601). Default: 90 days before `to`.","disabled":true},{"key":"to","value":"2026-10-01","description":"End date (ISO-8601). Default: today. The range may span at most 400 days.","disabled":true}],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."},{"key":"listing_id","value":"{{listing_id}}","description":"Listing id from /offers."}]},"description":"Daily price history of one competitor listing.\n\nThe listing must be among the product's current offers (see /offers); anything else is 404.\n\nScope required: `market:read` (Read competitor offers, competitor price history, the sellers tracked for the workspace and price recommendations.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"What the product's rule would set right now","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/:id/recommendation","host":["{{base_url}}"],"path":["products",":id","recommendation"],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."}]},"description":"What the product's rule would set right now.\n\nRuns the pricing engine for this one product with its winning rule and today's offers. Read-only: nothing is sent to the store. `explanation` is the engine's calculation log. Rate bucket `engine`.\n\nScope required: `market:read` (Read competitor offers, competitor price history, the sellers tracked for the workspace and price recommendations.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Switch a competitor on or off for this workspace","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/sellers/:id","host":["{{base_url}}"],"path":["sellers",":id"],"variable":[{"key":"id","value":"{{seller_id}}","description":"Seller id from /sellers."}]},"body":{"mode":"raw","raw":"{\n  \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"description":"Switch a competitor on or off for this workspace.\n\nThe workspace's own opinion only; the shared seller record is untouched. 404 when the seller has no offers on your products.\n\nScope required: `market:write` (Switch a competitor on or off for the workspace, exclude or prefer a listing on a product, request a fresh read of a competitor page.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Exclude, prefer or clear one competitor offer on one product","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/products/:id/offers/:listing_id/override","host":["{{base_url}}"],"path":["products",":id","offers",":listing_id","override"],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."},{"key":"listing_id","value":"{{listing_id}}","description":"Listing id from /offers."}]},"body":{"mode":"raw","raw":"{\n  \"state\": \"disabled\",\n  \"scope\": \"seller\"\n}","options":{"raw":{"language":"json"}}},"description":"Exclude, prefer or clear one competitor offer on one product.\n\n`disabled` leaves the offer out of pricing for this product, `preferred` marks the listing you trust for that seller, `clear` restores normal. `scope` is `seller` (every listing of the seller on this product; the default for disabled/clear) or `listing`. Never changes the shared listing or its match.\n\nScope required: `market:write` (Switch a competitor on or off for the workspace, exclude or prefer a listing on a product, request a fresh read of a competitor page.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Poll a requested read","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/products/:id/offers/:listing_id/rescrape","host":["{{base_url}}"],"path":["products",":id","offers",":listing_id","rescrape"],"query":[{"key":"since","value":"","description":"The `checked_at` you already have; the answer says whether a newer reading exists.","disabled":true}],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."},{"key":"listing_id","value":"{{listing_id}}","description":"Listing id."}]},"description":"Poll a requested read.\n\nScope required: `market:read` (Read competitor offers, competitor price history, the sellers tracked for the workspace and price recommendations.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Ask for a fresh read of one competitor page now","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/products/:id/offers/:listing_id/rescrape","host":["{{base_url}}"],"path":["products",":id","offers",":listing_id","rescrape"],"variable":[{"key":"id","value":"{{product_id}}","description":"Product id."},{"key":"listing_id","value":"{{listing_id}}","description":"Listing id from /offers."}]},"description":"Ask for a fresh read of one competitor page now.\n\nQueues the page for an immediate read (the product page's ⟳). Poll with GET. Rate-limited per listing by Pricemaster; bucket `engine`.\n\nScope required: `market:write` (Switch a competitor on or off for the workspace, exclude or prefer a listing on a product, request a fresh read of a competitor page.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Sellers with offers on your products","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/sellers","host":["{{base_url}}"],"path":["sellers"],"query":[{"key":"enabled","value":"true","description":"Only sellers switched on (true) or off (false) for the workspace.","disabled":true},{"key":"q","value":"","description":"Filter on name or domain.","disabled":true}]},"description":"Sellers with offers on your products.\n\nOne row per seller with a live listing on a product you sell, with your on/off setting. Cached for up to 10 minutes.\n\nScope required: `market:read` (Read competitor offers, competitor price history, the sellers tracked for the workspace and price recommendations.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Rules","description":"Pricing rules: read, create, edit, enable/disable, reorder, delete, assign products, simulate.","item":[{"name":"List pricing rules","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/rules","host":["{{base_url}}"],"path":["rules"],"query":[{"key":"limit","value":"50","description":"Page size.","disabled":true},{"key":"cursor","value":"","description":"Opaque cursor from the previous page's next_cursor.","disabled":true},{"key":"enabled","value":"true","description":"Filter on enabled.","disabled":true}]},"description":"List pricing rules.\n\nScope required: `rules:read` (Read pricing rules, their settings and which rule prices each product.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Create a pricing rule","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/rules","host":["{{base_url}}"],"path":["rules"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"DeWalt: 1% below cheapest\",\n  \"strategy\": \"follow\",\n  \"enabled\": false,\n  \"settings\": {\n    \"priceEnding\": \"99\",\n    \"priceEndingDirection\": \"nearest\",\n    \"follow\": {\n      \"type\": \"cheapest_position\",\n      \"cheapestPosition\": 1,\n      \"modifierDirection\": \"below\",\n      \"modifierValue\": 1,\n      \"modifierType\": \"percentage\",\n      \"applyMinMargin\": true\n    }\n  },\n  \"targeting\": {\n    \"suppliers\": [\n      \"Toolbank\"\n    ],\n    \"tags\": [\n      \"DeWalt\"\n    ],\n    \"tag_match\": \"any\"\n  }\n}","options":{"raw":{"language":"json"}}},"description":"Create a pricing rule.\n\nSame steps as the Rules page: validated engine-shaped `settings`, creep-cap check before any write (422 validation_failed), the new rule lands at the TOP of its ladder (priority 1; `priority` places it elsewhere), a revision is recorded, products are assigned from `targeting`. Nothing is pushed to the store.\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Set the ladder order","request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/rules/order","host":["{{base_url}}"],"path":["rules","order"]},"body":{"mode":"raw","raw":"{\n  \"rule_ids\": [\n    91,\n    84\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Set the ladder order.\n\n`rule_ids` top first; priorities are rewritten 1..n (lower wins). All ids must belong to ONE ladder (all-channels, or one channel). Rules of that ladder left out keep their number, so send the whole ladder.\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"One pricing rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/rules/:id","host":["{{base_url}}"],"path":["rules",":id"],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"description":"One pricing rule.\n\nScope required: `rules:read` (Read pricing rules, their settings and which rule prices each product.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Edit a rule: name, enabled, priority, strategy + settings, targeting, schedule","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/rules/:id","host":["{{base_url}}"],"path":["rules",":id"],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"body":{"mode":"raw","raw":"{\n  \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"description":"Edit a rule: name, enabled, priority, strategy + settings, targeting, schedule.\n\nSend only what changes. `{\"enabled\": false}` switches a rule off; `{\"enabled\": true}` on. `settings` replaces the strategy block (validated; app-only settings are carried across). 409 rule_locked while the rule is in a running A/B test.\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Delete a rule and its assignments","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/rules/:id","host":["{{base_url}}"],"path":["rules",":id"],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"description":"Delete a rule and its assignments.\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Products assigned to a rule","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/rules/:id/products","host":["{{base_url}}"],"path":["rules",":id","products"],"query":[{"key":"limit","value":"50","description":"Page size.","disabled":true},{"key":"cursor","value":"","description":"Opaque cursor from the previous page's next_cursor.","disabled":true}],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"description":"Products assigned to a rule.\n\nScope required: `rules:read` (Read pricing rules, their settings and which rule prices each product.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Assign products to a rule by hand (up to 500)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/rules/:id/products","host":["{{base_url}}"],"path":["rules",":id","products"],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"body":{"mode":"raw","raw":"{\n  \"product_ids\": [\n    48213,\n    50122\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Assign products to a rule by hand (up to 500).\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Unassign many products from a rule","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/rules/:id/products/remove","host":["{{base_url}}"],"path":["rules",":id","products","remove"],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"body":{"mode":"raw","raw":"{\n  \"product_ids\": [\n    50122\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Unassign many products from a rule.\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Unassign one product from a rule","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/rules/:id/products/:product_id","host":["{{base_url}}"],"path":["rules",":id","products",":product_id"],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."},{"key":"product_id","value":"{{product_id}}","description":"Product id."}]},"description":"Unassign one product from a rule.\n\nScope required: `rules:write` (Create, edit, enable, disable, reorder and delete pricing rules; assign and unassign products. Never sends a price.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Run the rule and report what it would set","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/rules/:id/simulate","host":["{{base_url}}"],"path":["rules",":id","simulate"],"query":[{"key":"limit","value":"500","description":"Products to simulate.","disabled":true}],"variable":[{"key":"id","value":"{{rule_id}}","description":"Rule id."}]},"description":"Run the rule and report what it would set.\n\nRead-only: nothing is sent. Up to 2,000 products (default 500); the first 500 rows are returned, the summary covers them all. Bucket `engine`.\n\nScope required: `rules:read` (Read pricing rules, their settings and which rule prices each product.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Tags","description":"Workspace tags: read, create, rename, delete, and change which products carry a manual tag.","item":[{"name":"List tags with product counts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/tags","host":["{{base_url}}"],"path":["tags"]},"description":"List tags with product counts.\n\nScope required: `tags:read` (Read the workspace's tags.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Create a manual tag","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/tags","host":["{{base_url}}"],"path":["tags"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"Clearance\",\n  \"colour\": \"#d97706\"\n}","options":{"raw":{"language":"json"}}},"description":"Create a manual tag.\n\n409 conflict when the name exists. Dynamic (criteria-driven) tags are created in the app.\n\nScope required: `tags:write` (Create, rename, delete manual tags and change which products carry them.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"One tag","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/tags/:id","host":["{{base_url}}"],"path":["tags",":id"],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."}]},"description":"One tag.\n\nScope required: `tags:read` (Read the workspace's tags.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Rename or recolour a tag","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/tags/:id","host":["{{base_url}}"],"path":["tags",":id"],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."}]},"body":{"mode":"raw","raw":"{\n  \"name\": \"Clearance (Q4)\"\n}","options":{"raw":{"language":"json"}}},"description":"Rename or recolour a tag.\n\nScope required: `tags:write` (Create, rename, delete manual tags and change which products carry them.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Delete a tag; products keep their other tags","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/tags/:id","host":["{{base_url}}"],"path":["tags",":id"],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."}]},"description":"Delete a tag; products keep their other tags.\n\nScope required: `tags:write` (Create, rename, delete manual tags and change which products carry them.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Products carrying a tag","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/tags/:id/products","host":["{{base_url}}"],"path":["tags",":id","products"],"query":[{"key":"limit","value":"50","description":"Page size.","disabled":true},{"key":"cursor","value":"","description":"Opaque cursor from the previous page's next_cursor.","disabled":true}],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."}]},"description":"Products carrying a tag.\n\nScope required: `tags:read` (Read the workspace's tags.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Add products to a manual tag (up to 500)","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/tags/:id/products","host":["{{base_url}}"],"path":["tags",":id","products"],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."}]},"body":{"mode":"raw","raw":"{\n  \"product_ids\": [\n    48213,\n    50122\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Add products to a manual tag (up to 500).\n\n422 validation_failed on a dynamic tag.\n\nScope required: `tags:write` (Create, rename, delete manual tags and change which products carry them.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Take many products off a manual tag","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/tags/:id/products/remove","host":["{{base_url}}"],"path":["tags",":id","products","remove"],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."}]},"body":{"mode":"raw","raw":"{\n  \"product_ids\": [\n    50122\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Take many products off a manual tag.\n\nScope required: `tags:write` (Create, rename, delete manual tags and change which products carry them.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Take one product off a manual tag","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/tags/:id/products/:product_id","host":["{{base_url}}"],"path":["tags",":id","products",":product_id"],"variable":[{"key":"id","value":"{{tag_id}}","description":"Tag id."},{"key":"product_id","value":"{{product_id}}","description":"Product id."}]},"description":"Take one product off a manual tag.\n\nScope required: `tags:write` (Create, rename, delete manual tags and change which products carry them.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Margins","description":"Minimum margins: the default floor, cost bands and product-group tables.","item":[{"name":"The default floor, base cost bands and product-group tables","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/min-margins","host":["{{base_url}}"],"path":["min-margins"]},"description":"The default floor, base cost bands and product-group tables.\n\nScope required: `margins:read` (Read the minimum-margin default, cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Set the account-wide default minimum margin","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/min-margins","host":["{{base_url}}"],"path":["min-margins"]},"body":{"mode":"raw","raw":"{\n  \"default_percent\": 22\n}","options":{"raw":{"language":"json"}}},"description":"Set the account-wide default minimum margin.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Add a cost band, fitted into its table","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/min-margins/bands","host":["{{base_url}}"],"path":["min-margins","bands"]},"body":{"mode":"raw","raw":"{\n  \"min_cost\": 0,\n  \"max_cost\": 50,\n  \"margin_percent\": 25\n}","options":{"raw":{"language":"json"}}},"description":"Add a cost band, fitted into its table.\n\nCosts ex tax. Bands the new one covers are replaced, bands it cuts into are trimmed, a band it sits inside is split, so bands never overlap. `group_id` targets a product-group table; absent = the base table.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Edit a band in place","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/min-margins/bands/:id","host":["{{base_url}}"],"path":["min-margins","bands",":id"],"variable":[{"key":"id","value":"{{band_id}}","description":"Band id."}]},"body":{"mode":"raw","raw":"{\n  \"margin_percent\": 27.5\n}","options":{"raw":{"language":"json"}}},"description":"Edit a band in place.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Delete a band","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/min-margins/bands/:id","host":["{{base_url}}"],"path":["min-margins","bands",":id"],"variable":[{"key":"id","value":"{{band_id}}","description":"Band id."}]},"description":"Delete a band.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Create a product-group table","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/min-margins/groups","host":["{{base_url}}"],"path":["min-margins","groups"]},"body":{"mode":"raw","raw":"{\n  \"name\": \"DeWalt\",\n  \"tags\": [\n    \"DeWalt\"\n  ]\n}","options":{"raw":{"language":"json"}}},"description":"Create a product-group table.\n\nIts own bands apply to the products its suppliers/tags select; needs at least one supplier or tag.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Edit, reprioritise or switch a product-group table on/off","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/min-margins/groups/:id","host":["{{base_url}}"],"path":["min-margins","groups",":id"],"variable":[{"key":"id","value":"{{group_id}}","description":"Group id."}]},"body":{"mode":"raw","raw":"{\n  \"enabled\": true,\n  \"priority\": 1\n}","options":{"raw":{"language":"json"}}},"description":"Edit, reprioritise or switch a product-group table on/off.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Delete a table and its bands","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/min-margins/groups/:id","host":["{{base_url}}"],"path":["min-margins","groups",":id"],"variable":[{"key":"id","value":"{{group_id}}","description":"Group id."}]},"description":"Delete a table and its bands.\n\nScope required: `margins:write` (Change the minimum-margin default, add, edit and delete cost bands and product-group tables.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Pushes","description":"Store push operations: read results, send prices by hand (rule prices for chosen products, one exact price, or the whole workspace), roll a push back. Never automatic pushing.","item":[{"name":"Store push operations, newest first","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/pushes","host":["{{base_url}}"],"path":["pushes"],"query":[{"key":"limit","value":"50","description":"Page size.","disabled":true},{"key":"cursor","value":"","description":"Opaque cursor from the previous page's next_cursor.","disabled":true},{"key":"status","value":"dryrun","description":"Filter on status.","disabled":true},{"key":"since","value":"","description":"Only operations created at or after this time.","disabled":true}]},"description":"Store push operations, newest first.\n\nScope required: `pushes:read` (Read store push operations and their per-product results.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Send prices to the store now, by hand","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/pushes","host":["{{base_url}}"],"path":["pushes"]},"body":{"mode":"raw","raw":"{\n  \"mode\": \"all\",\n  \"dry_run\": true\n}","options":{"raw":{"language":"json"}}},"description":"Send prices to the store now, by hand.\n\nThree modes. `rule`: the products' rule prices for `product_ids` (one rule per call; `rule_id` optional when they share one) → 202 with the operation and the held items. `price`: one exact `price` for `product_id` → 201 once the store confirms. `all`: the whole workspace's rules, as Settings → Push now (`dry_run` previews) → 202 queued. Every mode is a MANUAL push: store gate, trial daily cap and the >50% per-item hold (`force` releases it per request) apply exactly as in the app. 403 pushes_not_enabled without the workspace's API price pushes setting; 422/409 push_refused with the gate's reason. Send an Idempotency-Key.\n\nScope required: `pushes:write` (Send prices to your store by hand (a rule's prices for chosen products, one exact price, or the whole workspace's rules) and roll a push back. Never switches automatic pushing on.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"The result of the last rollback (or preview) asked for on this push","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/pushes/:id/rollback","host":["{{base_url}}"],"path":["pushes",":id","rollback"],"query":[{"key":"preview","value":"true","description":"true for the preview's result.","disabled":true}],"variable":[{"key":"id","value":"{{push_id}}","description":"Push id."}]},"description":"The result of the last rollback (or preview) asked for on this push.\n\nScope required: `pushes:read` (Read store push operations and their per-product results.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Put back the prices a push changed","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"},{"key":"Idempotency-Key","value":"{{$guid}}","description":"Optional. Any unique string per logical request makes a retry safe for 24 hours; the same key with a different body is refused (409).","disabled":true}],"url":{"raw":"{{base_url}}/pushes/:id/rollback","host":["{{base_url}}"],"path":["pushes",":id","rollback"],"variable":[{"key":"id","value":"{{push_id}}","description":"Push id."}]},"body":{"mode":"raw","raw":"{\n  \"preview\": true\n}","options":{"raw":{"language":"json"}}},"description":"Put back the prices a push changed.\n\nFrom the snapshot taken before the push was sent. `preview` reports and sends nothing; `product_ids` limits it to some products; a price the store changed since the push is left alone unless `force`. Slow stores answer 202 pending after 25 s: poll with GET.\n\nScope required: `pushes:write` (Send prices to your store by hand (a rule's prices for chosen products, one exact price, or the whole workspace's rules) and roll a push back. Never switches automatic pushing on.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"One push operation with counts","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/pushes/:id","host":["{{base_url}}"],"path":["pushes",":id"],"variable":[{"key":"id","value":"{{push_id}}","description":"Push id."}]},"description":"One push operation with counts.\n\nScope required: `pushes:read` (Read store push operations and their per-product results.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Per-product results of a push","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/pushes/:id/items","host":["{{base_url}}"],"path":["pushes",":id","items"],"query":[{"key":"limit","value":"50","description":"Page size.","disabled":true},{"key":"cursor","value":"","description":"Opaque cursor from the previous page's next_cursor.","disabled":true},{"key":"status","value":"dryrun","description":"Filter on item status.","disabled":true}],"variable":[{"key":"id","value":"{{push_id}}","description":"Push id."}]},"description":"Per-product results of a push.\n\nScope required: `pushes:read` (Read store push operations and their per-product results.).\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]},{"name":"Meta","description":"Health and this document.","item":[{"name":"Liveness check (no key needed)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/health","host":["{{base_url}}"],"path":["health"]},"auth":{"type":"noauth"},"description":"Liveness check (no key needed).\n\nNo key needed.\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"This document (no key needed)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/openapi.json","host":["{{base_url}}"],"path":["openapi.json"]},"auth":{"type":"noauth"},"description":"This document (no key needed).\n\nNo key needed.\n\nReference: https://pricemaster.ai/docs/api"},"response":[]},{"name":"Postman collection of every endpoint, generated from this document (no key needed)","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{base_url}}/postman.json","host":["{{base_url}}"],"path":["postman.json"]},"auth":{"type":"noauth"},"description":"Postman collection of every endpoint, generated from this document (no key needed).\n\nImport the URL in Postman (Import → Link). Bearer auth is wired to the collection variable `api_key`; set it to your key and start with Workspace → GET /me.\n\nNo key needed.\n\nReference: https://pricemaster.ai/docs/api"},"response":[]}]}]}