telephony_spare_news
Creates, updates, deletes, gets or lists a telephony_spare_news resource.
Overview​
| Name | telephony_spare_news |
| Type | Resource |
| Id | ovh.order.telephony_spare_news |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
order_id | integer | Identifier of the order (wire: orderId) |
contracts | array | List of contracts related to the order |
details | array | Details of the order |
prices | object | Prices of the order including with and without taxes |
url | string | URL to download the order |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | brand, quantity, shipping_contact_id | mondial_relay_id | Get prices and contracts information |
create | insert | brand, quantity, shipping_contact_id | Create order |
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"}}) |
brand | string | Spare phone brand model |
quantity | integer | Number of phone quantity |
shipping_contact_id | integer | Shipping contact information id from /me entry point (wire: shippingContactId) |
mondial_relay_id | string | Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry. (wire: mondialRelayId) |
SELECT examples​
- get
Get prices and contracts information
SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.telephony_spare_news
WHERE brand = '{{ brand }}' -- required
AND quantity = '{{ quantity }}' -- required
AND shipping_contact_id = '{{ shipping_contact_id }}' -- required
AND mondial_relay_id = '{{ mondial_relay_id }}'
;
INSERT examples​
- create
- Manifest
Create order
INSERT INTO ovh.order.telephony_spare_news (
brand,
mondial_relay_id,
quantity,
shipping_contact_id
)
SELECT
'{{ brand }}' /* required */,
'{{ mondial_relay_id }}',
{{ quantity }} /* required */,
{{ shipping_contact_id }} /* required */
RETURNING
order_id,
contracts,
details,
prices,
url
;
# Description fields are for documentation purposes
- name: telephony_spare_news
props:
- name: brand
value: "{{ brand }}"
description: |
Spare phone brand model
- name: mondial_relay_id
value: "{{ mondial_relay_id }}"
description: |
Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry.
- name: quantity
value: {{ quantity }}
description: |
Number of phone quantity
- name: shipping_contact_id
value: {{ shipping_contact_id }}
description: |
Shipping contact information id from /me entry point