Préférences

Générales

Retourne les préférences générales GET
/v1/sites/{code_site}/prefs.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "site_title": "string",
    "is_site_open": "boolean",
    "is_contact_enabled": "boolean",
    "is_blog_enabled": "boolean",
    "is_catalog_enabled": "boolean",
    "is_checkout_enabled": "boolean",
    "is_api_enabled": "boolean",
    "front_login": "string",
    "front_password": "string",
    "breadcrumb": "List"
}
NomTypeDescription
site_titlestringNom du site
is_site_openbooleanActivation de l'accès front-office
is_contact_enabledbooleanActivation de la page de contact
is_blog_enabledbooleanActivation du blog
is_catalog_enabledbooleanActivation du catalogue
is_checkout_enabledbooleanActivation de l'e-commerce
is_api_enabledbooleanActivation de l'API front-office
front_loginstringIdentifiant pour l'accès front office
front_passwordstringMot de passe pour l'accès front office
breadcrumbList
Modifie les préférences générales PUT
/v1/sites/{code_site}/prefs.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
site_titlestringNom du site
is_site_openbooleanActivation de l'accès front-office
is_contact_enabledbooleanActivation de la page de contact
is_blog_enabledbooleanActivation du blog
is_catalog_enabledbooleanActivation du catalogue
is_checkout_enabledbooleanActivation de l'e-commerce
is_api_enabledbooleanActivation de l'API front-office
front_loginstringIdentifiant pour l'accès front office
front_passwordstringMot de passe pour l'accès front office
breadcrumbarray
Retourne les coordonnées GET
/v1/sites/{code_site}/prefs/contact.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "firstname": "string",
    "lastname": "string",
    "civility": "string",
    "email": "string",
    "address": "string",
    "zipcode": "string",
    "city": "string",
    "country_id": "string",
    "phone": "string",
    "mobile": "string",
    "fax": "string",
    "company_name": "string",
    "company_forme": "string",
    "company_cnil": "string",
    "company_capital": "string",
    "company_siret": "string",
    "company_rcs": "string",
    "company_naf": "string",
    "company_tva": "string"
}
NomTypeDescription
firstnamestringPrénom du propriétaire du site
lastnamestringNom du propriétaire du site
civilitystringCivilité du propriétaire du site
emailstringEmail du propriétaire du site
addressstringAdresse du propriétaire du site
zipcodestringCode postal du propriétaire du site
citystringVille du propriétaire du site
country_idstringPays du propriétaire du site
phonestringTéléphone du propriétaire du site
mobilestringTéléphone mobile du propriétaire du site
faxstringNuméro de fax du propriétaire du site
company_namestringNom de la société
company_formestringForme juridique
company_cnilstringNuméro CNIL
company_capitalstringCapital
company_siretstringNuméro Siret
company_rcsstringNuméro RCS
company_nafstringNuméro NAF
company_tvastringNuméro TVA
Modifie les coordonnées PUT
/v1/sites/{code_site}/prefs/contact.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
firstnamestringPrénom du propriétaire du site
lastnamestringNom du propriétaire du site
civilitystringCivilité du propriétaire du site
Les valeurs attendues sont : Mr, Mrs, Miss
emailstringEmail du propriétaire du site
addressstringAdresse du propriétaire du site
zipcodestringCode postal du propriétaire du site
citystringVille du propriétaire du site
country_idstringPays du propriétaire du site
phonestringTéléphone du propriétaire du site
mobilestringTéléphone mobile du propriétaire du site
faxstringNuméro de fax du propriétaire du site
company_namestringNom de la société
company_formestringForme juridique
company_cnilstringNuméro CNIL
company_capitalstringCapital
company_siretstringNuméro Siret
company_rcsstringNuméro RCS
company_nafstringNuméro NAF
company_tvastringNuméro TVA
Retourne les préférences RGPD GET
/v1/sites/{code_site}/prefs/gdpr.json

