Skip to content
Docs

Get a domain order

GET/__remote/api.vercel.com/v1/registrar/orders/{orderId}
Get information about a domain order by its ID
Request
import { Edgenivo } from "@vercel/sdk";
const vercel = new Edgenivo({
bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});
async function run() {
const result = await vercel.domainsRegistrar.getOrder({
orderId: "<id>",
teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
});
console.log(result);
}
run();
Response
{
"orderId": "example_id",
"domains": [
{
"purchaseType": "purchase",
"autoRenew": "true",
"years": "123",
"domainName": "Example Name",
"status": "pending",
"price": "123",
"error": "value"
}
],
"status": "draft",
"error": "value"
}
Errors
{
"issues": [
{
"path": [],
"message": "string"
}
],
"message": "string"
}
AuthorizationbearerToken

Default authentication mechanism

orderIdanyRequired
teamIdstringOptional
200Success
orderIdstringRequired
A valid order ID
domainsarrayRequired
statusstringRequired
errorobjectOptional
400There was something wrong with the request
issuesarrayRequired
messagestringRequired
401Unauthorized
statusnumberRequired
codestringRequired
messagestringRequired
reasonstringOptional
403NotAuthorizedForScope
statusnumberRequired
codestringRequired
messagestringRequired
404NotFound
statusnumberRequired
codestringRequired
messagestringRequired
429TooManyRequests
statusnumberRequired
codestringRequired
messagestringRequired
retryAfterobjectRequired
limitobjectRequired
500InternalServerError
statusnumberRequired
codestringRequired
messagestringRequired