cart_zimbras

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

Overview

Name	cart_zimbras
Type	Resource
Id	ovh.order.cart_zimbras

Fields

The following fields are returned by SELECT queries:

list

Representation of a generic product

Name	Datatype	Description
product_name	string	Name of the product (wire: productName)
plan_code	string	Product offer identifier (wire: planCode)
prices	array	Prices of the product offer
product_type	string	Product type (cloud_service, delivery, deposit, domain, implementation_services, saas_license, shipping, storage) (wire: productType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	cart_id		Get information about zimbra offers
create	insert	cart_id, duration, plan_code, pricing_mode, quantity		Post a new zimbra item 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)

SELECT examples

list

Get information about zimbra offers

SELECT
product_name,
plan_code,
prices,
product_type
FROM ovh.order.cart_zimbras
WHERE cart_id = '{{ cart_id }}' -- required
;

INSERT examples

create

Post a new zimbra item in your cart

INSERT INTO ovh.order.cart_zimbras (
duration,
plan_code,
pricing_mode,
quantity,
cart_id
)
SELECT 
'{{ duration }}' /* required */,
'{{ plan_code }}' /* required */,
'{{ pricing_mode }}' /* required */,
{{ quantity }} /* required */,
'{{ 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_zimbras
props:
  - name: cart_id
    value: "{{ cart_id }}"
    description: Required parameter for the cart_zimbras resource.
  - name: duration
    value: "{{ duration }}"
    description: |
      Duration selected for the purchase of the product
  - name: plan_code
    value: "{{ plan_code }}"
    description: |
      Identifier of the offer
  - name: pricing_mode
    value: "{{ pricing_mode }}"
    description: |
      Pricing mode selected for the purchase of the product
  - name: quantity
    value: {{ quantity }}
    description: |
      Quantity of product desired