Skip to content

Store pushes

Read every operation that sent prices to your store, send prices by hand (a rule's prices, one exact price, or the whole workspace), and roll a push back.


Store Pushes

Push operations

A push operation is one batch of prices Pricemaster sent (or rehearsed) to your store: the daily automatic run (triggered_by: rule_tick), a manual push from the app (manual) or a migration step (cutover). status moves pending → running → completed (or failed / cancelled); dryrun is a rehearsal that sent nothing. Reading pushes is the way to reconcile what changed on the store and why.

GET/v1/pushes pushes:read

Push operations, newest first.

Parameters

limit1–200, default 25.
cursorNext page.
statusdryrun, pending, running, completed, failed, cancelled.
sinceISO-8601; only operations created at or after.

Example

curl "https://api.pricemaster.ai/v1/pushes?status=completed&since=2026-10-25T00:00:00Z" -H "Authorization: Bearer $PRICEMASTER_KEY"
{
  "currency": "GBP",
  "tax_rate": "20.00",
  "data": [
    {
      "id": 4512,
      "status": "completed",
      "type": "price_update",
      "triggered_by": "rule_tick",
      "store": "tradecounterdirect.myshopify.com",
      "items": {
        "total": 1184,
        "applied": 1172,
        "held": 12,
        "failed": 0,
        "in_flight": 0
      },
      "error": null,
      "created_at": "2026-10-26T05:00:04.000Z",
      "started_at": "2026-10-26T05:00:09.000Z",
      "completed_at": "2026-10-26T05:03:51.000Z"
    },
    "…"
  ],
  "next_cursor": "eyJpZCI6NDQ5OH0",
  "has_more": true
}
GET/v1/pushes/{id} pushes:read

One operation with its counts.

Parameters

idPush id.

Example

curl https://api.pricemaster.ai/v1/pushes/4512 -H "Authorization: Bearer $PRICEMASTER_KEY"
{
  "currency": "GBP",
  "tax_rate": "20.00",
  "data": {
    "id": 4512,
    "status": "completed",
    "type": "price_update",
    "triggered_by": "rule_tick",
    "store": "tradecounterdirect.myshopify.com",
    "items": {
      "total": 1184,
      "applied": 1172,
      "held": 12,
      "failed": 0,
      "in_flight": 0
    },
    "error": null,
    "created_at": "2026-10-26T05:00:04.000Z",
    "started_at": "2026-10-26T05:00:09.000Z",
    "completed_at": "2026-10-26T05:03:51.000Z"
  }
}

Per-product results

Each item is one product in the operation. applied means the store confirmed the new price; held means a safety limit stopped it (for example a move of more than 50% in one step, or a trial's daily cap) and the price did not change; sent is still awaiting the store's acknowledgement; item_error and push_failed carry the store's message in error.

GET/v1/pushes/{id}/items pushes:read

The products in a push with before/after prices and outcome.

Parameters

idPush id.
limit1–200, default 100.
cursorNext page.
statusapplied, held, sent, item_error, push_failed, dryrun.

Example

curl "https://api.pricemaster.ai/v1/pushes/4512/items?status=held" -H "Authorization: Bearer $PRICEMASTER_KEY"
{
  "currency": "GBP",
  "tax_rate": "20.00",
  "data": [
    {
      "id": 9120331,
      "product_id": 50122,
      "sku": "DCF887N-XJ",
      "from_price": {
        "ex_tax": "99.16",
        "inc_tax": "118.99"
      },
      "to_price": {
        "ex_tax": "45.83",
        "inc_tax": "55.00"
      },
      "rule": "Catch all: 1% above cheapest",
      "send_type": "auto",
      "status": "held",
      "error": "Held: a 53.8% decrease in one step exceeds the 50% safety limit",
      "at": "2026-10-26T05:00:09.000Z"
    },
    "…"
  ],
  "next_cursor": null,
  "has_more": false
}
Sending Prices

Send prices to the store by hand

With pushes:write (and the workspace's API price pushes switch on) a key can do what a person does from the product page, the grid and Settings: send a rule's prices for chosen products, send one exact price, or run the whole workspace's rules now. Every one of these is a manual push in Pricemaster's terms: the store must be live for pushing, a trial's daily manual cap counts each product, a move of more than 50% in one step is held unless you pass force, and the price in Pricemaster changes only after the store confirms. The operation and its per-product results appear in /v1/pushes like any other.

Nothing here can switch automatic pushing on. The daily automatic push, sales-step automation, Margin Miner and the zero-price guard are switched on by a person in the app and have no API. A key can send prices today; it cannot arrange for prices to be sent tomorrow.
POST/v1/pushes pushes:write bucket: engine

Send prices now. mode rule, price or all.

rule: the products' rule prices are recomputed now and sent for product_ids (up to 500). All products must be priced by one rule; rule_id is optional when they share one, and a mixed set is refused with the grouping so you can send one request per rule. Answers 202 with the operation id, how many were sent and which were held and why. price: one exact price for product_id (a bare number is ex tax; {"inc_tax": …} is accepted); the store is asked synchronously and the answer is 201 with the applied price. all: queues the whole workspace's rules exactly as Settings → Push now (dry_run computes everything and sends nothing); answers 202 queued. Send an Idempotency-Key so a retried request cannot push twice.

Request body

moderule, price or all.
product_idsmode rule.
rule_idmode rule, optional.
product_idmode price.
pricemode price.
forceRelease the 50% hold for this request.
dry_runmode all: preview only.

Example

curl -X POST https://api.pricemaster.ai/v1/pushes -H "Authorization: Bearer $PRICEMASTER_KEY" -H "Content-Type: application/json" -H "Idempotency-Key: erp-push-2026-10-26-001" \
  -d '{"mode": "rule", "product_ids": [48213, 50122, 50123]}'
{
  "currency": "GBP",
  "tax_rate": "20.00",
  "push_id": 4590,
  "rule_id": 84,
  "sent": 2,
  "held": [
    {
      "product_id": 50122,
      "sku": "DCF887N-XJ",
      "reason": "the move is more than 50% (99.16 → 45.83)"
    }
  ],
  "status": "pending",
  "items_url": "/v1/pushes/4590/items"
}
# one exact price, inc tax as the shop shows it
curl -X POST https://api.pricemaster.ai/v1/pushes -H "Authorization: Bearer $PRICEMASTER_KEY" -H "Content-Type: application/json" \
  -d '{"mode": "price", "product_id": 48213, "price": {"inc_tax": 99.99}}'
{
  "currency": "GBP",
  "tax_rate": "20.00",
  "push_id": 4591,
  "product_id": 48213,
  "from_price": {
    "ex_tax": "84.16",
    "inc_tax": "100.99"
  },
  "to_price": {
    "ex_tax": "83.33",
    "inc_tax": "100.00"
  },
  "store_price": "99.99",
  "status": "completed"
}
# the whole workspace, as Settings → Push now; dry_run first
curl -X POST https://api.pricemaster.ai/v1/pushes -H "Authorization: Bearer $PRICEMASTER_KEY" -H "Content-Type: application/json" -d '{"mode": "all", "dry_run": true}'

Refusals carry the store gate's own reason: 422 push_refused with details.code such as store_not_live, trial_daily_limit, nothing_to_send (with the held list), or needs_force; 409 push_refused when a push is already in flight for the workspace or a trial refuses the bulk run.

Rolling a push back

POST/v1/pushes/{id}/rollback pushes:write bucket: engine

Put back the prices a push changed, from the snapshot taken before it was sent.

preview: true reports what would happen and sends nothing. product_ids limits the rollback to some products of the push. A price the store has changed since the push is left alone and counted in changed_since; force restores those too. A store that is slow to answer gets 202 pending: true after 25 seconds: poll with GET. The rollback is itself a push operation (rollback_push_id).

Parameters

idThe push to undo.

Request body

previewReport only.
forceAlso restore prices changed on the store since.
product_idsOptional subset.

Example

curl -X POST https://api.pricemaster.ai/v1/pushes/4590/rollback -H "Authorization: Bearer $PRICEMASTER_KEY" -H "Content-Type: application/json" -d '{"preview": true}'
{
  "currency": "GBP",
  "tax_rate": "20.00",
  "push_id": 4590,
  "pending": false,
  "ok": true,
  "preview": true,
  "rollback_push_id": null,
  "restored": 2,
  "changed_since": 0,
  "skipped": [],
  "code": null,
  "message": null
}
GET/v1/pushes/{id}/rollback pushes:read

The result of the last rollback (or, with ?preview=true, the last preview) asked for on this push within the hour.

Parameters

idPush id.
previewtrue for the preview's result.