Get Order Details

Get detailed information about a specific domain order.

Returns full order details including contact information, registrar settings, DNS setup details, and payment status. Only returns orders belonging to the authenticated organization.

Path Parameters:

• order_id: UUID of the domain order

Returns 404 if the order doesn’t exist or doesn’t belong to the organization.

GET /api/v1/registrar/orders/{order_id}

Get Order Details

cURL

curl --request GET \
  --url https://api.dotlet.net/api/v1/registrar/orders/{order_id} \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_name": "<string>",
  "registrar": "<string>",
  "years": 123,
  "price": "<string>",
  "currency": "<string>",
  "amount_paid": "<string>",
  "amount_due": "<string>",
  "fully_paid": true,
  "dns_setup_requested": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "registrar_order_id": "<string>",
  "error_message": "<string>",
  "contact_info": {},
  "nameservers": [
    "<string>"
  ],
  "privacy": true,
  "auto_renew": true,
  "dns_provider": "<string>",
  "dns_setup_status": "<string>",
  "dns_zone_id": "<string>",
  "dns_nameservers": [
    "<string>"
  ],
  "dns_setup_error": "<string>",
  "dns_setup_started_at": "2023-11-07T05:31:56Z",
  "dns_setup_completed_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "payment_allocations": [
    {}
  ]
}

Authorizations

APIKeyHeaderHTTPBearer

X-API-Key · string · header · required

Path Parameters

order_id · string<uuid> · required

Response

200

application/json

Successful Response

Detailed domain order information including payment history

id · string<uuid> · required

organization_id · string<uuid> · required

domain_name · string · required

registrar · string · required

years · integer · required

price · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

currency · string · required

amount_paid · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

amount_due · string · required

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

fully_paid · boolean · required

status · enum<string> · required

Available options: pending, ready_to_process, price_changed, processing, completed, failed, cancelled, refunded

dns_setup_requested · boolean · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

registrar_order_id · string | null

error_message · string | null

contact_info · Contact Info · object | null

nameservers · string[] | null

privacy · boolean · default: true

auto_renew · boolean · default: true

dns_provider · string | null

dns_setup_status · string | null

dns_zone_id · string | null

dns_nameservers · string[] | null

dns_setup_error · string | null

dns_setup_started_at · string<date-time> | null

dns_setup_completed_at · string<date-time> | null

completed_at · string<date-time> | null

payment_allocations · Payment Allocations · object[]