Liste les préférences sur la protection des données personnelles.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_customers_consent_required": "boolean",
    "is_comments_consent_required": "boolean",
    "is_evaluations_consent_required": "boolean",
    "is_newsletter_consent_required": "boolean",
    "is_checkout_consent_required": "boolean"
}
NomTypeDescription
is_customers_consent_requiredbooleanActivation du recueil du consentement à l'ouverture de compte
is_comments_consent_requiredbooleanActivation du recueil du consentement à la publication d'un commentaire dans le blog
is_evaluations_consent_requiredbooleanActivation du recueil du consentement à la publication d'une évaluation produit
is_newsletter_consent_requiredbooleanActivation du recueil du consentement à l'inscription à la newsletter
is_checkout_consent_requiredbooleanActivation du recueil du consentement au renseignement de l'adresse de facturation/livraison
Modifie les préférences RGPD PUT
/v1/sites/{code_site}/prefs/gdpr.json

Modifie les préférences sur la protection des données personnelles.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_customers_consent_requiredbooleanActivation du recueil du consentement à l'ouverture de compte
is_comments_consent_requiredbooleanActivation du recueil du consentement à la publication d'un commentaire dans le blog
is_evaluations_consent_requiredbooleanActivation du recueil du consentement à la publication d'une évaluation produit
is_newsletter_consent_requiredbooleanActivation du recueil du consentement à l'inscription à la newsletter
is_checkout_consent_requiredbooleanActivation du recueil du consentement au renseignement de l'adresse de facturation/livraison

Blog

Retourne les paramètres du blog GET
/v1/sites/{code_site}/prefs/blog.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_enabled": "boolean",
    "comments_allowed": "boolean",
    "comments_captcha": "boolean",
    "comments_anonymous": "boolean",
    "comments_autopublish": "boolean",
    "is_rss_enabled": "boolean",
    "rss_post_count": "integer"
}
NomTypeDescription
is_enabledbooleanActivation du blog
comments_allowedbooleanAutoriser les nouveaux commentaires
comments_captchabooleanProtéger les commentaires par captcha
comments_anonymousbooleanAutoriser les commentaires anonymes
comments_autopublishbooleanPublier automatiquement les nouveaux commentaires
is_rss_enabledbooleanActive le module de syndication
rss_post_countintegerNombre de billet à diffuser dans le flux
Modifie les paramètres du blog PUT
/v1/sites/{code_site}/prefs/blog.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_enabledbooleanActivation du blog
comments_allowedbooleanAutoriser les nouveaux commentaires
comments_captchabooleanProtéger les commentaires par captcha
comments_anonymousbooleanAutoriser les commentaires anonymes
comments_autopublishbooleanPublier automatiquement les nouveaux commentaires
is_rss_enabledbooleanActive le module de syndication
rss_post_countintegerNombre de billet à diffuser dans le flux

Commandes

Retourne les paramètres des commandes GET
/v1/sites/{code_site}/prefs/checkout.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_enabled": "boolean",
    "order_prefix": "string",
    "min_order_amount": "float",
    "stockout_selling": "boolean",
    "stockout_threshold": "integer",
    "decrement_stock": "string",
    "mail_recipients": "string",
    "mail_pending": "string",
    "mail_processing": "string",
    "mail_processed": "string",
    "mail_shipped": "string",
    "mail_cancelled": "string"
}
NomTypeDescription
is_enabledbooleanActive la vente en ligne
order_prefixstringLettre de préfixe des commandes
min_order_amountfloatMinimum de commande
stockout_sellingbooleanAutorise la vente hors stock
stockout_thresholdintegerSeuil à partir duquel les produits sont affichés en rupture
decrement_stockstringDetermine la règle de destockage
mail_recipientsstringDestinataires des emails de confirmations de commande (séparés par des virgules)
mail_pendingstringEmail de confirmation d'enregistrement de commande
mail_processingstringEmail de notification de passage de commande en status "en cours"
mail_processedstringEmail de notification de passage de commande en status "traitée"
mail_shippedstringEmail de notification de passage de commande en status "expédiée"
mail_cancelledstringEmail de notification de passage de commande en status "annulée"
Modifie les paramètres des commandes PUT
/v1/sites/{code_site}/prefs/checkout.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_enabledbooleanActive la vente en ligne
order_prefixstringLettre de préfixe des commandes
min_order_amountfloatMinimum de commande
stockout_sellingbooleanAutorise la vente hors stock
stockout_thresholdintegerSeuil à partir duquel les produits sont affichés en rupture
decrement_stockstringDetermine la règle de déstockage parmis les valeurs suivantes :
neverJamais
at_paymentDès qu'il est commandé et payé

