Yep Platform logo
REST API · Yep Platform Technical documentation for certified integrations
General guide › What's new

What's new in the REST API

Summary of recent evolutions already rolled out on the API and reflected in this documentation.

Changelog Hardening 2026

September 2026 — Full and selective bulk image deletion New

New write operation on the plural image route. The existing single-image delete keeps its contract.

Clear the galleryDELETE /api2/products/imagens with delete_all: true removes every image of a product.
Selective bulk deleteitems mode removes specific images from several products in one call.
No partial deletionThe batch is validated first; any error rejects the whole request.
  • Up to 50 products and 500 unique image_ids per request.
  • Ownership validation: each image_id must belong to the given product.
  • Already absent IDs are counted in already_absent_count, without error.
  • Bulk deletion is global and does not take store_id.
  • Requires the products/images permission.
  • DELETE /api2/products/imagem remains available to remove one image per call.

See in detail

Full contract on Catalog › Images.

September 2026 — Product image lookup and inventory New

Release of the read-only product image GET endpoints, already validated in production. The change is additive: the image upload, update and delete endpoints keep their existing contract.

New GET /api2/products/imagemLists the images of a product by SKU or ID, with roles, label, position and disabled.
New GET /api2/products/imagensGlobal image inventory of the catalog for initial load and full reconciliation.
Cursor paginationhas_next and next_cursor, with no page or offset.
  • Explicit store_id support; 0 is the administrative/global scope.
  • Returns the image, small_image and thumbnail roles; types=[] is valid.
  • Disabled images are included with disabled=true.
  • An existing product with no images returns 200 with images=[]; a missing product returns 404.
  • The new GETs use the products/read permission and are read-only: they do not touch the product, gallery, queue or indexes.
  • Image updates use PUT; PATCH responds 405. The documentation has been corrected.

See in detail

Full technical documentation on the new Catalog › Images page. The Postman collection was updated with the three new requests.

September 2026 — Enriched catalog lookups New

Release of the certified product, price and stock lookups. The change is additive: no create, update, delete, queue or listing endpoint was altered.

Enriched productThe single lookup on GET /api2/products now includes human-readable references, a pricing summary and an inventory summary.
New GET /api2/priceDetailed price lookup with an explicit store and customer group context.
New GET /api2/stockDetailed stock configuration lookup, including effective salability.
  • The single product lookup now responds with HTTP 200.
  • The new GET endpoints are read-only: they neither enqueue work nor trigger reindexing.
  • Configurable products expose the indexed price range where applicable and never artificially aggregate the quantity of associated products.
  • Historical fields remain unchanged — the enriched objects are additive.

See in detail

Full technical documentation on the Products, Pricing and Stock pages.

Recent API improvements

Main deliveries that reinforced stability, security and predictability of the API.

  • Higher robustness on queue-based stock and pricing processing.
  • Clearer validation for invalid fields, attributes and values on product update.
  • Improved semantics for partial_success.
  • Leaner and more selective reindex.
  • Hardening of OAuth, auditing and operational endpoints.

New capabilities already available

Secure OAuthNew client_secret with protected storage and admin masking.
Transparent partial updateClear response with invalid_fields, invalid_attributes and invalid_attribute_values.
More predictable operationRobust queue, atomic claim and selective reindex.

Products endpoint evolutions

Three recent improvements make GET /api2/products more deterministic in multi-store setups and more efficient for batch syncs.

Optional store_idExplicit store selection in multi-store environments.
Pagination metadatatotal, last_page and has_next via include_pagination=1.
Configurable limitDefault 20, max 200, invalid values normalized.

See in detail

Full technical documentation on the Products page.

Categories endpoint evolutions New

GET /api2/category now supports paginated listing with the same guarantees already available on the products endpoint. The full category tree can be walked without fetching one category at a time.

Full listingGET /api2/category returns all categories with predictable pagination.
Configurable limitDefault 20, max 200, invalid values normalized.
Optional store_idExplicit, deterministic multi-store context.
Optional metadatatotal, last_page and has_next via include_pagination=1.
Fetch by ID?id=61 preserved for single fetch.
Deterministic pagination?page=N walks the tree safely.

See in detail

Full technical documentation on the Categories page.

Yep Platform REST API · Static documentation ready to publish