Yep Platform REST API

Technical reference for certified integrations. OAuth 2.0, catalog, operations and security — documentation structured by functional domain, ready for integration, ERP and certification teams.

OAuth 2.0 Catalog Stock Pricing Security 2026

Corporate-grade documentation for your API

This version is organized for publication on the Yep Platform website, with navigation by functional domain, institutional tone and practical focus for integration teams. The content consolidates the available endpoints, OAuth flows and recent hardening for validation, security and operations.

100%

CompatibleEndpoints in the already certified format.

OAuth

Hardened authSecret protection and sanitized auditing.

Queue

Robust processingStock and pricing with higher predictability.

Docs

Ready to growPrepared for orders, status and tracking.

Quick navigation

Shortcuts to the main modules of the REST API documentation.

Getting startedPrerequisites, OAuth token and first authenticated call. OAuth 2.0Token issuance, refresh and healthcheck. ProductsCreate, update, query, delete, link and images. PricingBase, promotional and group prices. Attributes & structureGlobal attributes, pointwise options, attribute sets, groups and linking. Customers & addressesCRUD for customers, addresses, EAV attributes and default markers. OrdersOrders, invoices, shipments with tracking, credit memos and history. Security & responsesBest practices, partial_success and response semantics.

What this documentation covers

Functional scope organized into seven main domains.

Area	Content	Main use
General guide	Introduction, getting started and what's new	Technical onboarding and institutional overview
Authentication	Bearer Token, OAuth 2.0, refresh and healthcheck	Integration authorization
Catalog	Products, stock, pricing, categories, attributes and options	Core API operations
Customers	Customers, addresses, EAV attributes and default markers	Profile sync with ERP/CRM
Orders	Orders, invoices, shipments, credit memos and order history	Full order lifecycle — OMS, ERP, WMS and marketplaces
Operations	Security and response semantics	Support, troubleshooting and certification
Roadmap	Upcoming Yep REST API evolutions	Planning and integrator communication