Les valeurs attendues sont : never, at_payment
mail_recipientsarrayDestinataires des emails de confirmations de commande
mail_pendingstringEmail de confirmation d'enregistrement de commande
mail_processingstringEmail de notification de passage de commande en status "en cours"
mail_processedstringEmail de notification de passage de commande en status "traitée"
mail_shippedstringEmail de notification de passage de commande en status "expédiée"
mail_cancelledstringEmail de notification de passage de commande en status "annulée"

Catalogue

Retourne les paramètres du catalogue GET
/v1/sites/{code_site}/prefs/catalog.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_enabled": "boolean",
    "currency": "string",
    "display_taxes": "boolean",
    "is_duty_free": "boolean",
    "comments_allowed": "boolean",
    "comments_captcha": "boolean",
    "comments_anonymous": "boolean",
    "comments_autopublish": "boolean",
    "require_auth": "boolean"
}
NomTypeDescription
is_enabledbooleanActive du catalogue
currencystringDevise du catalogue
display_taxesbooleanAffichage des prix en TTC
is_duty_freebooleanActiver l'exonération de TVA
comments_allowedbooleanAutoriser les nouveaux commentaires
comments_captchabooleanProtéger les commentaires par captcha
comments_anonymousbooleanAutoriser les commentaires anonymes
comments_autopublishbooleanPublier automatiquement les nouveaux commentaires
require_authbooleanVente privée
Modifie les paramètres du catalogue PUT
/v1/sites/{code_site}/prefs/catalog.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_enabledbooleanActive du catalogue
currencystringDevise du catalogue
display_taxesbooleanAffichage des prix en TTC
is_duty_freebooleanActiver l'exonération de TVA
comments_allowedbooleanAutoriser les nouveaux commentaires
comments_captchabooleanProtéger les commentaires par captcha
comments_anonymousbooleanAutoriser les commentaires anonymes
comments_autopublishbooleanPublier automatiquement les nouveaux commentaires
require_authbooleanVente privée

Membres

Retourne les paramètres des membres GET
/v1/sites/{code_site}/prefs/customers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "allow_registration": "boolean",
    "allow_login": "boolean",
    "validation": "string",
    "default_group_id": "integer",
    "default_group_label": "string",
    "terms": "string",
    "processing_purposes": "string"
}
NomTypeDescription
allow_registrationbooleanAutoriser la création de nouveaux comptes
allow_loginbooleanAutoriser la connexion
validationstringType de validation. Les valeurs possibles sont : captcha, email, auto
default_group_idintegerIdentifiant du groupe d'utilisateur par défaut
default_group_labelstringGroupe d'utilisateur par défaut
termsstringConditions générales d'utilisation
processing_purposesstringTraitements et finalités de la collecte des données des clients
Modifie les paramètres des membres PUT
/v1/sites/{code_site}/prefs/customers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
allow_registrationbooleanAutoriser la création de nouveaux comptes
allow_loginbooleanAutoriser la connexion
validationstringType de validation parmis les valeurs suivantes :
captchaPar captcha
emailPar email

Les valeurs attendues sont : captcha, email
default_group_idintegerGroupe d'utilisateur par défaut
termsstringConditions générales d'utilisation
processing_purposesstringTraitements et finalités de la collecte des données des clients

Médiathèque

Retourne la configuration des tailles des images GET
/v1/sites/{code_site}/prefs/medias.json

Liste les tailles des vignettes et des mignatures générées à partir des images de la médiathèque.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "g_vignette_width": "integer",
    "g_vignette_height": "integer",
    "vignette_width": "integer",
    "vignette_height": "integer",
    "g_miniature_width": "integer",
    "g_miniature_height": "integer",
    "miniature_width": "integer",
    "miniature_height": "integer",
    "max_height": "integer",
    "max_width": "integer",
    "is_resize_enabled": "boolean",
    "jpg_compression": "integer"
}
NomTypeDescription
g_vignette_widthintegerLargeur des grandes vignettes en pixel
g_vignette_heightintegerHauteur des grandes vignettes en pixel
vignette_widthintegerLargeur des vignettes en pixel
vignette_heightintegerHauteur des vignettes en pixel
g_miniature_widthintegerLargeur des grandes miniatures en pixel
g_miniature_heightintegerHauteur des grandes miniatures en pixel
miniature_widthintegerLargeur des miniatures en pixel
miniature_heightintegerHauteur des miniatures en pixel
max_heightFacultatifintegerHauteur maximale des images (Médiathèque avancée)
max_widthFacultatifintegerLargeur maximale des images (Médiathèque avancée)
is_resize_enabledFacultatifbooleanActive le redimensionnement automatique (Médiathèque avancée)
jpg_compressionFacultatifintegerTaux de compression des jpg (Médiathèque avancée)
Modifie les tailles des images PUT
/v1/sites/{code_site}/prefs/medias.json

