Documentation roadmap
The original roadmap — orders, status with comments and delivery with tracking — has been fully delivered. This page now tracks the next evolution cycles of the Yep REST API.
Already available
Items previously planned in the roadmap that are now certified and documented.
Orders — orders, invoices, shipments, credit memos and history
Full operational endpoint family for the order lifecycle: deterministic listing with pagination, detailed lookup, cancel, hold/unhold, full or partial invoicing, shipping with tracking (single or batch), email resend, online or offline refund and history with status changes. Supersedes the original "Orders", "Status with comments" and "Delivery with tracking" items. See Orders.
Customers & addresses
List, create, update and delete customers and their addresses, with search by email, taxvat, the cpf alias and any EAV attribute. See Customers & addresses.
Planned upcoming evolutions
Items acknowledged as out of current scope and natural candidates for the next cycle.
/api2/order family, with quota headers and backoff.