Catalog API Reference

Methods

catalog.list(apikey, opts[, currency='EUR', grid='A', date_price=nil])

List catalog entries. The default currency is EUR. The default grid is A. Override the parameters in order to get the price of a product associated with your currency and your price grid.

Parameters:

• apikey (string) – API connection key
• opts (struct) – Filtering options
• currency (string) – ISO currency
• grid (string) – Name of the Grid
• date_price (string) – Request price at any given date

Returns:

struct – List of products

Parameters

OptionalSudoableIdent

parameter of catalog.list(), contact.create(), contact.reachability.validate(), domain.delete.accept(), domain.delete.decline(), domain.delete.info(), domain.misc.dk_registrar_validation(), domain.smd.extract() and site.edit()

Name	Default	Type	Mandatory
apikey		string	yes
handle		string	yes
no_useraccess	False	boolean	no

Product

used by ProductSearchOptions

Name	Default	Type	Mandatory
type		string	yes
description		array of string or string	no
quantity		int	no
~description		string	no

ProductSearchOptions

parameter of catalog.list()

Name	Default	Type	Mandatory
product		struct	yes
action		struct	no
contact_v5		struct	no
items_per_page	100	int	no
number of items returned for the pagination
page	0	int	no
page number for pagination offset
sort_by		string	no
used to sort returned items: action, contact_v5, product

Action

used by ProductSearchOptions

Name	Default	Type	Mandatory
name		string	yes
duration		double	no
param		struct	no

ActionName

used by Action

Name	Description
add
create
remove
release	Release an hosting resource
renew	Renew a domain
restore	Restore a domain
transfer	Transfer a domain to Gandi
change_owner	Change domain owner
transfer_reseller
update
delete

ProductTypeName

used by Product

Name	Description
domain	Domain
domain_option	-
gandimail	Email
hosting	Hosting resource
iaas	-
mailbox-standalone	-
mailboxv2	-
openstack	-
paas	PaaS
sme	-

Returns

CatalogListReturn

returned by catalog.list()

list of CatalogReturn