Registrar

Read a persisted domain-purchase order's status by id

A widget token or a delegated agent token (domains:read) reads an order of its own application; a tenant API key reads an order of any of its applications. An order of another application answers 404.

get/sell/orders/{id}

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/sell/orders/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.customdomain.ai/oauth/agent/authorize, token URL https://api.customdomain.ai/oauth/agent/token, scopes: domains:read)

Path parameters

idstring required

Response

Order

orderIdstring required
domainstring required
registrarstring
status'quoted' | 'purchasing' | 'purchased' | 'transferred' | 'failed' | 'expired' required
createdAtstring date-time
regOrderIdstring

the registrar's order reference, once purchased.

jobIdstring
linkstring

sharing-rail checkout URL, if any.

freeDomainboolean

promo (first-domain-free) registration.

Example response

{
  "orderId": "ord_1a2b3c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.