POST
Open an order edit

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Body

application/json

Opens an EMPTY change set against a placed order: status created, diff_total_minor 0, nothing staged. An order may have only one open edit, so a second create answers 409 rather than splitting one amendment across two change sets; fetch the existing edit instead of retrying. NOTHING STAGED THROUGH THIS API IS EVER APPLIED BY IT. Confirming an edit charges the shopper's stored card off-session, refunds, mints store credit and rewrites the order, so it is not published: a merchant confirms in the dashboard.

order_id
string
required

The placed order this edit amends.

Response

Created

data
object