Modifie les tailles des vignettes et des mignatures générées à partir des images de la médiathèque.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
g_vignette_widthintegerLargeur des grandes vignettes en pixel
g_vignette_heightintegerHauteur des grandes vignettes en pixel
vignette_widthintegerLargeur des vignettes en pixel
vignette_heightintegerHauteur des vignettes en pixel
g_miniature_widthintegerLargeur des grandes miniatures en pixel
g_miniature_heightintegerHauteur des grandes miniatures en pixel
miniature_widthintegerLargeur des miniatures en pixel
miniature_heightintegerHauteur des miniatures en pixel
max_heightintegerHauteur maximale des images (Médiathèque avancée)
max_widthintegerLargeur maximale des images (Médiathèque avancée)
is_resize_enabledbooleanActive le redimensionnement automatique (Médiathèque avancée)
jpg_compressionintegerTaux de compression des jpg (Médiathèque avancée)

Thème graphique

Retourne les identifiants FTP GET
/v1/sites/{code_site}/prefs/ftp.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "host": "string",
    "port": "integer",
    "login": "string",
    "password": "string"
}
NomTypeDescription
hoststringHôte FTP
portintegerPort FTP
loginstringLogin FTP
passwordstringMot de passe FTP
Retourne la configuration du bloc marque GET
/v1/sites/{code_site}/prefs/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "site_excerpt": "string",
    "is_excerpt_visible": "boolean",
    "site_description": "string",
    "is_description_visible": "boolean",
    "logo_media_id": "integer",
    "is_logo_visible": "boolean"
}
NomTypeDescription
site_excerptstringAccroche du site
is_excerpt_visiblebooleanAfficher l'accroche du site
site_descriptionstringDescription site
is_description_visiblebooleanAfficher la description du site
logo_media_idintegerIdentifiant du logo du site
is_logo_visiblebooleanAfficher le logo du site
Modifie la configuration du bloc marque PUT
/v1/sites/{code_site}/prefs/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
site_excerptstringAccroche du site
is_excerpt_visiblebooleanAfficher l'accroche du site
site_descriptionstringDescription site
is_description_visiblebooleanAfficher la description du site
logo_media_idintegerIdentifiant du logo du site
is_logo_visiblebooleanAfficher le logo du site

Gestion des domaines

Liste les noms de domaines GET
/v1/sites/{code_site}/domains.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "domain_id": "integer",
        "is_main": "boolean",
        "is_provided": "boolean",
        "is_https_certified": "boolean",
        "name": "string"
    }
]
NomTypeDescription
domain_idintegerIdentifiant unique du domaine
is_mainbooleanDetermine si le domaine est le domaine principal du site
is_providedbooleanDetermine si le domaine est le domaine fournis de base avec le site
is_https_certifiedbooleanDetermine si la certification du domaine a réussi
namestringNom de domaine
Ajoute un nom de domaine POST
/v1/sites/{code_site}/domains.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
namestringNom de domaine
is_mainbooleanDomaine principal

Format de sortie :

