orders

Creates, updates, deletes, gets or lists an orders resource.

Overview

Name	orders
Type	Resource
Id	vercel.domains_registrar.orders

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
order_id	string	A valid order ID (wire: orderId)
domains	array
error	object
status	string	(draft, purchasing, completed, failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	order_id	team_id	Get information about a domain order by its ID
buy_domain	exec	domain, autoRenew, years, expectedPrice, contactInformation	teamId	Buy a domain
buy_domains	exec	domains, contactInformation	teamId	Buy multiple domains at once
transfer_in_domain	exec	domain, authCode, autoRenew, years, expectedPrice, contactInformation	teamId	Transfer a domain in from another registrar
renew_domain	exec	domain, years, expectedPrice	teamId	Renew a domain

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain	string
order_id	string
teamId	string
team_id	string	(wire: teamId)

SELECT examples

get

Get information about a domain order by its ID

SELECT
order_id,
domains,
error,
status
FROM vercel.domains_registrar.orders
WHERE order_id = '{{ order_id }}' -- required
AND team_id = '{{ team_id }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

buy_domain

Buy a domain

EXEC vercel.domains_registrar.orders.buy_domain 
@domain='{{ domain }}' --required, 
@teamId='{{ teamId }}' 
@@json=
'{
"autoRenew": {{ autoRenew }}, 
"years": {{ years }}, 
"expectedPrice": {{ expectedPrice }}, 
"contactInformation": "{{ contactInformation }}", 
"languageCode": "{{ languageCode }}"
}'
;

buy_domains

Buy multiple domains at once

EXEC vercel.domains_registrar.orders.buy_domains 
@teamId='{{ teamId }}' 
@@json=
'{
"domains": "{{ domains }}", 
"contactInformation": "{{ contactInformation }}"
}'
;

transfer_in_domain

Transfer a domain in from another registrar

EXEC vercel.domains_registrar.orders.transfer_in_domain 
@domain='{{ domain }}' --required, 
@teamId='{{ teamId }}' 
@@json=
'{
"authCode": "{{ authCode }}", 
"autoRenew": {{ autoRenew }}, 
"years": {{ years }}, 
"expectedPrice": {{ expectedPrice }}, 
"contactInformation": "{{ contactInformation }}"
}'
;

renew_domain

Renew a domain

EXEC vercel.domains_registrar.orders.renew_domain 
@domain='{{ domain }}' --required, 
@teamId='{{ teamId }}' 
@@json=
'{
"years": {{ years }}, 
"expectedPrice": {{ expectedPrice }}, 
"contactInformation": "{{ contactInformation }}"
}'
;