cart_coupons

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

Overview

Name	cart_coupons
Type	Resource
Id	ovh.order.cart_coupons

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	cart_id		Retrieve coupons associated to cart
create	insert	cart_id, coupon		Add a new coupon to cart
delete	delete	cart_id, coupon		Delete a coupon from 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)
coupon	string	Coupon identifier

SELECT examples

list

Retrieve coupons associated to cart

SELECT
value
FROM ovh.order.cart_coupons
WHERE cart_id = '{{ cart_id }}' -- required
;

INSERT examples

create

Add a new coupon to cart

INSERT INTO ovh.order.cart_coupons (
coupon,
cart_id
)
SELECT 
'{{ coupon }}' /* required */,
'{{ cart_id }}'
RETURNING
post_v1_order_cart_cart_id_coupon
;

Manifest

# Description fields are for documentation purposes
- name: cart_coupons
props:
  - name: cart_id
    value: "{{ cart_id }}"
    description: Required parameter for the cart_coupons resource.
  - name: coupon
    value: "{{ coupon }}"
    description: |
      Coupon identifier

DELETE examples

delete

Delete a coupon from cart

DELETE FROM ovh.order.cart_coupons
WHERE cart_id = '{{ cart_id }}' --required
AND coupon = '{{ coupon }}' --required
;