Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scalev.com/llms.txt

Use this file to discover all available pages before exploring further.

May 2026
APIDocs
Storefront API physical checkout completion
Storefront API physical checkout now completes after the documented shipping option and checkout summary steps. Guest checkout, guest cart checkout, and authenticated customer checkout summary and confirm recompute the selected shipping cost on the server from the courier service, warehouse, destination, payment method, and cart items before creating the order. The checkout completion responses now all return the same public order response used by public order reads, so guest checkout, guest cart checkout, authenticated customer checkout confirm, and hosted public order pages expose the same order fields. The public discount-code check route is now a POST request with a JSON checkout context body and returns a typed ineligible response for unknown codes instead of treating the documented path as missing. Storefront API v3 payment-method discovery and checkout creation now reject no_payment so direct API submissions cannot create no-payment storefront orders. OpenAPI now also includes typed customer account, customer cart, customer order, and customer course contracts. Public order responses continue to include buyer-facing order links, totals, line items, shipping details, and payment fields such as public_order_url, payment_url, and pg_payment_info. Customer-account order responses now use a smaller buyer-safe order object. It preserves buyer-visible totals such as gross_revenue, plus the minimal Scalev customer portal compatibility fields needed for existing member order pages, including store name, logo, unique ID, and display flags. The customer-account order object omits financial_entity, warehouse, origin_address, business/operator analytics, net revenue, platform fee, provider, CRM, affiliate, and raw internals.
May 2026
API
Typed customer endpoint responses
Authenticated customer storefront endpoints now return typed responses instead of generic success envelopes. GET, PATCH, and PATCH /password on /customers/me/profile return customer, store, and is_generated_password_reset. Cart routes (GET /customers/me/cart, item add/update/delete) return the customer cart; cart item add now returns 201. Order routes use the buyer-safe order response for list and detail responses, with cursor pagination on the list endpoint. Course routes return typed access, section, and content responses, plus typed progress update responses.
May 2026
APIDocs
Storefront API checkout and payment contracts
Storefront API now documents browser-safe guest checkout preparation for shipping options and checkout summary. Public guest checkout can use a guest cart token or direct variant items, returns the same shipping option fields as the hosted storefront, and exposes summary fields as product_price, shipping_cost, other_income, other_income_name, and gross_revenue. OpenAPI now also includes named schemas for customer checkout endpoints and remaining normal-shopping storefront routes such as categories, variant pricing, cart merge, public order read/update, and discount-code checks. Storefront API docs now include checkout and payment rendering guidance based on the hosted success page behavior.
May 2026
API
Customer auth token responses
Storefront customer auth endpoints now return typed JWT token responses. POST /public/auth/login returns customer access and refresh tokens when the store can complete login directly, or { "message": "..." } when an OTP has been sent and the frontend should show the OTP entry step. POST /public/auth/otp/verify and POST /public/auth/jwt/refresh also return token_type, expires_in, and refresh_expires_in. Refresh tokens rotate on every refresh, are single-use, and revoke their token family when an already-rotated refresh token is reused. Send the access token as Authorization: Bearer <token> to /customers/me/* routes. Password reset links now use /reset-password?token=<reset-token> on the browser Origin when it matches a registered Storefront API allowed origin, and fall back to the hosted storefront custom domain otherwise. The regular hosted member area reset URL is unchanged.
May 2026
API
Storefront catalog schema fixes
The public OpenAPI schema for GET /public/products/count now documents { "total": number }, and GET /public/products/{slug} now documents a storefront product detail response instead of the public order schema.
May 2026
API
Order payment response clarifications
Order payment responses now document pg_payment_info per provider type: manual methods such as bank_transfer and cod return an empty object; virtual account methods expose provider reference and account details; QRIS responses expose QR data or a QR image payload; e-wallet, card, and invoice methods may expose provider actions while the browser should use payment_url for hosted redirects. sub_payment_method is documented as the provider channel, such as a virtual-account bank code, when applicable.
May 2026
API
Storefront rate limiting
Storefront API requests using X-Scalev-Storefront-Api-Key or X-Scalev-Guest-Token are rate-limited as direct client/browser requests. Machine-authenticated business requests continue to be rate-limited per API key or OAuth installation. Rate-limit metadata is returned in X-Ratelimit-* headers.
May 2026
APIDashboardDocs
Browser-only Storefront API
Storefront API setup is now documented as separate from hosted Storefront configuration. Browser storefronts can use direct CORS-enabled Storefront API calls, X-Scalev-Guest-Token cart identity, public payment-method and guided location lookup endpoints, typed guest checkout, minimized public order reads, idempotent public payment creation, and the public store unique_id across setup and runtime routes. Customer login responses now document the direct-token and OTP-challenge outcomes, password reset links use /reset-password?token=<reset-token> on the validated storefront browser origin, Storefront API requests are documented as direct-client rate limited, and payment responses document when to use payment_url versus provider-specific pg_payment_info.
May 2026
API
Order search field selection
Order list search now accepts search_field so clients choose one searchable order column per request. When omitted, search_field defaults to order_id.
April 2026
Docs
Developer documentation
Published the first Scalev developer documentation pages for API authentication, OAuth authorization, webhooks, and order creation.