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",
"email": "string",
"gender": "string"
}| Nom | Type | Description |
|---|---|---|
is_logged | boolean | Connexion de l'utilisateur |
user_idFacultatif | integer | Identifiant de l'utilisateur |
firstnameFacultatif | string | Prénom |
lastnameFacultatif | string | Nom |
emailFacultatif | string | |
genderFacultatif | string | Genre. 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 :
| Nom | Type | Description | |
|---|---|---|---|
login | string | Identifiant de connexion de l'utilisateur | |
password | string | Mot de passe de l'utilisateur | |
Format de sortie :
data:{
"is_logged": "boolean",
"user_id": "integer",
"firstname": "string",
"lastname": "string",
"email": "string",
"gender": "string"
}| Nom | Type | Description |
|---|---|---|
is_logged | boolean | Connexion de l'utilisateur |
user_idFacultatif | integer | Identifiant de l'utilisateur |
firstnameFacultatif | string | Prénom |
lastnameFacultatif | string | Nom |
emailFacultatif | string | |
genderFacultatif | string | Genre. Les valeurs possibles sont : H, F |
Inscrition à la newsletter POST
/api/v1/newsletter.json
Inscrit un email à la newsletter
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
email | Obligatoire | Adresse email à inscrire à la newsletter du site | |
consent | boolean | Donne le consentement au traitement des données | |
Désinscrition à la newsletter DELETE
/api/v1/newsletter.json
Désinscrit un email à la newsletter
Paramètres supportés par ce endpoint :
| Nom | Type | Description | |
|---|---|---|---|
email | Obligatoire | Adresse email à désinscrire de la newsletter du site | |
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 :
| Nom | Type | Description | |
|---|---|---|---|
user_id | Obligatoire | integer | Identifiant 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"
}| Nom | Type | Description |
|---|---|---|
id | integer | Identifiant du membre |
number | string | Numéro du membre |
firstname | string | Prénom |
lastname | string | Nom |
gender | string | Genre. Les valeurs possibles sont : H, F |
email | string | |
group_idFacultatif | integer | Identifiant du groupe extranet |
website | string | Site web |
nickname | string | Pseudo |
avatar_url | string | URL de l'avatar |
avatar_thumb_url | string | URL de la miniature de l'avatar |
is_in_mailinglist | boolean | Inscrit à 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 :
| Nom | Type | Description | |
|---|---|---|---|
user_id | Obligatoire | integer | Identifiant 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"
}
}| Nom | Type | Description |
|---|---|---|
billingFacultatif | object | Adresse de facturation |
civility | string | Civilité. Les valeurs possibles sont : m, mme, mlle |
lastname | string | Nom |
firstname | string | Prénom |
company | string | Raison sociale |
address | string | Adresse |
zipcode | string | Code postal |
city | string | Ville |
country_id | integer | Identifiant du pays |
country | string | Nom du pays |
country_code | string | Code ISO du pays |
phone | string | Numéro de téléphone |
shippingFacultatif | object | Adresse de livraison |
civility | string | Civilité. Les valeurs possibles sont : m, mme, mlle |
lastname | string | Nom |
firstname | string | Prénom |
company | string | Raison sociale |
address | string | Adresse |
zipcode | string | Code postal |
city | string | Ville |
country_id | integer | Identifiant du pays |
country | string | Nom du pays |
country_code | string | Code ISO du pays |
phone | string | Numé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 :
| Nom | Type | Description | |||
|---|---|---|---|---|---|
order_id | Obligatoire | integer | Identifiant numérique de la commande | ||
extra_fields | array | Inclut des données supplémentaires à la réponse, parmis les suivantes :
| |||
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"
}| Nom | Type | Description |
|---|---|---|
id | integer | Identifiant de la commande |
reference | string | Référence de la commande |
client_id | integer | Identiifant du client |
date | string | Date de création |
date_f | string | Date de création formatée |
date_timestamp | integer | Timestamp de la date de création |
status | string | État de la commande |
is_paid | boolean | Paiement de la commande |
price_total_inc_vat | float | Montant total de la commande TTC |
price_total_ex_vat | float | Montant total de la commande HT |
price_total_inc_vat_labelFacultatif | string | Montant total de la commande TTC formaté |
price_total_ex_vat_labelFacultatif | string | Montant total de la commande HT formaté |
base_price | string | Base d'affichage des prix. Les valeurs possibles sont : HT, TTC |
currency | string | Code ISO de la devise |
payment_mode | string | Nom du moyen de paiement |
payment_dateFacultatif | string | Date de paiement |
payment_date_fFacultatif | string | Date de paiement formatée |
payment_date_timestampFacultatif | integer | Timestamp de la date de paiement |
has_voucher | boolean | Présence d'un bon de réduction |
voucher_code | string | Code du bon de réduction |
voucher_amount | float | Valeur du bon de réduction |
shipping | object | Transporteur |
carrier_id | integer | Identifiant du transporteur |
name | string | Nom du transporteur |
descriptionFacultatif | string | Description |
price_ex_vat | float | Prix HT |
price_inc_vat | float | Prix TTC |
price_ex_vat_labelFacultatif | string | Prix HT formaté |
price_inc_vat_labelFacultatif | string | Prix TTC formaté |
vat_rate | float | Taux de tva |
weight | integer | Poids total en grammes |
is_free | boolean | Gratuité de la livraison |
destination | string | Destination |
picking_numberFacultatif | string | URL de suivi du colis |
require_schedulingFacultatif | string | Plannification recquise. Les valeurs possibles sont : no, date, datetime |
scheduled_dateFacultatif | string | Date de livraison |
scheduled_hourFacultatif | string | Heure de livraison |
use_billing_as_shipping | boolean | Adresse de livraison et de facturation identique |
shipping_address | object | Adresse de livraison |
civility | string | Civilité. Les valeurs possibles sont : m, mme, mlle |
lastname | string | Nom |
firstname | string | Prénom |
company | string | Raison sociale |
address | string | Adresse |
zipcode | string | Code postal |
city | string | Ville |
country | string | Nom du pays |
phoneFacultatif | string | Numéro de téléphone |
billing_address | object | Adresse de facturation |
civility | string | Civilité. Les valeurs possibles sont : m, mme, mlle |
lastname | string | Nom |
firstname | string | Prénom |
company | string | Raison sociale |
address | string | Adresse |
zipcode | string | Code postal |
city | string | Ville |
country | string | Nom du pays |
phoneFacultatif | string | Numéro de téléphone |
items | object | Contenu de la commande |
type | string | Indique un produit ou un bon de réduction. Les valeurs possibles sont : product, voucher |
product_idFacultatif | integer | Identifiant du produit (pour les produits) |
variant_idFacultatif | integer | Identifiant de la variante (pour les produits) |
referenceFacultatif | string | Référence de la variante (pour les produits) |
product_name | string | Intitulé du produit ou un bon de réduction |
variant_nameFacultatif | string | Intitulé de la variante (pour les produits) |
quantity | integer | Quantité |
price_ex_vat | float | Prix unitaire HT |
price_inc_vat | float | Prix unitaire TTC |
price_ex_vat_labelFacultatif | string | Prix unitaire HT formaté |
price_inc_vat_labelFacultatif | string | Prix unitaire TTC formaté |
is_discounted | boolean | En promo |
discount | float | Pourcentage de remise |
vat_rate | float | Taux de tva |
price_ecotax | float | Montant de l'eco taxe |
is_virtual | boolean | Produit virtuel |
file_urlFacultatif | string | URL du produit virtuel |
options | object | Options |
option_id | integer | Identifiant de l'option |
name | string | Nom de l'option |
quantity | integer | Quantitié |
value | string | Valeur |
price_ex_vat | float | Prix HT |
price_inc_vat | float | Prix TTC |
price_ex_vat_labelFacultatif | string | Prix HT formaté |
price_inc_vat_labelFacultatif | string | Prix TTC formaté |
vat_rate | float | Taux de tva |
pdf_url | string | URL de téléchargement de la commande |
fidelity_reward | integer | Gain 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 :
| Nom | Type | Description | |
|---|---|---|---|
user_id | Obligatoire | integer | Identifiant 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"
}
]| Nom | Type | Description |
|---|---|---|
id | integer | Identifiant de la commande |
reference | string | Référence de la commande |
date | string | Date de création |
date_f | string | Date de création formatée |
date_timestamp | integer | Timestamp de la date de création |
status | string | État de la commande |
is_paid | boolean | Paiement de la commande |
price_total_inc_vat | float | Montant total de la commande TTC |
price_total_ex_vat | float | Montant total de la commande HT |
price_total_inc_vat_labelFacultatif | string | Montant total de la commande TTC formaté |
price_total_ex_vat_labelFacultatif | string | Montant total de la commande HT formaté |
base_price | string | Base d'affichage des prix. Les valeurs possibles sont : HT, TTC |
currency | string | Code ISO de la devise |
pdf_url | string | URL de téléchargement de la commande |