Prepare a domain order for the checkout

POST /orders/prepare

Operation ID: PrepareOrder

Prepares a domain order and returns a link to the regfish checkout. NOTHING is ordered, paid or reserved by this call: the customer opens the link, reviews the positions and completes the purchase in the checkout (terms, payment, contacts). Use it when the person you work for explicitly asks to register or transfer domains, and show them the returned link.

For every domain the registry state decides the action: a free name is prepared as registration, a taken name as transfer (the auth code is entered in the checkout, never here). Domains that cannot be ordered are returned with a reason and left out of the link. Prices are gross EUR as shown in the checkout; the checkout reprices on order.

The link is valid for 24 hours, bound to the account behind the credential and can be taken over once. Limits: 20 domains per call, 30 prepared orders per account and hour, 100 per day.

Request body

prepareOrderRequest

Field	Type	Required	Description
`items`	`object[]`	yes

Responses

Status	Type	Description
`200`	`prepareOrderResponse`	Prepared order with checkout link
`400`	`Error`	Invalid request
`401`	`Error`	Unauthorized
`403`	`Error`	Missing permission order:prepare, or account locked
`422`	`Error`	None of the domains can be ordered
`429`	`Error`	Too many prepared orders
`502`	`Error`	Availability could not be determined

Response body

Field	Type	Required	Description
`success`	`boolean`	yes	Success indicator
`code`	`integer`	no	Response/Error Code
`response`	prepareOrderResponse	no

Example

curl -X POST "https://api.regfish.com/orders/prepare" \
  -H "x-api-key: $REGFISH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "domain": "string",
        "action": "register"
      }
    ]
  }'

Build a request

Fill in values: the call below updates as you type. Nothing is sent: the API does not currently allow browser requests from this domain (CORS). The API key is not stored.