shipping_addresses

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

Overview

Name	shipping_addresses
Type	Resource
Id	ovh.pack_xdsl.shipping_addresses

Fields

The following fields are returned by SELECT queries:

list

Shipping address

Name	Datatype	Description
shipping_id	string	(wire: shippingId)
city_name	string	(wire: cityName)
first_name	string	(wire: firstName)
last_name	string	(wire: lastName)
address	string
country_code	string	(wire: countryCode)
zip_code	string	(wire: zipCode)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	context, pack_name		List the shipping addresses of an xDSL pack. Returns the addresses allowed for the given context, such as a migration or a VoIP line 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"}})
context	string	Context
pack_name	string	The internal name of your pack (wire: packName)

SELECT examples

list

List the shipping addresses of an xDSL pack. Returns the addresses allowed for the given context, such as a migration or a VoIP line order.

SELECT
shipping_id,
city_name,
first_name,
last_name,
address,
country_code,
zip_code
FROM ovh.pack_xdsl.shipping_addresses
WHERE context = '{{ context }}' -- required
AND pack_name = '{{ pack_name }}' -- required
;