Order a domain for a web hosting package
Orders a domain for one web hosting package - registered new or moved to manitu - after the user agreed to the AGB and the order.
Orders a domain for a web hosting package, by its site_id: registered new (transfer false) or moved to manitu from another provider (transfer true, with the auth code if there is one). manitu's support carries the order out and confirms it by e-mail (handled: manual); the domain is not active yet when this answers. A domain beyond those the package includes is charged at the enduser price (manitu_public_domain_tld_getPOST /v1/public/domain/tld/get has the list price; an account may have a special price or another tax). Refused per field when the TLD is not one manitu registers under (tld_not_offered), the name is no domain name (invalid), the domain is at manitu already (domain_exists) or an auth code comes without a transfer (not_for_type); with a conflict when the account may not order (order_not_allowed, with reason_list) or the package cannot be changed now (not_configurable). Made with a session of the customer panel, the call is carried out at once; otherwise it waits until a person signed in to the customer panel approves it (approval_required; its state: manitu_approval_getPOST /v1/approval/get).
Counts against: writes (60 per hour per account)
manitu_webhosting_domain_order on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Orders a domain for a web hosting package, by its site_id: registered new (transfer false) or moved to manitu from another provider (transfer true, with the auth code if the user has it). manitu's support carries the order out and confirms it to the user by e-mail (handled: manual) - it is not active yet when this answers. A domain more than the package includes is charged as manitu lists it with a web hosting package (enduser price; manitu_public_domain_tld_getPOST /v1/public/domain/tld/get has the list price, and an account may have a special price or another tax - the approval names the price that is billed, with the tax of the account's invoice). Waits for the user's approval in the customer panel: the call is answered with approval_required and a pending_action, its approval holding as elements the AGB as a document with a link, the order as a text and what it costs as a price - nothing is ordered until the user approves it there. Refused per field when the TLD is not one manitu registers under (tld_not_offered), the name is no domain name (invalid), the domain is at manitu already (domain_exists) or an auth code comes without a transfer (not_for_type); with a conflict when the account may not order (order_not_allowed, with reason_list) or the package cannot be changed now (not_configurable).
Arguments
site_id (required)integer | stringThe site_id of the package. Never guess one.
domain (required)stringThe domain, e.g. example.de - with international characters or in ASCII.
transfer (required)booleantrue: the domain exists at another provider and moves to manitu; false: it is registered new.
authcodestringwrite-onlyWith transfer only: the auth code (also called EPP or transfer code) the old provider gave the user - leave it out if he does not have it yet (then: manitu_domain_transfer_in_authcode_setPOST /v1/domain/transfer/in/authcode/set).
setup_default_pagebooleanWhether the website of the domain gets manitu's default page. Default true.
approval_tokenstringwrite-onlyThe token of the way call_again from the approval_required answer of the same call - only after the user said yes to everything in its elements. Valid 15 minutes, once.
Result structuredContent, checked against the schema
site_idintegerThe package.
domainstringThe domain ordered, with international characters.
transferbooleanWhether it moves to manitu (true) or is registered new (false).
handledstringmanual: manitu's support carries the order out and confirms it by e-mail.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
site_id (required)integer | stringThe site_id of the package.
domain (required)stringThe domain, e.g. example.de - with international characters or in ASCII.
transfer (required)booleantrue: the domain exists at another provider and moves to manitu; false: it is registered new.
authcodestringwrite-onlyWith transfer only: the auth code (also called EPP or transfer code) the old provider gave the user - leave it out if he does not have it yet (then: manitu_domain_transfer_in_authcode_setPOST /v1/domain/transfer/in/authcode/set).
setup_default_pagebooleanWhether the website of the domain gets manitu's default page. Default true.
approval_tokenstringwrite-onlyThe token of the way call_again from the approval_required answer of the same call - only after the user said yes to everything in its elements. Valid 15 minutes, once.
Response in data; the rest of the body as on every call
site_idintegerThe package.
domainstringThe domain ordered, with international characters.
transferbooleanWhether it moves to manitu (true) or is registered new (false).
handledstringmanual: manitu's support carries the order out and confirms it by e-mail.
Statuses
200Success.400The input is wrong, or the request itself (INVALID_INPUT). Each entry names its field and its reason - correct the input and call again.401No credential was presented, or it was not recognised (UNAUTHENTICATED).403The credential is valid, but may not do this (PERMISSION_DENIED). The reason says why - another credential is the way, not a repeat.429Too many calls. The Retry-After header says when to try again.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.