cart_item_configurations

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

Overview

Name	cart_item_configurations
Type	Resource
Id	ovh.order.cart_item_configurations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Configuration ID
label	string	Identifier of the resource
value	string	Path to the resource in API.OVH.COM

list

Representation of a configuration item for personalizing product

Name	Datatype	Description
id	integer	Configuration ID
label	string	Identifier of the resource
value	string	Path to the resource in API.OVH.COM

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	cart_id, configuration_id, item_id		Retrieve configuration item
list	select	cart_id, item_id	label, x_pagination_mode	Retrieve all configuration item of the cart item
create	insert	cart_id, item_id, label, value		Setup configuration item for the product
delete	delete	cart_id, configuration_id, item_id		Delete configuration item

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)
configuration_id	integer	Configuration ID (wire: configurationId)
item_id	integer	Item ID (wire: itemId)
label	string	Filter the value of label property (=)
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

Retrieve configuration item

SELECT
id,
label,
value
FROM ovh.order.cart_item_configurations
WHERE cart_id = '{{ cart_id }}' -- required
AND configuration_id = '{{ configuration_id }}' -- required
AND item_id = '{{ item_id }}' -- required
;

list

Retrieve all configuration item of the cart item

SELECT
id,
label,
value
FROM ovh.order.cart_item_configurations
WHERE cart_id = '{{ cart_id }}' -- required
AND item_id = '{{ item_id }}' -- required
AND label = '{{ label }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Setup configuration item for the product

INSERT INTO ovh.order.cart_item_configurations (
label,
value,
cart_id,
item_id
)
SELECT 
'{{ label }}' /* required */,
'{{ value }}' /* required */,
'{{ cart_id }}',
'{{ item_id }}'
RETURNING
id,
label,
value
;

Manifest

# Description fields are for documentation purposes
- name: cart_item_configurations
props:
  - name: cart_id
    value: "{{ cart_id }}"
    description: Required parameter for the cart_item_configurations resource.
  - name: item_id
    value: {{ item_id }}
    description: Required parameter for the cart_item_configurations resource.
  - name: label
    value: "{{ label }}"
    description: |
      Label for your configuration item
  - name: value
    value: "{{ value }}"
    description: |
      Value or resource URL on API.OVH.COM of your configuration item

DELETE examples

delete

Delete configuration item

DELETE FROM ovh.order.cart_item_configurations
WHERE cart_id = '{{ cart_id }}' --required
AND configuration_id = '{{ configuration_id }}' --required
AND item_id = '{{ item_id }}' --required
;