Import/Export

Contenu du site web

Export du contenu des pages du site POST
/v1/sites/{code_site}/export/cms/posts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
page_idintegerIdentifiant de la page
formatstringFormat d'export
Les valeurs attendues sont : pdf, xls

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export des pages du site GET
/v1/sites/{code_site}/export/cms/posts/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL
Import de contenu dans le site Web POST
/v1/sites/{code_site}/import/cms/posts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filefileFichier d'import
page_idintegerPage
typestringType par défaut des billets
modestringMode d'import
Les valeurs attendues sont : add, replace
is_visiblebooleanAffichage par défaut des billets

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'erreur d'un import GET
/v1/sites/{code_site}/import/cms/posts/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Formulaire Dismoi?

Export des réponses dismoi POST
/v1/sites/{code_site}/export/forms/responses.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
form_idintegerIdentifiant du formulaire

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export des réponses dismoi GET
/v1/sites/{code_site}/export/forms/responses/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL

Médiathèque

Export d'un dossier de la mediathèque POST
/v1/sites/{code_site}/export/media/folder.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
folder_idintegerIdentifiant du dossier

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export de la mediathèque GET
/v1/sites/{code_site}/export/media/folder/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL
Import de fichiers POST
/v1/sites/{code_site}/import/media/files.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
urlstringURL du fichier à importer
folder_idintegerIdentifiant du dossier de la mediathèque
max_heightintegerHauteur maximale des images
max_widthintegerLargeur maximale des images
unzipbooleanDécompresse l'archive zip
jpg_compressionintegerTaux de compression des jpg (85 par défaut)

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'erreur d'un import GET
/v1/sites/{code_site}/import/media/files/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken
Liste les fichiers importables GET
/v1/sites/{code_site}/import/media/ftp.json

Liste les fichiers disponibles pour l'import dans l'espace FTP du site.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
Import de fichiers FTP POST
/v1/sites/{code_site}/import/media/ftp.json

Importe dans un dossier de la médiathèque tout ou une partie des fichiers présents dans l'espace FTP.

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filesarrayFichiers
folder_idintegerIdentifiant du dossier de la médithèque
Rapport d'erreur d'un import FTP GET
/v1/sites/{code_site}/import/media/ftp/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Produits

Export de produits du catalogue POST
/v1/sites/{code_site}/export/catalog/products.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringTerme de la recherche
category_idintegerIdentifiant de catégorie
tag_idintegerIdentifiant de tag
stockstringEtat du stock
Les valeurs attendues sont : yes, no, partial
brand_idintegerIdentifiant de la marque
price_minfloatPrix minimum
price_maxfloatPrix maximum
available_date_minstringDisponible après cette date
available_date_maxstringDisponible avant cette date
is_visiblebooleanAffiché sur le site
is_spotlightbooleanProduit vedette
typestringType de produit
variant_namestringIntitulé de la variante
variant_conditionstringEtat de la variante parmis les valeurs suivantes :
newNeuf
usedOccasion
refurbishedReconditionné

Les valeurs attendues sont : new, used, refurbished
variant_gtinstringEAN de la variante
variant_referencestringRéférence de la variante
linked_count_minintegerAvec un minimum de produits associés
linked_count_maxintegerAvec un maximum de produits associés
rate_minfloatAvec une note minimum
rate_maxfloatAvec une note maximum
comments_minintegerAvec un minimum de commentaires
comments_maxintegerAvec un maximum de commantaires
weight_minintegerAvec un poids minimum (en grammes)
weight_maxintegerAvec un poids maximum (en grammes)

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export de produits du catalogue GET
/v1/sites/{code_site}/export/catalog/products/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL
Import de produits POST
/v1/sites/{code_site}/import/catalog/products.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filefileFichier d'import
category_idintegerCatégorie par défaut
is_visiblebooleanAffichage par défaut des catégories

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'analyse d'un fichier d'import de produit GET
/v1/sites/{code_site}/import/catalog/products/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken
Importe les produits PUT
/v1/sites/{code_site}/import/catalog/products/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant

