Skip to content

Developer API: overview and getting access

What the Pricemaster API offers, who can use it, and the four steps from signing up to your first authenticated request.


What It Is

Your Pricemaster workspace, readable from your own systems

The Pricemaster API is a REST interface at https://api.pricemaster.ai/v1. It gives your ERP, data warehouse, BI tool or in-house scripts the same facts the app shows: your products with cost, price, stock and market position; the competitor offers behind every price; your pricing rules and what they would set right now; your tags; and the results of every push Pricemaster has sent to your store.

Products

Every SKU with identifiers, cost, price, RRP, MAP, stock, tags, rule and competitor count. Poll for changes with updated_since.

Market

Live competitor offers per product, daily price history per listing, the sellers tracked for you, and the engine's recommended price with its reasoning.

Rules & tags

Your pricing rules, their settings and assigned products; your tags with counts.

Pushes

Every store push operation, its counts, and the per-product applied / held / failed results.

Configuration, and manual pushes behind a second switch. The API gives full control of your workspace's configuration: product facts, pricing rules (create, edit, switch on and off, reorder, assign products, simulate), tags, minimum margins, and which competitors and offers count. It can also 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, once Pricemaster enables API price pushes for the workspace on top of writes. Every push is a manual push with the app's own safeguards. What no key can ever do is switch automatic daily pushing on: that stays a person's decision in the app. Keys start read-only.
Who Can Use It

Any Pricemaster workspace, once the API is enabled for it

The API is a per-workspace feature. Pricemaster switches it on for a workspace; from then on any member of that workspace can create and revoke API keys in Settings → API access. A key belongs to exactly one workspace: it can read nothing from any other, even if the person who created it belongs to several. If you run several workspaces, create one key per workspace.

Keys start read-only. The write scopes (products:write, rules:write, tags:write, margins:write, market:write) become available after Pricemaster enables writes for the workspace, and pushes:write after a second, separate switch for price pushes; ask when you request access, or later.

Getting Access

From sign-up to your first request

1

Create your Pricemaster account and workspace

New to Pricemaster? Sign up at pricemaster.ai/signup, connect your store or sheet and let the first import finish. The Quickstart walks through it. The API reads the same workspace the app shows, so there is nothing to set up twice.

2

Request API access from Settings

In the app open Settings → API access and press Request API access. Tell us what you intend to connect and whether you need writes. The Pricemaster team enables the Developer API for the workspace, usually the same working day, and confirms by email.

3

Create a key

Back in Settings → API access, name the key after the system that will use it, tick only the scopes it needs, optionally set an expiry, and press Create key. The key (pmk_live_…) is shown once. Copy it into your secret store straight away; if it is lost, revoke it and create another.

4

Make your first call

Send the key as a bearer token to /v1/me. The answer names the workspace the key unlocks, its scopes, currency and tax rate. From there, read the endpoint pages in the sidebar.

curl https://api.pricemaster.ai/v1/me \
  -H "Authorization: Bearer pmk_live_YOUR_KEY_HERE"
Trials included. A workspace on a free trial can use the API once it is enabled; exports that the trial locks in the app stay locked in the API too.
Endpoint Map

Everything the API offers today

AreaEndpointsScopeGuide
WorkspaceGET /v1/meany keyWorkspace
ProductsGET /v1/products, GET /v1/products/{id}, GET /v1/products/by-sku/{sku}, GET /v1/products/{id}/price-history, PATCH /v1/products/{id}products:read, products:writeProducts
MarketGET /v1/products/{id}/offers, GET /v1/products/{id}/offers/{listing_id}/history, GET /v1/products/{id}/recommendation, GET /v1/sellers, PATCH /v1/sellers/{id}, PUT …/offers/{listing_id}/override, POST …/offers/{listing_id}/rescrapemarket:read, market:writeMarket data
RulesGET /v1/rules, POST /v1/rules, GET|PATCH|DELETE /v1/rules/{id}, PUT /v1/rules/order, GET|POST /v1/rules/{id}/products, POST …/products/remove, DELETE …/products/{product_id}, POST /v1/rules/{id}/simulaterules:read, rules:writeRules & tags
TagsGET|POST /v1/tags, GET|PATCH|DELETE /v1/tags/{id}, GET|POST /v1/tags/{id}/products, POST …/products/remove, DELETE …/products/{product_id}tags:read, tags:writeRules & tags
Minimum marginsGET|PATCH /v1/min-margins, POST /v1/min-margins/bands, PATCH|DELETE /v1/min-margins/bands/{id}, POST /v1/min-margins/groups, PATCH|DELETE /v1/min-margins/groups/{id}margins:read, margins:writeMinimum margins
PushesGET|POST /v1/pushes, GET /v1/pushes/{id}, GET /v1/pushes/{id}/items, POST|GET /v1/pushes/{id}/rollbackpushes:read, pushes:writeStore pushes
MetaGET /v1/health, GET /v1/openapi.json, GET /v1/postman.jsonnoneConventions

Machine-readable description: https://api.pricemaster.ai/openapi.json (OpenAPI 3.1). Ready-made Postman collection: https://api.pricemaster.ai/postman.json. See OpenAPI & tooling.

Coming Next

On the roadmap

  • Webhooks for push completed, import completed and own-price changed, signed with a per-endpoint secret.
  • Batch product upsert through the same import pipeline the app uses, so new SKUs are matched and linked like any other import.
  • Dynamic tags by API: creating criteria-driven tags (today they are built in the app; their membership is read-only here).
  • OAuth 2.0 for apps that many Pricemaster customers install, and a GraphQL endpoint on the same authentication.

Need one of these sooner? Email [email protected].