Membres

Session

Session courante GET
/api/v1/session.json

Vérifie la validité de la session et retourne les informations de l'utilisateur connecté.

Format de sortie :

data:{
    "is_logged": "boolean",
    "user_id": "integer",
    "firstname": "string",
    "lastname": "string",
    "gender": "string"
}
NomTypeDescription
is_loggedbooleanConnexion de l'utilisateur
user_idFacultatifintegerIdentifiant de l'utilisateur
firstnameFacultatifstringPrénom
lastnameFacultatifstringNom
genderFacultatifstringGenre. Les valeurs possibles sont : H, F
Déconnexion DELETE
/api/v1/session.json

Déconnecte l'utilisateur courant et vide son panier.

Identification PUT
/api/v1/session.json

Identifie un membre par identifiant et mot de passe.

Paramètres supportés par ce endpoint :

NomTypeDescription
loginstringIdentifiant de connexion de l'utilisateur
passwordstringMot de passe de l'utilisateur

Format de sortie :

data:{
    "is_logged": "boolean",
    "user_id": "integer",
    "firstname": "string",
    "lastname": "string",
    "gender": "string"
}
NomTypeDescription
is_loggedbooleanConnexion de l'utilisateur
user_idFacultatifintegerIdentifiant de l'utilisateur
firstnameFacultatifstringPrénom
lastnameFacultatifstringNom
genderFacultatifstringGenre. Les valeurs possibles sont : H, F

Newsletter

Membres

Retourne l'identité du membre GET
/api/v1/users/{user_id}.json

Retourne l'identité du membre indiqué. L'identifiant du membre est récupérable grâce aux endpoints dédiés aux sessions.

Paramètres supportés par ce endpoint :

NomTypeDescription
user_idObligatoireintegerIdentifiant numérique du membre

Format de sortie :

data:{
    "id": "integer",
    "number": "string",
    "firstname": "string",
    "lastname": "string",
    "gender": "string",
    "email": "string",
    "group_id": "integer",
    "website": "string",
    "nickname": "string",
    "avatar_url": "string",
    "avatar_thumb_url": "string",
    "is_in_mailinglist": "boolean"
}
NomTypeDescription
idintegerIdentifiant du membre
numberstringNuméro du membre
firstnamestringPrénom
lastnamestringNom
genderstringGenre. Les valeurs possibles sont : H, F
emailstringEmail
group_idFacultatifintegerIdentifiant du groupe extranet
websitestringSite web
nicknamestringPseudo
avatar_urlstringURL de l'avatar
avatar_thumb_urlstringURL de la miniature de l'avatar
is_in_mailinglistbooleanInscrit à la newsletter
Retourne les adresses d'un membre GET
/api/v1/users/{user_id}/addresses.json

Retourne les dernières adresses de livraison et de facturation connues. Le membre doit avoir passé au moins une commande.

Paramètres supportés par ce endpoint :

NomTypeDescription
user_idObligatoireintegerIdentifiant numérique du membre

Format de sortie :

data:{
    "billing": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country_id": "integer",
        "country": "string",
        "country_code": "string",
        "phone": "string"
    },
    "shipping": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country_id": "integer",
        "country": "string",
        "country_code": "string",
        "phone": "string"
    }
}
NomTypeDescription
billingFacultatifobjectAdresse de facturation
civilitystringCivilité. Les valeurs possibles sont : m, mme, mlle
lastnamestringNom
firstnamestringPrénom
companystringRaison sociale
addressstringAdresse
zipcodestringCode postal
citystringVille
country_idintegerIdentifiant du pays
countrystringNom du pays
country_codestringCode ISO du pays
phoneFacultatifstringNuméro de téléphone
shippingFacultatifobjectAdresse de livraison
civilitystringCivilité. Les valeurs possibles sont : m, mme, mlle
lastnamestringNom
firstnamestringPrénom
companystringRaison sociale
addressstringAdresse
zipcodestringCode postal
citystringVille
country_idintegerIdentifiant du pays
countrystringNom du pays
country_codestringCode ISO du pays
phoneFacultatifstringNuméro de téléphone

Commandes