Membres

Export des membres POST
/v1/sites/{code_site}/export/account/customers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringTerme de la recherche
emailstringFiltrer la liste selon l'adresse email
group_idintegerIdentifiant du groupe extranet
is_enabledbooleanMembre actif
creation_date_minstringAffiche uniquement les comptes créé avant une date
creation_date_maxstringAffiche uniquement les comptes créé après une date
is_in_mailinglistbooleanMembre inscrit à la newsletter
order_count_minintegerNombre minimum de commande
order_count_maxintegerNombre maximum de commande
order_revenues_minintegerChiffre d'affaire généré minimum
order_revenues_maxintegerChiffre d'affaire généré maximum

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export de membres GET
/v1/sites/{code_site}/export/account/customers/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL

Commandes

Export des commandes POST
/v1/sites/{code_site}/export/checkout/orders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringTerme de la recherche
is_paidbooleanCommande payée
statusstringStatut de la commande
Les valeurs attendues sont : pending, processing, processed, shipped, cancelled
typestringType d'export
Les valeurs attendues sont : xls, coliship, inet
customer_idintegerIdentifiant du client
creation_date_minstringDate de création minimale
creation_date_maxstringDate de création maximale
payment_date_minstringDate de paiement minimale
payment_date_maxstringDate de paiement maximale
price_total_inc_vat_minfloatPrix total TTC minimal
price_total_inc_vat_maxfloatPrix total TTC maximal
payment_idintegerIdentifiant du mode de paiement
carrier_idintegerIdentifiant du transporteur
fidelity_reward_minintegerPoints de fidélité minimal
fidelity_reward_maxintegerPoints de fidélité maximal

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export de commandes GET
/v1/sites/{code_site}/export/checkout/orders/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL

Abonnés à la newsletter

Export des abonnés à la newsletter POST
/v1/sites/{code_site}/export/subscribers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
is_registeredbooleanFiltre par inscription

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Résultat d'un export des abonnés à la newsletter GET
/v1/sites/{code_site}/export/subscribers/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
urlstringURL

Coliship

Import coliship POST
/v1/sites/{code_site}/import/checkout/coliship.json

Import des données d'expéditions coliship

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filefileFichier d'import
notifybooleanNotifier par email le changement de status

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'analyse d'un fichier d'import coliship GET
/v1/sites/{code_site}/import/checkout/coliship/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken
Importe les données PUT
/v1/sites/{code_site}/import/checkout/coliship/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant

Wordpress

Import du contenu d'un site Wordpress POST
/v1/sites/{code_site}/import/wordpress.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filefileFichier d'import
urlstringURL
loginstringIdentifiant
passwordstringMot de passe
import_mediabooleanImport de la médiathèque
import_pagesstringImport des pages
authorintegerAuteur des contenus
typestringType par défaut des billets
thumbnailstring
mediumstring
largestring

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'analyse du site GET
/v1/sites/{code_site}/import/wordpress/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken
Importe le site PUT
/v1/sites/{code_site}/import/wordpress/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant

Traductions

Export des traductions POST
/v1/sites/{code_site}/export/l10n/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:
NomTypeDescription
urlstringURL
Import des traductions POST
/v1/sites/{code_site}/import/l10n/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filefileFichier d'import

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'analyse d'un fichier d'import de traductions GET
/v1/sites/{code_site}/import/l10n/theme/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Thème

Import de theme personnalisé POST
/v1/sites/{code_site}/import/theme.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
filefileFichier d'import
with_contentbooleanImporte également le contenu
copyrights_acquiredbooleanImporte également le contenu

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
Rapport d'erreur d'un import GET
/v1/sites/{code_site}/import/theme/{token}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tokenObligatoirestringToken

Tâches

Statut d'un job GET
/v1/sites/{code_site}/jobs/{job_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
job_idObligatoireintegerIdentifiant du job

Format de sortie :

data:
NomTypeDescription
job_idintegerIdentifiant
progressionintegerProgression
statusstringStatut du job
errorstringErreur
stepstringEtape
resultstringRésultat