Create an HTML Mode public order

Page-scoped public endpoint for HTML Mode Scalev.checkout.createOrder. This route accepts HTML Mode order payloads with customer, destination, items, and shipping_option, requires X-Scalev-Page-Api-Key, and does not accept storefront public API keys. The page and store are resolved from the path and page API key; any page_unique_id or store_unique_id values supplied in the JSON body are ignored. Product prices, discounts, shipping, Other Income, the Store customer-fee policy, and service fees are recalculated from current backend data during creation; an earlier summary is not a confirmation input.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Public page unique ID.

Body Params

HTML Mode public order payload. Use customer, destination, and one combined items list for checkout details. Pass the chosen option returned by shippingOptions as shipping_option. The API ignores any supplied page_unique_id or store_unique_id and uses the path page plus the authenticated page API key instead.

form
object | null
customer
object

Buyer contact details submitted by an HTML Mode page.

destination
object

Buyer destination submitted by an HTML Mode page.

items
array of objects
length ≥ 1
items
string

Public order payment method code. Required for normal checkout. May be omitted when the store uses strict two-step Payment Link checkout; Scalev resolves it to payment_link. Virtual Accounts use flat method codes such as va_bca.

string | null
shipping_option
object

Optional compatibility value for direct checkout. When the order is resolved to payment_link, the API ignores this value and creates the order with zero Other Income. The hosted Payment Link quotes the frozen Store charge after a concrete method is chosen.

string | null

Optional compatibility label for direct checkout. It is ignored during payment_link order creation; the hosted link supplies the frozen Store label with the concrete-method quote.

string | null
boolean

Optional creation-only override for the page post-payment redirect. This field accepts only the native JSON booleans true and false; null, strings, numbers, arrays, and objects are rejected. Omit it to inherit the page setting. Set it to false to force Scalev's hosted success flow for this order and clear the redirect snapshot. Set it to true together with post_payment_redirect_url to replace the page setting for this order.

uri
length ≤ 200

Absolute HTTPS destination required when is_post_payment_redirect_enabled is true. HTTP is accepted only for loopback development hosts outside production. Supplying this field without is_post_payment_redirect_enabled does not enable an order override; the page setting is inherited. The canonical value is snapshotted at creation and cannot be changed by order updates.

string | null
string | null
string | null

Runtime-generated form reCAPTCHA token.

uri | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
metadata
object | null
Headers
string
required

Publishable page public API key for the page_unique_id path page. Storefront public API keys are not accepted on page-scoped public routes.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json