Skip to main content
GET
/
v1
/
registrar
/
orders
/
{orderId}
getOrder
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.domainsRegistrar.getOrder({
    orderId: "<id>",
  });

  console.log(result);
}

run();
{
  "orderId": "<string>",
  "domains": [
    {
      "purchaseType": "purchase",
      "autoRenew": true,
      "domainName": "<string>",
      "status": "pending",
      "price": 1.01,
      "years": 123
    }
  ],
  "status": "draft",
  "error": {
    "code": "payment-failed"
  }
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

orderId
string
required

Response

Success

orderId
string
required
domains
object[]
required
  • Option 1
  • Option 2
  • Option 3
status
enum<string>
required
Available options:
draft,
purchasing,
completed,
failed
error
object
  • Option 1
  • Option 2
  • Option 3
  • Option 4
I