data:[]
NomTypeDescription
Modifie un nom de domaine PUT
/v1/sites/{code_site}/domains/{id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
idObligatoireintegerIdentifiant du nom de domaine
is_mainbooleanDomaine principal
Supprime un nom de domaine DELETE
/v1/sites/{code_site}/domains/{id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
idObligatoireintegerIdentifiant du nom de domaine
Retourne les paramètres HTTPS GET
/v1/sites/{code_site}/prefs/https.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "is_enabled": "boolean",
    "status": "string",
    "domain_IP": "string"
}
NomTypeDescription
is_enabledbooleanActive l'accès HTTPS
statusFacultatifstringEtat d'activation
domain_IPstringAdresse IP de la plateforme
Modifie les paramètres HTTPS PUT
/v1/sites/{code_site}/prefs/https.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_enabledbooleanActive l'accès HTTPS

Seo

Liste les balises métas par défaut GET
/v1/sites/{code_site}/seo/meta.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "meta_title": "string",
    "meta_description": "string",
    "meta_keywords": "string",
    "js_head": "string",
    "js_body": "string"
}
NomTypeDescription
meta_titlestringBalise meta title
meta_descriptionstringBalise meta description
meta_keywordsstringBalise meta keywords
js_headstringCode avant la balise </head>
js_bodystringCode avant la balise </body>
Modifie les balises métas par défaut PUT
/v1/sites/{code_site}/seo/meta.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
meta_titlestringTitre par défaut des pages
meta_descriptionstringMeta description par défaut
meta_keywordsstringMeta keywords par défaut
js_headstringCode HTML à injecter avant la balise </body>
js_bodystringCode HTML à injecter avant la balise </html>
Liste les redirections GET
/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "uri": "string",
        "target": "string"
    }
]
NomTypeDescription
uristringUrl à rediriger
targetstringUrl de redirection
Ajoute une redirection POST
/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
uriObligatoirestringURI d'entrée
targetObligatoirestringDestination
Modifie une redirection PUT
/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
uriObligatoirestringURI d'entrée
targetObligatoirestringDestination
Supprime une redirection DELETE
/v1/sites/{code_site}/seo/redirections.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
uriObligatoirestringURI d'entrée
Modifie les redirections PUT
/v1/sites/{code_site}/seo/redirections/bulk.json

Supprime et remplace toutes les redirections en une fois.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
redirectionsObligatoirestringRedirections

Traductions

Liste les traductions GET
/v1/sites/{code_site}/l10n/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringRecherche par libellé
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

Format de sortie :

data:[
    {
        "msgid": "string",
        "msgstr": "string"
    }
]
NomTypeDescription
msgidstringMessage
msgstrstringTraduction
Modifie une traduction PUT
/v1/sites/{code_site}/l10n/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
msgidstringMessage
msgstrstringTraduction

Format de sortie :

data:{
    "msgid": "string",
    "msgstr": "string"
}
NomTypeDescription
msgidstringMessage
msgstrstringTraduction
Supprime les traductions DELETE
/v1/sites/{code_site}/l10n/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Cobranding

Retourne le co-branding GET
/v1/cobranding.json

Récupère la configuration du co-branding pour la session en cours ou pour un site en particulier.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_sitestringCode site

Format de sortie :

data:{
    "login": {
        "background": "string",
        "logo": "string"
    }
}
NomTypeDescription
loginobjectPersonnalisation de la page de login
backgroundFacultatifstringURL de l'image d'arrière plan
logoFacultatifstringURL du logo

Géographie

Liste les pays GET
/v1/geo/countries.json

Format de sortie :

data:[
    {
        "country_id": "integer",
        "name": "string",
        "code": "string",
        "group_id": "integer",
        "group_name": "string"
    }
]
NomTypeDescription
country_idintegerIdentifiant du pays
namestringNom du pays
codestringCode iso du pays
group_idintegerIdentifiant du groupe de pays
group_namestringNom du groupe de pays
Détail d'un pays GET
/v1/geo/countries/{code}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
codeObligatoirestringCode du pays sur 2 caractères

Format de sortie :

data:{
    "country_id": "integer",
    "name": "string",
    "code": "string",
    "group_id": "integer",
    "group_name": "string"
}
NomTypeDescription
country_idintegerIdentifiant du pays
namestringNom du pays
codestringCode iso du pays
group_idintegerIdentifiant du groupe de pays
group_namestringNom du groupe de pays
Détail d'un pays GET
/v1/geo/countries/{country_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
country_idObligatoireintegerIdentifiant numérique du pays

Format de sortie :

data:{
    "country_id": "integer",
    "name": "string",
    "code": "string",
    "group_id": "integer",
    "group_name": "string"
}
NomTypeDescription
country_idintegerIdentifiant du pays
namestringNom du pays
codestringCode iso du pays
group_idintegerIdentifiant du groupe de pays
group_namestringNom du groupe de pays
Cherche des codes postaux GET
/v1/geo/search.json

Retourne une liste de villes proches d'un code postal ou d'une autre ville (uniquement en France).

Paramètres supportés par ce endpoint :

NomTypeDescription
termstringTerme recherché, code postal ou nom de ville

Format de sortie :

data:[
    {
        "cities": "string",
        "distance": "float",
        "postal_code": "string"
    }
]
NomTypeDescription
citiesstringListe des villes
distancefloatDistance
postal_codestringCode postal