cart_checkouts

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

Overview

Name	cart_checkouts
Type	Resource
Id	ovh.order.cart_checkouts

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	cart_id		Get prices and contracts information for your cart
create	insert	cart_id		Validate your shopping and 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"}})
cart_id	string	Cart ID (wire: cartId)

SELECT examples

get

Get prices and contracts information for your cart

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.cart_checkouts
WHERE cart_id = '{{ cart_id }}' -- required
;

INSERT examples

create

Validate your shopping and create order

INSERT INTO ovh.order.cart_checkouts (
auto_pay_with_preferred_payment_method,
waive_retractation_period,
cart_id
)
SELECT 
{{ auto_pay_with_preferred_payment_method }},
{{ waive_retractation_period }},
'{{ cart_id }}'
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: cart_checkouts
props:
  - name: cart_id
    value: "{{ cart_id }}"
    description: Required parameter for the cart_checkouts resource.
  - name: auto_pay_with_preferred_payment_method
    value: {{ auto_pay_with_preferred_payment_method }}
    description: |
      Indicates that order will be automatically paid with preferred payment method
  - name: waive_retractation_period
    value: {{ waive_retractation_period }}
    description: |
      Indicates that order will be processed with waiving retractation period