Membres

Résumé

Résumé des membres GET
/v1/sites/{code_site}/account.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "customers_count": "integer"
}
NomTypeDescription
customers_countintegerNombre de clients

Membres

Liste les membres GET
/v1/sites/{code_site}/account/customers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringTerme de recherche
genderstringFiltrer la liste selon le sexe
Les valeurs attendues sont : W, M
lastnamestringFiltrer la liste selon le nom
firstnamestringFiltrer la liste selon le prénom
nicknamestringFiltrer la liste selon le pseudo
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
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)
sortarrayOrdres de tri parmis les critères suivants :
name / -nameTri selon le prénom et nom du client
number / -numberTri selon le numéro de client
date / -dateTri selon la date d'inscription
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
ordersDonnées relatives aux commandes

Format de sortie :

data:[
    {
        "customer_id": "integer",
        "number": "string",
        "firstname": "string",
        "lastname": "string",
        "gender": "string",
        "email": "string",
        "is_enabled": "boolean",
        "creation_date": "string",
        "order_count": "integer",
        "order_revenues": "float",
        "order_revenues_label": "string",
        "avatar_url": "string",
        "avatar_thumb_url": "string"
    }
]
NomTypeDescription
customer_idintegerIdentifiant du client
numberstringNuméro client
firstnamestringPrénom
lastnamestringNom
genderstringSexe
emailstringEmail
is_enabledbooleanClient actif
creation_datestringDate de création
order_countFacultatifintegerNombre de commande
order_revenuesFacultatiffloatChiffre d'affaire généré
order_revenues_labelFacultatifstringChiffre d'affaire généré avec la devise
avatar_urlstringURL de l'avatar
avatar_thumb_urlstringURL de la miniature de l'avatar
Ajoute un membre POST
/v1/sites/{code_site}/account/customers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
firstnamestringPrénom
lastnamestringNom
genderstringSexe
Les valeurs attendues sont : W, M
emailstringAdresse email
passwordstringMot de passe
group_idintegerIdentifiant du groupe extranet (0 pour aucun groupe)
websitestringSite Web
nicknamestringPseudonyme
is_enabledbooleanMembre actif

Format de sortie :

