Replace an order's metadata document
Authorizations
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
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.
Path Parameters
Body
REPLACES the document. Every key you omit is removed, which is why this is a PUT on its own route rather than a field on a patch: the method is what says the omission was deliberate. Send {} to clear every caller-owned key. Omitting metadata entirely is refused rather than read as a clear.
At most 64 top-level keys serialising to at most 16384 bytes. Unlike a product's attributes this document is SHARED with the platform: optimize_vid is written by checkout and read back for order attribution, so naming it is refused and its stored value is re-attached across the replace.
Response
Success
