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.

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; Nexus resolves it to payment_link. Virtual Accounts use flat method codes such as va_bca.

string | null
shipping_option
object
string | null
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