POST
Register a deliverable file

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.

Path Parameters

configId
string
required

Body

application/json

Registers an object already uploaded to storage; it does not upload one. The response carries the file WITHOUT its key, which is the shape every read serves.

name
string
required

What the buyer sees, and unique within the product. Every upload is presigned a fresh object key, so the name is the only thing that can tell a re-upload from a second file; a duplicate is 409 file_exists.

file_key
string
required
write-only

The storage object, which must be in this store's namespace (stores/{store_id}/...). WRITE-ONLY: accepted on the way in and never returned on the way out, on this 201 or on any read, so keep your own record of which object you registered under which file id.

mime_type
string
size_bytes
integer

Response

Created

data
object