cart_domains

Creates, updates, deletes, gets or lists a cart_domains resource.

Overview

Name	cart_domains
Type	Resource
Id	ovh.order.cart_domains

Fields

The following fields are returned by SELECT queries:

list

Information about a product for Order/Cart

Name	Datatype	Description
offer_id	string	ID of the related offer (wire: offerId)
product_id	string	Product identifier (wire: productId)
action	string	Action kind (create, trade, transfer, update)
configurations	array	Information about the configurations required
current_nameservers	array	Current nameservers of the domain (from RDAP) (wire: currentNameservers)
delivery_time	string	Information about the estimated delivery time for the product (wire: deliveryTime)
duration	array	List all the duration allowed for the product
is_auth_info_required	boolean	Indicates if an authInfo has to be provided to order this product, only set on transfer products: the incoming transfer process of some extensions does not rely on an authInfo at all. Mirrors lifecycle.transfer.isAuthInfoRequired of the extension registry configurations (wire: isAuthInfoRequired)
is_transfer_locked	boolean	Indicates if the domain has a transfer lock status (client or server transfer prohibited) (wire: isTransferLocked)
offer	string	Information about the domain's offer (gold|diamond|platinium)
orderable	boolean	Indicates if the product is orderable or not
phase	string	Information about the domain phase
prices	array	Price details of the product
pricing_mode	string	Pricing model identifier for this product (wire: pricingMode)
quantity_max	integer	Maximum quantity purchasable for this product (wire: quantityMax)
recommended_duration	string (duration)	Recommended duration for this product (wire: recommendedDuration)
transfer	object	Conditions affecting the transfer of this domain, only set on transfer products. Supersedes isTransferLocked, which is kept during deprecation

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	cart_id, domain		Get information about a domain name
create	insert	cart_id, domain		Post a new domain name in your cart

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
cart_id	string	Cart ID (wire: cartId)
domain	string	Domain name requested

SELECT examples

list

Get information about a domain name

SELECT
offer_id,
product_id,
action,
configurations,
current_nameservers,
delivery_time,
duration,
is_auth_info_required,
is_transfer_locked,
offer,
orderable,
phase,
prices,
pricing_mode,
quantity_max,
recommended_duration,
transfer
FROM ovh.order.cart_domains
WHERE cart_id = '{{ cart_id }}' -- required
AND domain = '{{ domain }}' -- required
;

INSERT examples

create

Post a new domain name in your cart

INSERT INTO ovh.order.cart_domains (
domain,
duration,
offer_id,
plan_code,
pricing_mode,
quantity,
cart_id
)
SELECT 
'{{ domain }}' /* required */,
'{{ duration }}',
'{{ offer_id }}',
'{{ plan_code }}',
'{{ pricing_mode }}',
{{ quantity }},
'{{ cart_id }}'
RETURNING
cart_id,
item_id,
offer_id,
parent_item_id,
product_id,
configurations,
duration,
options,
prices,
settings
;

Manifest

# Description fields are for documentation purposes
- name: cart_domains
props:
  - name: cart_id
    value: "{{ cart_id }}"
    description: Required parameter for the cart_domains resource.
  - name: domain
    value: "{{ domain }}"
    description: |
      Domain name to order
  - name: duration
    value: "{{ duration }}"
    description: |
      Duration for the product
  - name: offer_id
    value: "{{ offer_id }}"
    description: |
      Offer unique identifier
  - name: plan_code
    value: "{{ plan_code }}"
    description: |
      Identifier of the commercial offer
  - name: pricing_mode
    value: "{{ pricing_mode }}"
    description: |
      Pricing mode selected for the purchase of the product
  - name: quantity
    value: {{ quantity }}
    description: |
      Quantity to order