Sustema

ENTITY developer reference

ICOrderRequest

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Consumes existing delegated credits only. Entity-Max-Units is required and must cover the immutable quote ceiling; no card purchase or mandate creation. Both uniqueness constraints are enforced atomically in the same order/reservation transaction: (workspace,environment,client_order_reference) and (workspace,environment,quote_id). First reject a reused client reference bound to a different quote/digest/semantic body as idempotency_conflict/409 (do_not_retry, no new effect). Otherwise an already consumed identical quote returns its original owned order, even under a different unused reference/key; it preserves the originally accepted client reference and binds no new alias. A changed digest/semantic body conflicts. A reference already bound to another order never overrides the quote check. active_order_conflict is reserved for a distinct compatible-target overlap that cannot safely be coalesced, not duplicate acceptance of the same quote. Retention tombstones cannot resurrect an expired order.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

quote_id

Listed in this schema’s required array.

Declared type
"string"
Declared format
"uuid"
Reading definition for quote_id
{
  "type": "string",
  "format": "uuid",
  "x-profile-maxLength": "string_characters_max"
}

quote_digest

Listed in this schema’s required array.

Declared type
"string"
Reading definition for quote_digest
{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$",
  "x-profile-maxLength": "string_characters_max"
}

client_order_reference

Listed in this schema’s required array.

Declared type
"string"
Reading definition for client_order_reference
{
  "type": "string",
  "minLength": 1,
  "maxLength": 120,
  "x-profile-maxLength": "string_characters_max"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "quote_id": {
      "type": "string",
      "format": "uuid",
      "x-profile-maxLength": "string_characters_max"
    },
    "quote_digest": {
      "type": "string",
      "pattern": "^[a-f0-9]{64}$",
      "x-profile-maxLength": "string_characters_max"
    },
    "client_order_reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "x-profile-maxLength": "string_characters_max"
    }
  },
  "required": [
    "quote_id",
    "quote_digest",
    "client_order_reference"
  ],
  "additionalProperties": false,
  "description": "Consumes existing delegated credits only. Entity-Max-Units is required and must cover the immutable quote ceiling; no card purchase or mandate creation. Both uniqueness constraints are enforced atomically in the same order/reservation transaction: (workspace,environment,client_order_reference) and (workspace,environment,quote_id). First reject a reused client reference bound to a different quote/digest/semantic body as idempotency_conflict/409 (do_not_retry, no new effect). Otherwise an already consumed identical quote returns its original owned order, even under a different unused reference/key; it preserves the originally accepted client reference and binds no new alias. A changed digest/semantic body conflicts. A reference already bound to another order never overrides the quote check. active_order_conflict is reserved for a distinct compatible-target overlap that cannot safely be coalesced, not duplicate acceptance of the same quote. Retention tombstones cannot resurrect an expired order."
}

All API operations