Détail d'une commande GET
/api/v1/orders/{order_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
order_idObligatoireintegerIdentifiant numérique de la commande
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:{
    "id": "integer",
    "reference": "string",
    "client_id": "integer",
    "date": "string",
    "date_f": "string",
    "date_timestamp": "integer",
    "status": "string",
    "is_paid": "boolean",
    "price_total_inc_vat": "float",
    "price_total_ex_vat": "float",
    "price_total_inc_vat_label": "string",
    "price_total_ex_vat_label": "string",
    "base_price": "string",
    "currency": "string",
    "payment_mode": "string",
    "payment_date": "string",
    "payment_date_f": "string",
    "payment_date_timestamp": "integer",
    "has_voucher": "boolean",
    "voucher_code": "string",
    "voucher_amount": "float",
    "shipping": {
        "carrier_id": "integer",
        "name": "string",
        "description": "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",
        "require_scheduling": "string",
        "scheduled_date": "string",
        "scheduled_hour": "string"
    },
    "use_billing_as_shipping": "boolean",
    "shipping_address": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "phone": "string"
    },
    "billing_address": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "phone": "string"
    },
    "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",
            "is_discounted": "boolean",
            "discount": "float",
            "vat_rate": "float",
            "price_ecotax": "float",
            "is_virtual": "boolean",
            "file_url": "string"
        }
    ],
    "options": [
        {
            "option_id": "integer",
            "name": "string",
            "quantity": "integer",
            "value": "string",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "vat_rate": "float"
        }
    ],
    "pdf_url": "string",
    "fidelity_reward": "integer"
}
NomTypeDescription
idintegerIdentifiant de la commande
referencestringRéférence de la commande
client_idintegerIdentiifant du client
datestringDate de création
date_fstringDate de création formatée
date_timestampintegerTimestamp de la date de création
statusstringÉtat de la commande
is_paidbooleanPaiement de la commande
price_total_inc_vatfloatMontant total de la commande TTC
price_total_ex_vatfloatMontant total de la commande HT
price_total_inc_vat_labelFacultatifstringMontant total de la commande TTC formaté
price_total_ex_vat_labelFacultatifstringMontant total de la commande HT formaté
base_pricestringBase d'affichage des prix. Les valeurs possibles sont : HT, TTC
currencystringCode ISO de la devise
payment_modestringNom du moyen de paiement
payment_dateFacultatifstringDate de paiement
payment_date_fFacultatifstringDate de paiement formatée
payment_date_timestampFacultatifintegerTimestamp de la date de paiement
has_voucherbooleanPrésence d'un bon de réduction
voucher_codestringCode du bon de réduction
voucher_amountfloatValeur du bon de réduction
shippingobjectTransporteur
carrier_idintegerIdentifiant du transporteur
namestringNom du transporteur
descriptionFacultatifstringDescription
price_ex_vatfloatPrix HT
price_inc_vatfloatPrix TTC
price_ex_vat_labelFacultatifstringPrix HT formaté
price_inc_vat_labelFacultatifstringPrix TTC formaté
vat_ratefloatTaux de tva
weightintegerPoids total en grammes
is_freebooleanGratuité de la livraison
destinationstringDestination
picking_numberFacultatifstringURL de suivi du colis
require_schedulingFacultatifstringPlannification recquise. Les valeurs possibles sont : no, date, datetime
scheduled_dateFacultatifstringDate de livraison
scheduled_hourFacultatifstringHeure de livraison
use_billing_as_shippingbooleanAdresse de livraison et de facturation identique
shipping_addressobjectAdresse de livraison
civilitystringCivilité. Les valeurs possibles sont : m, mme, mlle
lastnamestringNom
firstnamestringPrénom
companystringRaison sociale
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringNom du pays
phoneFacultatifstringNuméro de téléphone
billing_addressobjectAdresse de facturation
civilitystringCivilité. Les valeurs possibles sont : m, mme, mlle
lastnamestringNom
firstnamestringPrénom
companystringRaison sociale
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringNom du pays
phoneFacultatifstringNuméro de téléphone
itemsobjectContenu de la commande
typestringIndique un produit ou un bon de réduction. Les valeurs possibles sont : product, voucher
product_idFacultatifintegerIdentifiant du produit (pour les produits)
variant_idFacultatifintegerIdentifiant de la variante (pour les produits)
referenceFacultatifstringRéférence de la variante (pour les produits)
product_namestringIntitulé du produit ou un bon de réduction
variant_nameFacultatifstringIntitulé de la variante (pour les produits)
quantityintegerQuantité
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
is_discountedbooleanEn promo
discountfloatPourcentage de remise
vat_ratefloatTaux de tva
price_ecotaxfloatMontant de l'eco taxe
is_virtualbooleanProduit virtuel
file_urlFacultatifstringURL du produit virtuel
optionsobjectOptions
option_idintegerIdentifiant de l'option
namestringNom de l'option
quantityintegerQuantitié
valuestringValeur
price_ex_vatfloatPrix HT
price_inc_vatfloatPrix TTC
price_ex_vat_labelFacultatifstringPrix HT formaté
price_inc_vat_labelFacultatifstringPrix TTC formaté
vat_ratefloatTaux de tva
pdf_urlstringURL de téléchargement de la commande
fidelity_rewardintegerGain en points de fidélité
Liste les commandes d'un membre GET
/api/v1/users/{user_id}/orders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
user_idObligatoireintegerIdentifiant numérique du membre

Format de sortie :

data:[
    {
        "id": "integer",
        "reference": "string",
        "date": "string",
        "date_f": "string",
        "date_timestamp": "integer",
        "status": "string",
        "is_paid": "boolean",
        "price_total_inc_vat": "float",
        "price_total_ex_vat": "float",
        "price_total_inc_vat_label": "string",
        "price_total_ex_vat_label": "string",
        "base_price": "string",
        "currency": "string",
        "pdf_url": "string"
    }
]
NomTypeDescription
idintegerIdentifiant de la commande
referencestringRéférence de la commande
datestringDate de création
date_fstringDate de création formatée
date_timestampintegerTimestamp de la date de création
statusstringÉtat de la commande
is_paidbooleanPaiement de la commande
price_total_inc_vatfloatMontant total de la commande TTC
price_total_ex_vatfloatMontant total de la commande HT
price_total_inc_vat_labelFacultatifstringMontant total de la commande TTC formaté
price_total_ex_vat_labelFacultatifstringMontant total de la commande HT formaté
base_pricestringBase d'affichage des prix. Les valeurs possibles sont : HT, TTC
currencystringCode ISO de la devise
pdf_urlstringURL de téléchargement de la commande