catalog_formatted_domains
Creates, updates, deletes, gets or lists a catalog_formatted_domains resource.
Overview​
| Name | catalog_formatted_domains |
| Type | Resource |
| Id | ovh.order.catalog_formatted_domains |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
count | integer | Number of extensions in this page |
display | object | How the subsidiary's prices are put forward on the website |
extensions | array | Domain extensions of this page |
pagination | array | List of the available page numbers |
total | integer | Total number of extensions matching the filters |
webhosting | object | Cheapest web hosting offer of the subsidiary, for the TLD pages' hosting cross-sell card. Omitted when the webHosting catalog is unavailable |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ovh_subsidiary | categories, count, offset, period, plan_code, plan_codes, price_max, price_min, price_type, promotion, search, sort, zones | Domain extensions of the public catalog for a subsidiary, with creation/renewal/transfer/restore/trade prices and promotions, keyword search, thematic category and geographic zone filters, price filtering, sorting and pagination. |
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"}}) |
ovh_subsidiary | string | OVHcloud subsidiary targeted (wire: ovhSubsidiary) |
categories | array | Filter on thematic categories (byCategory machine names, e.g. art_and_culture); several values combine with OR. Repeat the parameter for multiple values |
count | integer | Number of results per page. Default to 25 |
offset | integer | Offset of the first result returned, used with count for pagination |
period | integer | Commitment in years whose price priceMin, priceMax and price sorting read: 1 (default), 3 or 5 (the multiyear totals; extensions without that commitment never match a price range and come last when sorting by price) |
plan_code | string | Return only the extension with this plan code (e.g. fr for .fr, com for .com) (wire: planCode) |
plan_codes | string | Return only the extensions with these plan codes, comma-separated (e.g. com,fr) (wire: planCodes) |
price_max | number | Maximum price (wire: priceMax) |
price_min | number | Minimum price (wire: priceMin) |
price_type | string | Price used by priceMin, priceMax and price sorting: creation (default), renewal or transfer (wire: priceType) |
promotion | boolean | Return only the extensions in promotion over the period: a creation or multi-year promotion, or a discounted price |
search | string | Search extensions by name |
sort | string | Sort order: name-asc (default), name-desc, price-asc or price-desc. Extensions with a promotion always come first |
zones | array | Filter on geographic zones (byCategory machine names, e.g. europe); several values combine with OR. Repeat the parameter for multiple values |
SELECT examples​
- get
Domain extensions of the public catalog for a subsidiary, with creation/renewal/transfer/restore/trade prices and promotions, keyword search, thematic category and geographic zone filters, price filtering, sorting and pagination.
SELECT
count,
display,
extensions,
pagination,
total,
webhosting
FROM ovh.order.catalog_formatted_domains
WHERE ovh_subsidiary = '{{ ovh_subsidiary }}' -- required
AND categories = '{{ categories }}'
AND count = '{{ count }}'
AND offset = '{{ offset }}'
AND period = '{{ period }}'
AND plan_code = '{{ plan_code }}'
AND plan_codes = '{{ plan_codes }}'
AND price_max = '{{ price_max }}'
AND price_min = '{{ price_min }}'
AND price_type = '{{ price_type }}'
AND promotion = '{{ promotion }}'
AND search = '{{ search }}'
AND sort = '{{ sort }}'
AND zones = '{{ zones }}'
;