VercelVercel
Menu

Get a domain order

GEThttps://api.vercel.com/v1/registrar/orders/{orderId}
Get information about a domain order by its ID
https://api.vercel.com/v1/registrar/orders/{orderId}
const response = await fetch('https://api.vercel.com/v1/registrar/orders/orderId?teamId=string', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);
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
403NotAuthorizedForScope
statusnumberRequired
codestringRequired
messagestringRequired
404NotFound
statusnumberRequired
codestringRequired
messagestringRequired
429TooManyRequests
statusnumberRequired
codestringRequired
messagestringRequired
retryAfterobjectRequired
limitobjectRequired
500InternalServerError
statusnumberRequired
codestringRequired
messagestringRequired