order_details

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

Overview

Name	order_details
Type	Resource
Id	ovh.me.order_details

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_detail_id	integer	(wire: orderDetailId)
cancelled	boolean
description	string
detail_type	string	Product type of item in order (ACCESSORY, CAUTION, CHOOSED, CONSUMPTION, CREATION, DELIVERY, DURATION, GIFT, INSTALLATION, LICENSE, MUTE, OTHER, OUTPLAN, QUANTITY, REFUND, RENEW, SPECIAL, SWITCH, TRANSFER, VOUCHER) (wire: detailType)
domain	string
quantity	string
total_price	object	Price with its currency and textual representation (wire: totalPrice)
unit_price	object	Price with its currency and textual representation (wire: unitPrice)

list

Information about a Bill entry

Name	Datatype	Description
order_detail_id	integer	(wire: orderDetailId)
cancelled	boolean
description	string
detail_type	string	Product type of item in order (ACCESSORY, CAUTION, CHOOSED, CONSUMPTION, CREATION, DELIVERY, DURATION, GIFT, INSTALLATION, LICENSE, MUTE, OTHER, OUTPLAN, QUANTITY, REFUND, RENEW, SPECIAL, SWITCH, TRANSFER, VOUCHER) (wire: detailType)
domain	string
quantity	string
total_price	object	Price with its currency and textual representation (wire: totalPrice)
unit_price	object	Price with its currency and textual representation (wire: unitPrice)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	order_detail_id, order_id		Get this object properties
list	select	order_id	x_pagination_mode	Give access to all entries of the 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"}})
order_detail_id	integer	(wire: orderDetailId)
order_id	integer	(wire: orderId)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
order_detail_id,
cancelled,
description,
detail_type,
domain,
quantity,
total_price,
unit_price
FROM ovh.me.order_details
WHERE order_detail_id = '{{ order_detail_id }}' -- required
AND order_id = '{{ order_id }}' -- required
;

list

Give access to all entries of the order

SELECT
order_detail_id,
cancelled,
description,
detail_type,
domain,
quantity,
total_price,
unit_price
FROM ovh.me.order_details
WHERE order_id = '{{ order_id }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;