NewPlatformDTC is in public betaPlatformDTC is in public beta — sign up and finish with a real store, no waitlist.Read the announcement →
← Changelog

v1.57

Products API for apps: batch reads, filters, bulk variant updates

Read and edit a whole catalog in a handful of requests. The Agent Gateway products API now does what apps need for bulk editing.

New for app developers

  • List products with their variants. GET /products?include=variants returns up to 250 products per call with every variant's price, compare-at price, SKU and stock. Filter by status, vendor, product_type, tag, collection_id, query (title, handle or SKU), ids and updated_at_min/max, choose fields with fields=, and page with a page_info cursor and Link header. GET /products/count counts matches. See Products.
  • Bulk variant update. POST /products/variants/bulk_update changes up to 250 variants in one call, with a result per variant and Idempotency-Key replay. See Bulk edit prices.
  • Rate-limit headers. Every response carries X-PlatformDTC-Api-Call-Limit: used/limit plus RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; a 429 adds Retry-After. One budget per key across the whole gateway. See Rate limits.

Changed

  • One money format on the gateway. Product and variant amounts are decimal strings in the store currency, "19.99", with currency on each product, in the list, the product detail and every write response. The product detail used to return integer cents and the list returned numbers in dollars. The dashboard API (/api/v1/products) still uses integer cents.
  • GET /products/{id} on the gateway always returns variants and images.

Fixed

  • The install docs sent merchants to api.platformdtc.com/api/v1/appstore/oauth/authorize, which answers a browser with 401. The consent page is https://platformdtc.com/apps/authorize. See Install flow.
  • The public API reference now documents GET/PUT /products/{id}, variant updates and GET /collections.