rmas

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

Overview

Name	rmas
Type	Resource
Id	ovh.xdsl.rmas

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Return merchandise authorisation identifier
cancellable	boolean	Is the RMA cancellable?
creation_datetime	string (date-time)	Creation datetime of the return merchandise authorisation ticket (wire: creationDatetime)
equipment_reference	string	Merchandise reference (wire: equipmentReference)
new_merchandise	string	New merchandise brand in case of exchange (wire: newMerchandise)
offer_type_new	string	Offer type of the new merchandise in case of exchange (deposit, loan, purchase) (wire: offerTypeNew)
offer_type_old	string	Offer type of the return merchandise (deposit, loan, purchase) (wire: offerTypeOld)
process	string	Return merchandise authorisation type (changePhone, phoneRestitution, undefined)
reception_datetime	string (date-time)	Reception datetime of the return merchandise authorisation ticket (wire: receptionDatetime)
shipping_contact	object	Contact information structure (wire: shippingContact)
status	string	Return merchandise authorisation step (closed, open, received)
steps	array	Indicates the current status of the RMA with a list of steps
termination_datetime	string (date-time)	Termination datetime of the return merchandise authorisation ticket (wire: terminationDatetime)
type	string	Typology process of merchandise return (after sale equipment service exchange, after sale phone service exchange, equipment restitution, fast exchange, old merchandise reception before exchange, phone restitution, resends due to shipping lost by the carrier, resends due to shipping not withdraw, specific return merchandise authorisation, termination, unknown)

list

Current Return Merchandise Authorisation

Name	Datatype	Description
id	string	Return merchandise authorisation identifier
cancellable	boolean	Is the RMA cancellable?
creation_datetime	string (date-time)	Creation datetime of the return merchandise authorisation ticket (wire: creationDatetime)
equipment_reference	string	Merchandise reference (wire: equipmentReference)
new_merchandise	string	New merchandise brand in case of exchange (wire: newMerchandise)
offer_type_new	string	Offer type of the new merchandise in case of exchange (deposit, loan, purchase) (wire: offerTypeNew)
offer_type_old	string	Offer type of the return merchandise (deposit, loan, purchase) (wire: offerTypeOld)
process	string	Return merchandise authorisation type (changePhone, phoneRestitution, undefined)
reception_datetime	string (date-time)	Reception datetime of the return merchandise authorisation ticket (wire: receptionDatetime)
shipping_contact	object	Contact information structure (wire: shippingContact)
status	string	Return merchandise authorisation step (closed, open, received)
steps	array	Indicates the current status of the RMA with a list of steps
termination_datetime	string (date-time)	Termination datetime of the return merchandise authorisation ticket (wire: terminationDatetime)
type	string	Typology process of merchandise return (after sale equipment service exchange, after sale phone service exchange, equipment restitution, fast exchange, old merchandise reception before exchange, phone restitution, resends due to shipping lost by the carrier, resends due to shipping not withdraw, specific return merchandise authorisation, termination, unknown)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns a return merchandise authorization with its type, process, status and steps, the returned and new equipment, the shipping contact and its dates.
list	select	service_name	x_pagination_mode	Returns the IDs of the return merchandise authorizations of the access.
update	update	id, service_name		Changes the process or the shipping contact of a return merchandise authorization.
delete	delete	id, service_name		Cancels the return merchandise authorization, when it is still cancellable.
change_type	exec	id, serviceName, type		Changes a return merchandise authorization to a resiliation or to a SIP switch.

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"}})
id	string	Id
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)
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

Returns a return merchandise authorization with its type, process, status and steps, the returned and new equipment, the shipping contact and its dates.

SELECT
id,
cancellable,
creation_datetime,
equipment_reference,
new_merchandise,
offer_type_new,
offer_type_old,
process,
reception_datetime,
shipping_contact,
status,
steps,
termination_datetime,
type
FROM ovh.xdsl.rmas
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the return merchandise authorizations of the access.

SELECT
id,
cancellable,
creation_datetime,
equipment_reference,
new_merchandise,
offer_type_new,
offer_type_old,
process,
reception_datetime,
shipping_contact,
status,
steps,
termination_datetime,
type
FROM ovh.xdsl.rmas
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

UPDATE examples

update

Changes the process or the shipping contact of a return merchandise authorization.

UPDATE ovh.xdsl.rmas
SET 
process = '{{ process }}',
shipping_contact = '{{ shipping_contact }}'
WHERE 
id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Cancels the return merchandise authorization, when it is still cancellable.

DELETE FROM ovh.xdsl.rmas
WHERE id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_type

Changes a return merchandise authorization to a resiliation or to a SIP switch.

EXEC ovh.xdsl.rmas.change_type 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"type": "{{ type }}"
}'
;