Authentication
Authorization: Bearer <HALLIFY_PREORDER_DRAFT_TOKEN>Guest-owned capability for a public preorder draft.
Parameters
draftReferencePath · RequiredOpaque reference identifying the public preorder draft; authorization still requires the separate draft capability.
stringFull definition
{ "type": "string", "example": "example" }idempotency-keyHeader · RequiredRequired idempotency key, up to 128 characters
stringFull definition
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }originHeader · OptionalActual browser Origin. Required for drafts and manage grants with classified CANONICAL or STOREFRONT issuance and must match their recorded issuance and current authority. Widget continuations retain their original frame Origin and parent binding; the draft or manage capability authorizes continuation without a fresh widget bootstrap proof. Existing records with NULL issuance metadata retain their legacy channel-origin rules.
stringFull definition
{ "type": "string", "maxLength": 2048, "example": "example" }
Request body
Required
Uses the draft capability to consume the quote bound to that draft, create the preorder atomically, and issue a revocable manage grant scoped only to the new preorder. Internal order data is not exposed.
application/json
Full definition
{
"$ref": "#/components/schemas/AcceptPublicPreorderQuoteDto"
}Responses
200Returns the created preorder projection and one-time manage grant.
Full definition
{
"$ref": "#/components/schemas/PreorderPublicAcceptQuoteResultDto"
}{
"orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
"fulfillmentId": "0a81282f-ea3b-40be-8ef7-4ad39e32ea88",
"status": "DRAFT",
"revision": 1,
"manageExchangeToken": "synthetic-example-credential",
"manageExchangeExpiresAt": "2026-12-31T18:00:00.000Z"
}401Rejects a missing, malformed, expired, revoked, or invalid preorderDraftToken credential at the owning domain boundary.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}402Commercial coverage is required for new demand, or this operation has no original commercial admission evidence. Existing authorized reads and financial recovery remain available.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 402,
"error": "errors:http.failure",
"code": "HTTP_402",
"message": "errors:http.failure",
"translationKey": "errors:http.failure"
}409Idempotency key is already in progress or was reused with a different payload
Full definition
{
"$ref": "#/components/schemas/IdempotencyConflictError"
}{
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
}503Authoritative commercial state is unavailable or cannot be read within its bounded source contract. Retry the same operation after recovery.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Schemas
AcceptPublicPreorderQuoteDto
Uses the draft capability to consume the quote bound to that draft, create the preorder atomically, and issue a revocable manage grant scoped only to the new preorder.
quoteIdRequiredHallify UUID identifying quote associated with accept public preorder quote.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Hallify UUID identifying quote associated with accept public preorder quote.", "example": "123728f6-ac4b-43a8-8f9e-44585ec81783" }quoteTokenRequiredSigned quote token binding acceptance to the priced preorder draft, quote contents, and expiry. It cannot be reused for a different draft or quote.
stringFull definition
{ "type": "string", "description": "Signed quote token binding acceptance to the priced preorder draft, quote contents, and expiry. It cannot be reused for a different draft or quote.", "example": "synthetic-example-credential" }
Full definition
{
"type": "object",
"properties": {
"quoteId": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying quote associated with accept public preorder quote.",
"example": "123728f6-ac4b-43a8-8f9e-44585ec81783"
},
"quoteToken": {
"type": "string",
"description": "Signed quote token binding acceptance to the priced preorder draft, quote contents, and expiry. It cannot be reused for a different draft or quote.",
"example": "synthetic-example-credential"
}
},
"required": [
"quoteId",
"quoteToken"
],
"description": "Uses the draft capability to consume the quote bound to that draft, create the preorder atomically, and issue a revocable manage grant scoped only to the new preorder.",
"example": {
"quoteId": "123728f6-ac4b-43a8-8f9e-44585ec81783",
"quoteToken": "synthetic-example-credential"
}
}PreorderPublicAcceptQuoteResultDto
Returns the created preorder projection and one-time manage grant.
orderIdRequiredHallify UUID identifying order associated with preorder public accept quote.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Hallify UUID identifying order associated with preorder public accept quote.", "example": "f3127edf-ce4f-4da7-8be5-81b962024e6c" }fulfillmentIdRequiredHallify UUID identifying fulfillment associated with preorder public accept quote.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Hallify UUID identifying fulfillment associated with preorder public accept quote.", "example": "0a81282f-ea3b-40be-8ef7-4ad39e32ea88" }statusRequiredCurrent lifecycle status of preorder public accept quote; allowed values are DRAFT, HELD, CONFIRMED, IN_PREPARATION, READY_FOR_HANDOFF, OUT_FOR_DELIVERY, COMPLETED, CANCELED, EXPIRED.
stringFull definition
{ "type": "string", "enum": [ "DRAFT", "HELD", "CONFIRMED", "IN_PREPARATION", "READY_FOR_HANDOFF", "OUT_FOR_DELIVERY", "COMPLETED", "CANCELED", "EXPIRED" ], "description": "Current lifecycle status of preorder public accept quote; allowed values are DRAFT, HELD, CONFIRMED, IN_PREPARATION, READY_FOR_HANDOFF, OUT_FOR_DELIVERY, COMPLETED, CANCELED, EXPIRED.", "example": "DRAFT" }revisionRequiredMonotonic optimistic-concurrency revision for preorder public accept quote. Accepted values enforce minimum 1.
integerFull definition
{ "type": "integer", "minimum": 1, "description": "Monotonic optimistic-concurrency revision for preorder public accept quote. Accepted values enforce minimum 1.", "example": 1 }timingModeOptionalExplicit customer timing intent bound to the retained native draft, quote or order. Omitted for legacy scheduled records.
stringFull definition
{ "type": "string", "enum": [ "ASAP", "SCHEDULED" ], "description": "Explicit customer timing intent bound to the retained native draft, quote or order. Omitted for legacy scheduled records.", "example": "ASAP" }manageExchangeTokenRequiredSingle-use exchange token returned after quote acceptance and used only to obtain the long-lived preorder manage capability.
stringFull definition
{ "type": "string", "description": "Single-use exchange token returned after quote acceptance and used only to obtain the long-lived preorder manage capability.", "example": "synthetic-example-credential" }manageExchangeExpiresAtRequiredRFC 3339 timestamp for manage exchange expires at; offsets represent the same absolute instant.
string · date-timeFull definition
{ "type": "string", "format": "date-time", "description": "RFC 3339 timestamp for manage exchange expires at; offsets represent the same absolute instant.", "example": "2026-12-31T18:00:00.000Z" }
Full definition
{
"type": "object",
"properties": {
"orderId": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying order associated with preorder public accept quote.",
"example": "f3127edf-ce4f-4da7-8be5-81b962024e6c"
},
"fulfillmentId": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying fulfillment associated with preorder public accept quote.",
"example": "0a81282f-ea3b-40be-8ef7-4ad39e32ea88"
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"HELD",
"CONFIRMED",
"IN_PREPARATION",
"READY_FOR_HANDOFF",
"OUT_FOR_DELIVERY",
"COMPLETED",
"CANCELED",
"EXPIRED"
],
"description": "Current lifecycle status of preorder public accept quote; allowed values are DRAFT, HELD, CONFIRMED, IN_PREPARATION, READY_FOR_HANDOFF, OUT_FOR_DELIVERY, COMPLETED, CANCELED, EXPIRED.",
"example": "DRAFT"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "Monotonic optimistic-concurrency revision for preorder public accept quote. Accepted values enforce minimum 1.",
"example": 1
},
"timingMode": {
"type": "string",
"enum": [
"ASAP",
"SCHEDULED"
],
"description": "Explicit customer timing intent bound to the retained native draft, quote or order. Omitted for legacy scheduled records.",
"example": "ASAP"
},
"manageExchangeToken": {
"type": "string",
"description": "Single-use exchange token returned after quote acceptance and used only to obtain the long-lived preorder manage capability.",
"example": "synthetic-example-credential"
},
"manageExchangeExpiresAt": {
"type": "string",
"format": "date-time",
"description": "RFC 3339 timestamp for manage exchange expires at; offsets represent the same absolute instant.",
"example": "2026-12-31T18:00:00.000Z"
}
},
"required": [
"orderId",
"fulfillmentId",
"status",
"revision",
"manageExchangeToken",
"manageExchangeExpiresAt"
],
"description": "Returns the created preorder projection and one-time manage grant.",
"example": {
"orderId": "f3127edf-ce4f-4da7-8be5-81b962024e6c",
"fulfillmentId": "0a81282f-ea3b-40be-8ef7-4ad39e32ea88",
"status": "DRAFT",
"revision": 1,
"manageExchangeToken": "synthetic-example-credential",
"manageExchangeExpiresAt": "2026-12-31T18:00:00.000Z"
}
}TranslatedErrorDto
Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.
statusCodeRequiredHTTP status code repeated from the response.
integerFull definition
{ "type": "integer", "description": "HTTP status code repeated from the response.", "example": 400 }errorRequiredTranslation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.
stringFull definition
{ "type": "string", "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.", "example": "errors.request.invalid" }codeRequiredStable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.
stringFull definition
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions." }messageRequiredTranslation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application." }translationKeyRequiredCanonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }validationErrorsOptionalField validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.
arrayFull definition
{ "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsOptionalOptional domain-specific blocker or validation details
oneOfFull definition
{ "description": "Optional domain-specific blocker or validation details", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Full definition
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP status code repeated from the response.",
"example": 400
},
"error": {
"type": "string",
"description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Optional domain-specific blocker or validation details",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.
fieldRequiredPublic field path. Nested properties and array indices are separated by dots.
stringFull definition
{ "type": "string", "example": "email", "description": "Public field path. Nested properties and array indices are separated by dots." }translationKeyRequiredTranslation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog." }codeRequiredStable validator identifier for this field failure. Custom validators may define additional identifiers.
stringFull definition
{ "type": "string", "example": "isEmail", "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers." }messageRequiredTranslation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }
Full definition
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Public field path. Nested properties and array indices are separated by dots."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.
Full definition
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
"example": "example"
}IdempotencyConflictError
Idempotency key is already in progress or was reused with a different payload.
Full definition
{
"example": {
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
},
"allOf": [
{
"$ref": "#/components/schemas/TranslatedErrorDto"
},
{
"type": "object",
"required": [
"code"
],
"properties": {
"statusCode": {
"type": "integer",
"enum": [
409
],
"description": "HTTP 409 conflict status.",
"example": 409
},
"code": {
"type": "string",
"enum": [
"IDEMPOTENCY_REQUEST_NOT_READY",
"IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
"IDEMPOTENCY_REQUEST_IN_PROGRESS",
"IDEMPOTENCY_SCOPE_INCOMPLETE"
],
"description": "Allowed code for idempotency conflict error: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
"example": "IDEMPOTENCY_REQUEST_NOT_READY"
}
},
"example": {
"code": "IDEMPOTENCY_REQUEST_NOT_READY"
}
}
],
"description": "Idempotency key is already in progress or was reused with a different payload."
}