API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · domain_orders

Domain Order Schema

Schema-ID
domain_order
Collection
domain_orders
Permissions
  • Lesendomain_register
  • Anlegendomain_register
  • Änderndomain_register
  • Löschendomain_register

Felder

Domain Order Schema

domain_orders4 Permissions

Schema for domain registration, transfer, and renewal orders

domainNamestringerforderlich

Fully qualified domain name to register/transfer/renew

1–253 Zeichen
orderTypestringerforderlich

Type of domain order

Werte
registrationtransferrenewal
statusstringoptional

Current order status

Werte
pendingprocessingcompletedfailedcancelled
read-only
inwxOrderIdstringoptional

INWX order/process ID

read-onlynullable
inwxPricenumberoptional

INWX wholesale price in EUR

≥ 0read-only
retailPricenumberoptional

Retail price charged to tenant in EUR

≥ 0read-only
marginnumberoptional

Markup margin in EUR

≥ 0read-only
periodintegererforderlich

Registration/renewal period in years

1 – 10
ownerPartyIduuiderforderlich

Party used as INWX owner handle

adminPartyIduuidoptional

Party used as INWX admin handle (defaults to owner)

nullable
techPartyIduuidoptional

Party used as INWX tech handle (defaults to owner)

nullable
billingPartyIduuidoptional

Party used as INWX billing handle (defaults to owner)

nullable
authCodestringoptional

Transfer auth code (encrypted, only for transfers)

max 255 Zeichennullable
useInwxNameserversbooleanoptional

Whether to use INWX default nameservers

nameserversstring[]optional

Custom nameservers (if not using INWX)

max 6 Itemsnullable
assetIduuidoptional

Created domain asset ID (set on completion)

read-onlynullable
errorMessagestringoptional

Error details if order failed

max 2000 Zeichenread-onlynullable
completedAtdatetimeoptional

When the order was completed

read-onlynullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/domain_orders — Liste, paginiert + filterbar
  • GET /api/v1/domain_orders/<id> — Einzelne Entity
  • POST /api/v1/domain_orders — Anlegen
  • PATCH /api/v1/domain_orders/<id> — Teil-Update
  • DELETE /api/v1/domain_orders/<id> — Soft-Delete
  • GET /api/v1/domain_orders/<id>/timeline — Audit + Aktivitäten

Suche