data:[]
NomTypeDescription
Détail d'un membre GET
/v1/sites/{code_site}/account/customers/{customer_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
ordersDonnées relatives aux commandes

Format de sortie :

data:{
    "customer_id": "integer",
    "number": "string",
    "firstname": "string",
    "lastname": "string",
    "gender": "string",
    "email": "string",
    "group_id": "integer",
    "group_name": "string",
    "website": "string",
    "nickname": "string",
    "creation_date": "string",
    "is_enabled": "boolean",
    "avatar_url": "string",
    "avatar_thumb_url": "string"
}
NomTypeDescription
customer_idintegerIdentifiant du client
numberstringNuméro client
firstnamestringPrénom
lastnamestringNom
genderstringSexe
emailstringEmail
group_idintegerIdentifiant du groupe extranet
group_namestringGroupe extranet
websitestringSite web
nicknamestringPseudo
creation_datestringDate de création
is_enabledbooleanClient actif
avatar_urlFacultatifstringURL de l'avatar
avatar_thumb_urlFacultatifstringURL de la miniature de l'avatar
Modifie un membre PUT
/v1/sites/{code_site}/account/customers/{customer_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre à modifier
firstnamestringPrénom
lastnamestringNom
genderstringSexe
Les valeurs attendues sont : W, M
emailstringAdresse email
passwordstringMot de passe
group_idintegerIdentifiant du groupe extranet (0 pour aucun groupe)
websitestringSite Web
nicknamestringPseudonyme
is_enabledbooleanMembre actif
avatarfileAvatar

Format de sortie :

data:{
    "customer_id": "integer",
    "number": "string",
    "firstname": "string",
    "lastname": "string",
    "gender": "string",
    "email": "string",
    "group_id": "integer",
    "group_name": "string",
    "website": "string",
    "nickname": "string",
    "creation_date": "string",
    "is_enabled": "boolean",
    "avatar_url": "string",
    "avatar_thumb_url": "string"
}
NomTypeDescription
customer_idintegerIdentifiant du client
numberstringNuméro client
firstnamestringPrénom
lastnamestringNom
genderstringSexe
emailstringEmail
group_idintegerIdentifiant du groupe extranet
group_namestringGroupe extranet
websitestringSite web
nicknamestringPseudo
creation_datestringDate de création
is_enabledbooleanClient actif
avatar_urlFacultatifstringURL de l'avatar
avatar_thumb_urlFacultatifstringURL de la miniature de l'avatar
Supprime un membre DELETE
/v1/sites/{code_site}/account/customers/{customer_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre
Remises du membre GET
/v1/sites/{code_site}/account/customers/{customer_id}/discounts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre

Format de sortie :

data:{
    "discount": "float",
    "group_discount": "float",
    "categories": [
        {
            "category_id": "integer",
            "category_name": "string",
            "discount": "float",
            "group_discount": "float"
        }
    ]
}
NomTypeDescription
discountFacultatiffloatRemise globale du client
group_discountFacultatiffloatRemise globale déjà accordée par le groupe du client
categoriesobject
category_idintegerIdentifiant de la catégorie
category_namestringNom de la catégorie
discountfloatRemise de la catégorie
group_discountfloatRemise déjà accordée par le groupe du client
Modifie les remises du membre PUT
/v1/sites/{code_site}/account/customers/{customer_id}/discounts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre
discountObligatoirefloatRemise global
categoriesObligatoirearrayRemise des catégories
Historique des points de fidélité GET
/v1/sites/{code_site}/account/customers/{customer_id}/fidelity.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre
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:[
    {
        "qt": "integer",
        "comment": "string",
        "value_date": "string",
        "end_date": "string"
    }
]
NomTypeDescription
qtintegerQuantitié de points
commentstringCommentaire
value_datestringDate de valeur
end_datestringDate de fin de validité
Modifie les points de fidélité POST
/v1/sites/{code_site}/account/customers/{customer_id}/fidelity.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre
qtintegerQuantité (positif pour créditer, négatif pour débiter)
commentstringCommentaire
Liste les commandes d'un membre GET
/v1/sites/{code_site}/account/customers/{customer_id}/orders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du membre
statusstringStatut des commandes parmis les valeurs suivantes :
pendingÀ traiter
processingEn cours
processedTraitées
shippedExpédiées
cancelledAnnulées

Les valeurs attendues sont : pending, processing, processed, shipped, cancelled
is_paidbooleanCommande payée
referencestringRéférence de la commande
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
price_total_ex_vat_minfloatPrix total HT minimal
price_total_ex_vat_maxfloatPrix total HT maximal
payment_idintegerIdentifiant du mode de paiement
carrier_idintegerIdentifiant du transporteur
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:[
    {
        "order_id": "integer",
        "reference": "string",
        "customer_id": "integer",
        "customer_email": "string",
        "customer_number": "string",
        "ip_address": "string",
        "reverse_host": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "status": "string",
        "is_paid": "boolean",
        "payment_id": "integer",
        "payment_name": "string",
        "is_reintegrated": "boolean",
        "payment_date": "string",
        "payment_date_f": "string",
        "payment_date_timestamp": "integer",
        "price_total_inc_vat": "float",
        "price_total_ex_vat": "float",
        "price_total_inc_vat_label": "string",
        "price_total_ex_vat_label": "string",
        "price_vat": "float",
        "price_items_inc_vat": "float",
        "price_items_ex_vat": "float",
        "base_price": "string",
        "currency": "string",
        "is_tax_free": "boolean",
        "comment": "string",
        "use_billing_as_shipping": "boolean",
        "shipping": {
            "carrier_id": "integer",
            "name": "string",
            "type": "string",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "vat_rate": "float",
            "weight": "integer",
            "is_free": "boolean",
            "destination": "string",
            "picking_number": "string",
            "scheduled": "string"
        },
        "billing_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "phone": "string"
        },
        "shipping_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "phone": "string"
        },
        "voucher": {
            "code": "string",
            "type": "string",
            "amount": "float"
        },
        "items": [
            {
                "type": "string",
                "product_id": "integer",
                "variant_id": "integer",
                "reference": "string",
                "product_name": "string",
                "variant_name": "string",
                "quantity": "integer",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_total_ex_vat": "float",
                "price_total_inc_vat": "float",
                "is_discounted": "boolean",
                "discount": "float",
                "vat_rate": "float",
                "price_ecotax": "float",
                "price_ecotax_label": "string",
                "is_virtual": "boolean",
                "file_id": "integer"
            }
        ],
        "options": [
            {
                "option_id": "integer",
                "name": "string",
                "quantity": "integer",
                "value": "string",
                "vat_rate": "float",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string"
            }
        ],
        "activity": [
            {
                "message": "string",
                "date": "string",
                "user": "string"
            }
        ],
        "fidelity_reward": "integer",
        "download": {
            "form": "string",
            "xls": "string",
            "coliship": "string"
        }
    }
]
NomTypeDescription
order_idintegerIdentifiant de la commande
referencestringRéférence de la commande
customer_idintegerIdentifiant du client
customer_emailstringEmail du client
customer_numberstringNuméro du client
ip_addressstringAdresse IP du client
reverse_hoststringReverse host de l'adresse IP
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
statusstringStatut de la commande
is_paidbooleanCommande payée
payment_idintegerIdentifiant du mode de paiement
payment_namestringIntitulé du mode de paiement
is_reintegratedbooleanCommande réintégrée
payment_dateFacultatifstringDate de paiement
payment_date_fFacultatifstringDate de paiement formatée
payment_date_timestampFacultatifintegerTimestamp de la date de paiement
price_total_inc_vatfloatPrix total avec TVA
price_total_ex_vatfloatPrix total hors TVA
price_total_inc_vat_labelFacultatifstringPrix total avec TVA avec devise
price_total_ex_vat_labelFacultatifstringPrix total hors TVA avec devise
price_vatFacultatiffloatMontant total de tva
price_items_inc_vatFacultatiffloatTotal TTC des produits du panier
price_items_ex_vatFacultatiffloatTotal HT des produits du panier
base_pricestringType de prix de base
currencystringDevise
is_tax_freebooleanExonération des taxes
commentstringCommentaire
use_billing_as_shippingbooleanAdresse de facturation et livraison identiques
shippingobjectMode de transport
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
typestringType de transporteur
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
vat_ratefloatTaux de TVA
weightintegerPoids du colis
is_freebooleanFrais de port offert
destinationstringPays de destination
picking_numberstringUrl de suivi du colis
scheduledFacultatifstringDate de planification
billing_addressobjectAdresse de facturation
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
shipping_addressobjectAdresse de livraison
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
voucherFacultatifobjectBon utilisé
codestringCode coupon
typestringType de coupon. Les valeurs possibles sont : amount, percent, shipping
amountfloatMontant du coupon
itemsFacultatifobjectListe des articles
typestringType d'article. Les valeurs possibles sont : product, voucher, custom
product_idintegerIdentifiant du produit
variant_idintegerIdentifiant de la variante
referencestringRéférence de la variante
product_namestringIntitulé du produit
variant_namestringIntitulé de la variante
quantityintegerQuantité
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_total_ex_vatFacultatiffloatPrix total hors TVA
price_total_inc_vatFacultatiffloatPrix total avec TVA
is_discountedbooleanPrix promotionnel
discountfloatMontant de la réduction
vat_ratefloatTaux de TVA
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_virtualbooleanProduit virtuel
file_idFacultatifintegerIdentifiant du fichier à télécharger pour un produit virtuel
optionsFacultatifobjectListe des options
option_idintegerIdentifiant de l'option
namestringIntitulé de l'option
quantityintegerQuantité de l'option
valueFacultatifstringValeur de l'option
vat_ratefloatTaux de TVA
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
activityFacultatifobjectHistorique de la commande
messagestringContenu du message
datestringDate de l'action
userstringNom de l'auteur
fidelity_rewardintegerGain de points de fidélité
downloadFacultatifobjectLiens de téléchargement
formstringBon de commande
xlsstringExport xls
colishipFacultatifstringExport Coliship
Liste les membres d'un groupe GET
/v1/sites/{code_site}/account/groups/{group_id}/customers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
group_idObligatoireintegerIdentifiant du groupe
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:[
    {
        "customer_id": "integer",
        "number": "string",
        "firstname": "string",
        "lastname": "string",
        "gender": "string",
        "email": "string",
        "is_enabled": "boolean",
        "creation_date": "string",
        "order_count": "integer",
        "order_revenues": "float",
        "order_revenues_label": "string",
        "avatar_url": "string",
        "avatar_thumb_url": "string"
    }
]
NomTypeDescription
customer_idintegerIdentifiant du client
numberstringNuméro client
firstnamestringPrénom
lastnamestringNom
genderstringSexe
emailstringEmail
is_enabledbooleanClient actif
creation_datestringDate de création
order_countFacultatifintegerNombre de commande
order_revenuesFacultatiffloatChiffre d'affaire généré
order_revenues_labelFacultatifstringChiffre d'affaire généré avec la devise
avatar_urlstringURL de l'avatar
avatar_thumb_urlstringURL de la miniature de l'avatar

Groupes extranet

Liste les groupes extranet GET
/v1/sites/{code_site}/account/groups.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
termstringTerme de recherche
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
targetRésolution de la page de redirection

Format de sortie :

data:[
    {
        "group_id": "integer",
        "name": "string",
        "customer_count": "integer",
        "is_enabled": "boolean",
        "target_type": "string",
        "target_page": "string",
        "target_key": "string",
        "target_service": "string",
        "target_name": "string",
        "creation_date": "string"
    }
]
NomTypeDescription
group_idintegerIdentifiant du groupe extranet
namestringIntitulé du groupe
customer_countintegerNombre de client
is_enabledbooleanGroupe actif
target_typestringType de catégorie pour la page de redirection à la connexion
target_pagestringType de page de la cible
target_keystringIdentifiant de la page cible
target_serviceFacultatifstringNom de la catégorie de la cible
target_nameFacultatifstringNom de la cible
creation_datestringDate de création
Ajoute un groupe extranet POST
/v1/sites/{code_site}/account/groups.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
namestringNom du groupe
is_enabledbooleanActiver le groupe
target_typestringType de service vers lequel redirriger l'utilisateur après la connexion
target_pagestringType de page vers lequel redirriger l'utilisateur après la connexion
target_keystringidentifiant de la page vers leaquelle redirriger l'utilisateur après la connexion

Format de sortie :

data:[]
NomTypeDescription
Détail un groupe extranet GET
/v1/sites/{code_site}/account/groups/{group_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
group_idObligatoireintegerIdentifiant du groupe

Format de sortie :

data:{
    "group_id": "integer",
    "name": "string",
    "customer_count": "integer",
    "is_enabled": "boolean",
    "target_type": "string",
    "target_page": "string",
    "target_key": "string",
    "target_service": "string",
    "target_name": "string",
    "creation_date": "string"
}
NomTypeDescription
group_idintegerIdentifiant du groupe extranet
namestringIntitulé du groupe
customer_countintegerNombre de client
is_enabledbooleanGroupe actif
target_typestringType de catégorie pour la page de redirection à la connexion
target_pagestringType de page de la cible
target_keystringIdentifiant de la page cible
target_serviceFacultatifstringNom de la catégorie de la cible
target_nameFacultatifstringNom de la cible
creation_datestringDate de création
Modifie un groupe extranet PUT
/v1/sites/{code_site}/account/groups/{group_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
group_idObligatoireintegerIdentifiant du groupe
namestringNom du groupe
is_enabledbooleanActiver le groupe
target_typestringType de service vers lequel redirriger l'utilisateur après la connexion
target_pagestringType de page vers lequel redirriger l'utilisateur après la connexion
target_keystringidentifiant de la page vers laquelle redirriger l'utilisateur après la connexion
Supprime un groupe extranet DELETE
/v1/sites/{code_site}/account/groups/{group_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
group_idObligatoireintegerIdentifiant du groupe
Remises d'un groupe GET
/v1/sites/{code_site}/account/groups/{group_id}/discounts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
group_idObligatoireintegerIdentifiant du groupe

Format de sortie :

data:{
    "discount": "float",
    "categories": [
        {
            "category_id": "integer",
            "category_name": "string",
            "discount": "float"
        }
    ]
}
NomTypeDescription
discountFacultatiffloatRemise globale du groupe
categoriesobject
category_idintegerIdentifiant de la catégorie
category_namestringNom de la catégorie
discountfloatRemise de la catégorie
Modifie les remises d'un groupe PUT
/v1/sites/{code_site}/account/groups/{group_id}/discounts.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
group_idObligatoireintegerIdentifiant du groupe
discountObligatoirefloatRemise global
categoriesObligatoirearrayRemise des catégories