Skip to content
Create API key

API changelog

October 14

  • Per-key quotas are enforced. Each key allows 1,000 requests a day and 20,000 a month by default. Every authenticated request counts. Past either limit the API answers 429 quota_exceeded until the count resets (daily at 00:00 UTC, monthly on the 1st). See errors and rate limits.
  • Sales and order status need a secret key. POST /ingest/sale and POST /ingest/order-status now refuse publishable keys with 403 secret_key_required.
  • Reorder requests need a secret key. POST /ingest/event with "type": "reorder_request" and order lines returns 403 secret_key_required on a publishable key.
  • API keys follow your plan. New keys can be created on Plunk Commerce and Studio Storefront. On other plans, key creation returns 402 api_requires_plan.
  • Shopper App API: Visualizer App keys are included with Plunk Commerce as well as Studio Storefront.

October 10

  • Shopper App API: the Room Planner surface (roomplanner key scope): bootstrap, render, save and send. See Room Planner.
  • Shopper App API: pattern direction and repeat on /visualizer/render.

October 5

  • Portal endpoints. New POST /ingest/order-status and GET /orders/requests. Reorder request events create order request drafts when your account runs the order desk.
  • Customer sales gains ?customerId=, ?groupBy=order|product, ?status=, ?q= and ?format=csv.
  • Dealers gains ?rep=, lifecycle stage and lapse risk on each row, a full profile with bill-to, ship-to, contacts and assigned rep on /dealers/{id}, ?comparison=previous_year on performance, and the new GET /dealers/lapse-risk.
  • Restock queue on GET /forecast/restock.
  • ?rep= on /products/top/{range}, ?customerId= on /contacts/interest, and ?availableToOrder= on /catalog.
  • Availability: new GET /products/{id}/availability.
  • Date ranges: an unknown range token now returns 400 bad_range with the accepted list (it used to fall back to this_year). New tokens: this_week, last_week, this_quarter, last_quarter.
  • Images: the images family (images:read, images:write) for creating, editing, approving and exporting product images.

September 23

  • COM/COL requests: new comcol family, GET /comcol/requests and GET /comcol/requests/{id}, scope comcol:read.
  • Shopper App API: COM/COL webhooks (comcol.request.submitted, comcol.request.accepted, comcol.request.declined), signed with HMAC-SHA256. See webhooks.

September 8

  • Customer and dealer responses return account names.

August 30

  • Sales ingest: new POST /ingest/sale. Posted orders land as real sales data.
  • Inventory ingest: new POST /ingest/inventory, scope inventory:write.

August 29

  • Semantic search (GET /products/search), trending (GET /products/trending) and model recommendations (GET /recommendations/model), including ?account= and ?contact=.

August 24

  • Event and identify ingest return 503 ingest_unavailable when an event can’t be recorded, instead of accepting it silently.

August 10

  • First release of the full v1 surface: capabilities, ingest, products, recommendations, reviews, locations, markets, visitor, catalog, dealers, store performance, enrich, audience performance, customer sales, contact interest and forecasting.
Was this helpful?

Still stuck? Contact support and include the job or page you were on.