Panier

Contenu du panier

Résumé du panier GET
/api/v1/cart.json

Paramètres supportés par ce endpoint :

NomTypeDescription
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:{
    "currency": "string",
    "min_order_amount": "float",
    "items_count": "integer",
    "items": [
        {
            "variant_id": "integer",
            "type": "string",
            "name": "string",
            "sku": "string",
            "product_id": "integer",
            "product_name": "string",
            "product_description": "string",
            "product_header": "string",
            "product_excerpt": "string",
            "product_url": "string",
            "is_discounted": "boolean",
            "discount_rate": "float",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_base_ex_vat": "float",
            "price_base_inc_vat": "float",
            "price_ecotax": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "price_base_ex_vat_label": "string",
            "price_base_inc_vat_label": "string",
            "price_ecotax_label": "string",
            "quantity": "integer",
            "quantity_max": "integer",
            "quantity_max_warn": "boolean",
            "price_total_ex_vat": "float",
            "price_total_inc_vat": "float",
            "price_total_ex_vat_label": "string",
            "price_total_inc_vat_label": "string",
            "thumb": {
                "id": "integer",
                "title": "string",
                "description": "string",
                "url": "string",
                "url_miniature": "string",
                "url_vignette": "string",
                "url_g_miniature": "string",
                "url_g_vignette": "string"
            }
        }
    ],
    "options": [
        {
            "option_id": "integer",
            "type": "string",
            "name": "string",
            "description": "string",
            "quantity": "integer",
            "value": "string",
            "options": [
                []
            ],
            "price_inc_vat": "float",
            "price_ex_vat": "float",
            "price_inc_vat_label": "string",
            "price_ex_vat_label": "string"
        }
    ],
    "voucher": {
        "code": "string",
        "value": "float",
        "type": "string",
        "label": "string"
    },
    "is_duty_free": "boolean",
    "price_subtotal_ex_vat": "float",
    "price_subtotal_inc_vat": "float",
    "price_total_ecotax": "float",
    "price_total_ex_vat": "float",
    "price_total_vat": "float",
    "price_total_inc_vat": "float",
    "price_subtotal_ex_vat_label": "string",
    "price_subtotal_inc_vat_label": "string",
    "price_total_ecotax_label": "string",
    "price_total_ex_vat_label": "string",
    "price_total_vat_label": "string",
    "price_total_inc_vat_label": "string",
    "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"
    }
}
NomTypeDescription
currencystringDevise
min_order_amountfloatMontant minimal de commande sur le site
items_countintegerNombre d'articles dans le panier
itemsFacultatifobjectArticles du panier
variant_idintegerIdentifiant de la variante
typestringType d'article. Les valeurs possibles sont : product, voucher
namestringIntitulé de la variante
skustringRéférence de la variante
product_idintegerIdentifiant du produit
product_namestringNom du produit
product_descriptionstringDescription du produit
product_headerstringChapô du produit
product_excerptstringAccroche du produit
product_urlstringURL du produit
is_discountedbooleanProduit remisé
discount_ratefloatRemise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_base_ex_vatfloatPrix unitaire de base non remisé HT
price_base_inc_vatfloatPrix unitaire de base non remisé TTC
price_ecotaxfloatMontant de l'eco taxe
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
price_base_ex_vat_labelFacultatifstringPrix unitaire de base non remisé HT formaté
price_base_inc_vat_labelFacultatifstringPrix unitaire de base non remisé TTC formaté
price_ecotax_labelFacultatifstringMontant de l'eco taxe formaté
quantityintegerQuantité
quantity_maxFacultatifintegerQuantité maximale autorisée dans le panier
quantity_max_warnbooleanErreur de dépassement de quantité maximale
price_total_ex_vatfloatPrix total HT
price_total_inc_vatfloatPrix total TTC
price_total_ex_vat_labelFacultatifstringPrix total HT formaté
price_total_inc_vat_labelFacultatifstringPrix total TTC formaté
thumbFacultatifobjectIllustration de l'article
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
optionsFacultatifobjectOptions du panier
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
voucherFacultatifobjectBon de réduction
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
is_duty_freebooleanExonération de la TVA
price_subtotal_ex_vatfloatSous total HT des produits du panier
price_subtotal_inc_vatfloatSous total TTC des produits du panier
price_total_ecotaxfloatTotal de l'éco taxe
price_total_ex_vatfloatTotal du panier HT
price_total_vatfloatTotal de la TVA
price_total_inc_vatfloatTotal du panier TTC
price_subtotal_ex_vat_labelFacultatifstringSous total HT des produits du panier formaté
price_subtotal_inc_vat_labelFacultatifstringSous total TTC des produits du panier formaté
price_total_ecotax_labelFacultatifstringTotal de l'éco taxe formaté
price_total_ex_vat_labelFacultatifstringTotal du panier HT formaté
price_total_vat_labelFacultatifstringTotal de la TVA formaté
price_total_inc_vat_labelFacultatifstringTotal du panier TTC formaté
shippingFacultatifobjectLivraison
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
Vide le panier DELETE
/api/v1/cart.json
Ajout multiple de variantes au panier PUT
/api/v1/cart/items.json

Modifie en une fois le contenu du panier. Il est possible de modifier les quantitiés en valeur absolue ou relative. Les variantes avec une quantité nulle sont retirés du panier. Pour ajouter une variante au panier, il suffit d'indiquer une quantité non nulle.

Paramètres supportés par ce endpoint :

NomTypeDescription
modestringMode d'ajout.
besteffort (mode par défaut) : le système tente d'ajouter le maximum de produits disponibles.
strict : si la quantité souhaité n'est pas disponible, aucun produit n'est ajouté
Les valeurs attendues sont : besteffort, strict
itemsarraytableau associatif, variante => quantité souhaitée. La quantité peut être éxprimée de façon absolue ou relative au format X, +X ou -X
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:{
    "summary": [
        {
            "status": "string",
            "message": "string",
            "id": "integer",
            "max": "integer"
        }
    ],
    "cart": {
        "currency": "string",
        "min_order_amount": "float",
        "items_count": "integer",
        "items": [
            {
                "variant_id": "integer",
                "type": "string",
                "name": "string",
                "sku": "string",
                "product_id": "integer",
                "product_name": "string",
                "product_description": "string",
                "product_header": "string",
                "product_excerpt": "string",
                "product_url": "string",
                "is_discounted": "boolean",
                "discount_rate": "float",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_base_ex_vat": "float",
                "price_base_inc_vat": "float",
                "price_ecotax": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_base_ex_vat_label": "string",
                "price_base_inc_vat_label": "string",
                "price_ecotax_label": "string",
                "quantity": "integer",
                "quantity_max": "integer",
                "quantity_max_warn": "boolean",
                "price_total_ex_vat": "float",
                "price_total_inc_vat": "float",
                "price_total_ex_vat_label": "string",
                "price_total_inc_vat_label": "string",
                "thumb": {
                    "id": "integer",
                    "title": "string",
                    "description": "string",
                    "url": "string",
                    "url_miniature": "string",
                    "url_vignette": "string",
                    "url_g_miniature": "string",
                    "url_g_vignette": "string"
                }
            }
        ],
        "options": [
            {
                "option_id": "integer",
                "type": "string",
                "name": "string",
                "description": "string",
                "quantity": "integer",
                "value": "string",
                "options": [
                    []
                ],
                "price_inc_vat": "float",
                "price_ex_vat": "float",
                "price_inc_vat_label": "string",
                "price_ex_vat_label": "string"
            }
        ],
        "voucher": {
            "code": "string",
            "value": "float",
            "type": "string",
            "label": "string"
        },
        "is_duty_free": "boolean",
        "price_subtotal_ex_vat": "float",
        "price_subtotal_inc_vat": "float",
        "price_total_ecotax": "float",
        "price_total_ex_vat": "float",
        "price_total_vat": "float",
        "price_total_inc_vat": "float",
        "price_subtotal_ex_vat_label": "string",
        "price_subtotal_inc_vat_label": "string",
        "price_total_ecotax_label": "string",
        "price_total_ex_vat_label": "string",
        "price_total_vat_label": "string",
        "price_total_inc_vat_label": "string",
        "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"
        }
    }
}
NomTypeDescription
summaryobjectRapport de l'action effectuée
statusstringStatus. Les valeurs possibles sont : ok, warn, error
messageFacultatifstringMessage d'erreur
idintegerIdentifiant de la variante
maxFacultatifintegerQuantité maximale autorisée
cartobjectPanier mis à jour
currencystringDevise
min_order_amountfloatMontant minimal de commande sur le site
items_countintegerNombre d'articles dans le panier
itemsFacultatifobjectArticles du panier
variant_idintegerIdentifiant de la variante
typestringType d'article. Les valeurs possibles sont : product, voucher
namestringIntitulé de la variante
skustringRéférence de la variante
product_idintegerIdentifiant du produit
product_namestringNom du produit
product_descriptionstringDescription du produit
product_headerstringChapô du produit
product_excerptstringAccroche du produit
product_urlstringURL du produit
is_discountedbooleanProduit remisé
discount_ratefloatRemise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_base_ex_vatfloatPrix unitaire de base non remisé HT
price_base_inc_vatfloatPrix unitaire de base non remisé TTC
price_ecotaxfloatMontant de l'eco taxe
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
price_base_ex_vat_labelFacultatifstringPrix unitaire de base non remisé HT formaté
price_base_inc_vat_labelFacultatifstringPrix unitaire de base non remisé TTC formaté
price_ecotax_labelFacultatifstringMontant de l'eco taxe formaté
quantityintegerQuantité
quantity_maxFacultatifintegerQuantité maximale autorisée dans le panier
quantity_max_warnbooleanErreur de dépassement de quantité maximale
price_total_ex_vatfloatPrix total HT
price_total_inc_vatfloatPrix total TTC
price_total_ex_vat_labelFacultatifstringPrix total HT formaté
price_total_inc_vat_labelFacultatifstringPrix total TTC formaté
thumbFacultatifobjectIllustration de l'article
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
optionsFacultatifobjectOptions du panier
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
voucherFacultatifobjectBon de réduction
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
is_duty_freebooleanExonération de la TVA
price_subtotal_ex_vatfloatSous total HT des produits du panier
price_subtotal_inc_vatfloatSous total TTC des produits du panier
price_total_ecotaxfloatTotal de l'éco taxe
price_total_ex_vatfloatTotal du panier HT
price_total_vatfloatTotal de la TVA
price_total_inc_vatfloatTotal du panier TTC
price_subtotal_ex_vat_labelFacultatifstringSous total HT des produits du panier formaté
price_subtotal_inc_vat_labelFacultatifstringSous total TTC des produits du panier formaté
price_total_ecotax_labelFacultatifstringTotal de l'éco taxe formaté
price_total_ex_vat_labelFacultatifstringTotal du panier HT formaté
price_total_vat_labelFacultatifstringTotal de la TVA formaté
price_total_inc_vat_labelFacultatifstringTotal du panier TTC formaté
shippingFacultatifobjectLivraison
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
Ajout ou retrait de variante au panier PUT
/api/v1/cart/items/{variant_id}.json

Ajoute ou retire une quantité de variante au panier. Il est possbile de le faire en valeur absolue ou relative.

Paramètres supportés par ce endpoint :

NomTypeDescription
variant_idObligatoireintegerIdentifiant numérique de la variante
quantitystringQuantité absolue ou relative au format X, +X ou -X (+1 par défaut)
modestringMode d'ajout. En mode besteffort (mode par défaut) le système tente d'ajouter le maximum de produits disponibles. En mode strict, si la quantité souhaitée n'est pas disponible, aucun produit n'est ajouté
Les valeurs attendues sont : besteffort, strict
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:{
    "summary": [
        {
            "status": "string",
            "message": "string",
            "id": "integer",
            "max": "integer"
        }
    ],
    "cart": {
        "currency": "string",
        "min_order_amount": "float",
        "items_count": "integer",
        "items": [
            {
                "variant_id": "integer",
                "type": "string",
                "name": "string",
                "sku": "string",
                "product_id": "integer",
                "product_name": "string",
                "product_description": "string",
                "product_header": "string",
                "product_excerpt": "string",
                "product_url": "string",
                "is_discounted": "boolean",
                "discount_rate": "float",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_base_ex_vat": "float",
                "price_base_inc_vat": "float",
                "price_ecotax": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_base_ex_vat_label": "string",
                "price_base_inc_vat_label": "string",
                "price_ecotax_label": "string",
                "quantity": "integer",
                "quantity_max": "integer",
                "quantity_max_warn": "boolean",
                "price_total_ex_vat": "float",
                "price_total_inc_vat": "float",
                "price_total_ex_vat_label": "string",
                "price_total_inc_vat_label": "string",
                "thumb": {
                    "id": "integer",
                    "title": "string",
                    "description": "string",
                    "url": "string",
                    "url_miniature": "string",
                    "url_vignette": "string",
                    "url_g_miniature": "string",
                    "url_g_vignette": "string"
                }
            }
        ],
        "options": [
            {
                "option_id": "integer",
                "type": "string",
                "name": "string",
                "description": "string",
                "quantity": "integer",
                "value": "string",
                "options": [
                    []
                ],
                "price_inc_vat": "float",
                "price_ex_vat": "float",
                "price_inc_vat_label": "string",
                "price_ex_vat_label": "string"
            }
        ],
        "voucher": {
            "code": "string",
            "value": "float",
            "type": "string",
            "label": "string"
        },
        "is_duty_free": "boolean",
        "price_subtotal_ex_vat": "float",
        "price_subtotal_inc_vat": "float",
        "price_total_ecotax": "float",
        "price_total_ex_vat": "float",
        "price_total_vat": "float",
        "price_total_inc_vat": "float",
        "price_subtotal_ex_vat_label": "string",
        "price_subtotal_inc_vat_label": "string",
        "price_total_ecotax_label": "string",
        "price_total_ex_vat_label": "string",
        "price_total_vat_label": "string",
        "price_total_inc_vat_label": "string",
        "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"
        }
    }
}
NomTypeDescription
summaryobjectRapport de l'action effectuée
statusstringStatus. Les valeurs possibles sont : ok, warn, error
messageFacultatifstringMessage d'erreur
idintegerIdentifiant de la variante
maxFacultatifintegerQuantité maximale autorisée
cartobjectPanier mis à jour
currencystringDevise
min_order_amountfloatMontant minimal de commande sur le site
items_countintegerNombre d'articles dans le panier
itemsFacultatifobjectArticles du panier
variant_idintegerIdentifiant de la variante
typestringType d'article. Les valeurs possibles sont : product, voucher
namestringIntitulé de la variante
skustringRéférence de la variante
product_idintegerIdentifiant du produit
product_namestringNom du produit
product_descriptionstringDescription du produit
product_headerstringChapô du produit
product_excerptstringAccroche du produit
product_urlstringURL du produit
is_discountedbooleanProduit remisé
discount_ratefloatRemise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_base_ex_vatfloatPrix unitaire de base non remisé HT
price_base_inc_vatfloatPrix unitaire de base non remisé TTC
price_ecotaxfloatMontant de l'eco taxe
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
price_base_ex_vat_labelFacultatifstringPrix unitaire de base non remisé HT formaté
price_base_inc_vat_labelFacultatifstringPrix unitaire de base non remisé TTC formaté
price_ecotax_labelFacultatifstringMontant de l'eco taxe formaté
quantityintegerQuantité
quantity_maxFacultatifintegerQuantité maximale autorisée dans le panier
quantity_max_warnbooleanErreur de dépassement de quantité maximale
price_total_ex_vatfloatPrix total HT
price_total_inc_vatfloatPrix total TTC
price_total_ex_vat_labelFacultatifstringPrix total HT formaté
price_total_inc_vat_labelFacultatifstringPrix total TTC formaté
thumbFacultatifobjectIllustration de l'article
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
optionsFacultatifobjectOptions du panier
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
voucherFacultatifobjectBon de réduction
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
is_duty_freebooleanExonération de la TVA
price_subtotal_ex_vatfloatSous total HT des produits du panier
price_subtotal_inc_vatfloatSous total TTC des produits du panier
price_total_ecotaxfloatTotal de l'éco taxe
price_total_ex_vatfloatTotal du panier HT
price_total_vatfloatTotal de la TVA
price_total_inc_vatfloatTotal du panier TTC
price_subtotal_ex_vat_labelFacultatifstringSous total HT des produits du panier formaté
price_subtotal_inc_vat_labelFacultatifstringSous total TTC des produits du panier formaté
price_total_ecotax_labelFacultatifstringTotal de l'éco taxe formaté
price_total_ex_vat_labelFacultatifstringTotal du panier HT formaté
price_total_vat_labelFacultatifstringTotal de la TVA formaté
price_total_inc_vat_labelFacultatifstringTotal du panier TTC formaté
shippingFacultatifobjectLivraison
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
Supprime un produit du panier DELETE
/api/v1/cart/items/{variant_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
variant_idObligatoireintegerIdentifiant unique de la variante

Options à la commande

Liste les options à la commande GET
/api/v1/cart/options.json

Paramètres supportés par ce endpoint :

NomTypeDescription
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:{
    "available": [
        {
            "option_id": "integer",
            "type": "string",
            "name": "string",
            "description": "string",
            "quantity": "integer",
            "value": "string",
            "options": [
                []
            ],
            "price_inc_vat": "float",
            "price_ex_vat": "float",
            "price_inc_vat_label": "string",
            "price_ex_vat_label": "string"
        }
    ],
    "in_cart": [
        {
            "option_id": "integer",
            "type": "string",
            "name": "string",
            "description": "string",
            "quantity": "integer",
            "value": "string",
            "options": [
                []
            ],
            "price_inc_vat": "float",
            "price_ex_vat": "float",
            "price_inc_vat_label": "string",
            "price_ex_vat_label": "string"
        }
    ]
}
NomTypeDescription
availableobjectOptions disponibles
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
in_cartobjectOptions souscrites
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
Ajoute une option PUT
/api/v1/cart/options/{option_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
option_idObligatoireintegerIdentifiant de l'option à la commande
valuestringValeur de l'option à la commande pour les options de type zone de texte ou liste déroulante
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:{
    "summary": [
        {
            "status": "string",
            "message": "string",
            "id": "integer",
            "max": "integer"
        }
    ],
    "options": {
        "available": [
            {
                "option_id": "integer",
                "type": "string",
                "name": "string",
                "description": "string",
                "quantity": "integer",
                "value": "string",
                "options": [
                    []
                ],
                "price_inc_vat": "float",
                "price_ex_vat": "float",
                "price_inc_vat_label": "string",
                "price_ex_vat_label": "string"
            }
        ],
        "in_cart": [
            {
                "option_id": "integer",
                "type": "string",
                "name": "string",
                "description": "string",
                "quantity": "integer",
                "value": "string",
                "options": [
                    []
                ],
                "price_inc_vat": "float",
                "price_ex_vat": "float",
                "price_inc_vat_label": "string",
                "price_ex_vat_label": "string"
            }
        ]
    },
    "cart": {
        "currency": "string",
        "min_order_amount": "float",
        "items_count": "integer",
        "items": [
            {
                "variant_id": "integer",
                "type": "string",
                "name": "string",
                "sku": "string",
                "product_id": "integer",
                "product_name": "string",
                "product_description": "string",
                "product_header": "string",
                "product_excerpt": "string",
                "product_url": "string",
                "is_discounted": "boolean",
                "discount_rate": "float",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_base_ex_vat": "float",
                "price_base_inc_vat": "float",
                "price_ecotax": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_base_ex_vat_label": "string",
                "price_base_inc_vat_label": "string",
                "price_ecotax_label": "string",
                "quantity": "integer",
                "quantity_max": "integer",
                "quantity_max_warn": "boolean",
                "price_total_ex_vat": "float",
                "price_total_inc_vat": "float",
                "price_total_ex_vat_label": "string",
                "price_total_inc_vat_label": "string",
                "thumb": {
                    "id": "integer",
                    "title": "string",
                    "description": "string",
                    "url": "string",
                    "url_miniature": "string",
                    "url_vignette": "string",
                    "url_g_miniature": "string",
                    "url_g_vignette": "string"
                }
            }
        ],
        "options": [
            {
                "option_id": "integer",
                "type": "string",
                "name": "string",
                "description": "string",
                "quantity": "integer",
                "value": "string",
                "options": [
                    []
                ],
                "price_inc_vat": "float",
                "price_ex_vat": "float",
                "price_inc_vat_label": "string",
                "price_ex_vat_label": "string"
            }
        ],
        "voucher": {
            "code": "string",
            "value": "float",
            "type": "string",
            "label": "string"
        },
        "is_duty_free": "boolean",
        "price_subtotal_ex_vat": "float",
        "price_subtotal_inc_vat": "float",
        "price_total_ecotax": "float",
        "price_total_ex_vat": "float",
        "price_total_vat": "float",
        "price_total_inc_vat": "float",
        "price_subtotal_ex_vat_label": "string",
        "price_subtotal_inc_vat_label": "string",
        "price_total_ecotax_label": "string",
        "price_total_ex_vat_label": "string",
        "price_total_vat_label": "string",
        "price_total_inc_vat_label": "string",
        "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"
        }
    }
}
NomTypeDescription
summaryobjectRapport de l'action effectuée
statusstringStatus. Les valeurs possibles sont : ok, warn, error
messageFacultatifstringMessage d'erreur
idintegerIdentifiant de la variante
maxFacultatifintegerQuantité maximale autorisée
optionsobjectOptions à la commande
availableobjectOptions disponibles
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
in_cartobjectOptions souscrites
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
cartobjectPanier
currencystringDevise
min_order_amountfloatMontant minimal de commande sur le site
items_countintegerNombre d'articles dans le panier
itemsFacultatifobjectArticles du panier
variant_idintegerIdentifiant de la variante
typestringType d'article. Les valeurs possibles sont : product, voucher
namestringIntitulé de la variante
skustringRéférence de la variante
product_idintegerIdentifiant du produit
product_namestringNom du produit
product_descriptionstringDescription du produit
product_headerstringChapô du produit
product_excerptstringAccroche du produit
product_urlstringURL du produit
is_discountedbooleanProduit remisé
discount_ratefloatRemise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_base_ex_vatfloatPrix unitaire de base non remisé HT
price_base_inc_vatfloatPrix unitaire de base non remisé TTC
price_ecotaxfloatMontant de l'eco taxe
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
price_base_ex_vat_labelFacultatifstringPrix unitaire de base non remisé HT formaté
price_base_inc_vat_labelFacultatifstringPrix unitaire de base non remisé TTC formaté
price_ecotax_labelFacultatifstringMontant de l'eco taxe formaté
quantityintegerQuantité
quantity_maxFacultatifintegerQuantité maximale autorisée dans le panier
quantity_max_warnbooleanErreur de dépassement de quantité maximale
price_total_ex_vatfloatPrix total HT
price_total_inc_vatfloatPrix total TTC
price_total_ex_vat_labelFacultatifstringPrix total HT formaté
price_total_inc_vat_labelFacultatifstringPrix total TTC formaté
thumbFacultatifobjectIllustration de l'article
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
optionsFacultatifobjectOptions du panier
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
voucherFacultatifobjectBon de réduction
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
is_duty_freebooleanExonération de la TVA
price_subtotal_ex_vatfloatSous total HT des produits du panier
price_subtotal_inc_vatfloatSous total TTC des produits du panier
price_total_ecotaxfloatTotal de l'éco taxe
price_total_ex_vatfloatTotal du panier HT
price_total_vatfloatTotal de la TVA
price_total_inc_vatfloatTotal du panier TTC
price_subtotal_ex_vat_labelFacultatifstringSous total HT des produits du panier formaté
price_subtotal_inc_vat_labelFacultatifstringSous total TTC des produits du panier formaté
price_total_ecotax_labelFacultatifstringTotal de l'éco taxe formaté
price_total_ex_vat_labelFacultatifstringTotal du panier HT formaté
price_total_vat_labelFacultatifstringTotal de la TVA formaté
price_total_inc_vat_labelFacultatifstringTotal du panier TTC formaté
shippingFacultatifobjectLivraison
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
Supprime une option DELETE
/api/v1/cart/options/{option_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
option_idObligatoireintegerIdentifiant de l'option à la commande

Format de sortie :

data:{
    "currency": "string",
    "min_order_amount": "float",
    "items_count": "integer",
    "items": [
        {
            "variant_id": "integer",
            "type": "string",
            "name": "string",
            "sku": "string",
            "product_id": "integer",
            "product_name": "string",
            "product_description": "string",
            "product_header": "string",
            "product_excerpt": "string",
            "product_url": "string",
            "is_discounted": "boolean",
            "discount_rate": "float",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_base_ex_vat": "float",
            "price_base_inc_vat": "float",
            "price_ecotax": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "price_base_ex_vat_label": "string",
            "price_base_inc_vat_label": "string",
            "price_ecotax_label": "string",
            "quantity": "integer",
            "quantity_max": "integer",
            "quantity_max_warn": "boolean",
            "price_total_ex_vat": "float",
            "price_total_inc_vat": "float",
            "price_total_ex_vat_label": "string",
            "price_total_inc_vat_label": "string",
            "thumb": {
                "id": "integer",
                "title": "string",
                "description": "string",
                "url": "string",
                "url_miniature": "string",
                "url_vignette": "string",
                "url_g_miniature": "string",
                "url_g_vignette": "string"
            }
        }
    ],
    "options": [
        {
            "option_id": "integer",
            "type": "string",
            "name": "string",
            "description": "string",
            "quantity": "integer",
            "value": "string",
            "options": [
                []
            ],
            "price_inc_vat": "float",
            "price_ex_vat": "float",
            "price_inc_vat_label": "string",
            "price_ex_vat_label": "string"
        }
    ],
    "voucher": {
        "code": "string",
        "value": "float",
        "type": "string",
        "label": "string"
    },
    "is_duty_free": "boolean",
    "price_subtotal_ex_vat": "float",
    "price_subtotal_inc_vat": "float",
    "price_total_ecotax": "float",
    "price_total_ex_vat": "float",
    "price_total_vat": "float",
    "price_total_inc_vat": "float",
    "price_subtotal_ex_vat_label": "string",
    "price_subtotal_inc_vat_label": "string",
    "price_total_ecotax_label": "string",
    "price_total_ex_vat_label": "string",
    "price_total_vat_label": "string",
    "price_total_inc_vat_label": "string",
    "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"
    }
}
NomTypeDescription
currencystringDevise
min_order_amountfloatMontant minimal de commande sur le site
items_countintegerNombre d'articles dans le panier
itemsFacultatifobjectArticles du panier
variant_idintegerIdentifiant de la variante
typestringType d'article. Les valeurs possibles sont : product, voucher
namestringIntitulé de la variante
skustringRéférence de la variante
product_idintegerIdentifiant du produit
product_namestringNom du produit
product_descriptionstringDescription du produit
product_headerstringChapô du produit
product_excerptstringAccroche du produit
product_urlstringURL du produit
is_discountedbooleanProduit remisé
discount_ratefloatRemise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_base_ex_vatfloatPrix unitaire de base non remisé HT
price_base_inc_vatfloatPrix unitaire de base non remisé TTC
price_ecotaxfloatMontant de l'eco taxe
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
price_base_ex_vat_labelFacultatifstringPrix unitaire de base non remisé HT formaté
price_base_inc_vat_labelFacultatifstringPrix unitaire de base non remisé TTC formaté
price_ecotax_labelFacultatifstringMontant de l'eco taxe formaté
quantityintegerQuantité
quantity_maxFacultatifintegerQuantité maximale autorisée dans le panier
quantity_max_warnbooleanErreur de dépassement de quantité maximale
price_total_ex_vatfloatPrix total HT
price_total_inc_vatfloatPrix total TTC
price_total_ex_vat_labelFacultatifstringPrix total HT formaté
price_total_inc_vat_labelFacultatifstringPrix total TTC formaté
thumbFacultatifobjectIllustration de l'article
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
optionsFacultatifobjectOptions du panier
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
voucherFacultatifobjectBon de réduction
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
is_duty_freebooleanExonération de la TVA
price_subtotal_ex_vatfloatSous total HT des produits du panier
price_subtotal_inc_vatfloatSous total TTC des produits du panier
price_total_ecotaxfloatTotal de l'éco taxe
price_total_ex_vatfloatTotal du panier HT
price_total_vatfloatTotal de la TVA
price_total_inc_vatfloatTotal du panier TTC
price_subtotal_ex_vat_labelFacultatifstringSous total HT des produits du panier formaté
price_subtotal_inc_vat_labelFacultatifstringSous total TTC des produits du panier formaté
price_total_ecotax_labelFacultatifstringTotal de l'éco taxe formaté
price_total_ex_vat_labelFacultatifstringTotal du panier HT formaté
price_total_vat_labelFacultatifstringTotal de la TVA formaté
price_total_inc_vat_labelFacultatifstringTotal du panier TTC formaté
shippingFacultatifobjectLivraison
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

Bon de réduction

Retourne le bon du panier GET
/api/v1/cart/voucher.json

Format de sortie :

data:{
    "code": "string",
    "value": "float",
    "type": "string",
    "label": "string"
}
NomTypeDescription
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
Supprime le bon du panier DELETE
/api/v1/cart/voucher.json

Paramètres supportés par ce endpoint :

NomTypeDescription
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site
Ajoute un bon au panier PUT
/api/v1/cart/voucher.json

Paramètres supportés par ce endpoint :

NomTypeDescription
codestringCode du bon de réduction
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:{
    "currency": "string",
    "min_order_amount": "float",
    "items_count": "integer",
    "items": [
        {
            "variant_id": "integer",
            "type": "string",
            "name": "string",
            "sku": "string",
            "product_id": "integer",
            "product_name": "string",
            "product_description": "string",
            "product_header": "string",
            "product_excerpt": "string",
            "product_url": "string",
            "is_discounted": "boolean",
            "discount_rate": "float",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_base_ex_vat": "float",
            "price_base_inc_vat": "float",
            "price_ecotax": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "price_base_ex_vat_label": "string",
            "price_base_inc_vat_label": "string",
            "price_ecotax_label": "string",
            "quantity": "integer",
            "quantity_max": "integer",
            "quantity_max_warn": "boolean",
            "price_total_ex_vat": "float",
            "price_total_inc_vat": "float",
            "price_total_ex_vat_label": "string",
            "price_total_inc_vat_label": "string",
            "thumb": {
                "id": "integer",
                "title": "string",
                "description": "string",
                "url": "string",
                "url_miniature": "string",
                "url_vignette": "string",
                "url_g_miniature": "string",
                "url_g_vignette": "string"
            }
        }
    ],
    "options": [
        {
            "option_id": "integer",
            "type": "string",
            "name": "string",
            "description": "string",
            "quantity": "integer",
            "value": "string",
            "options": [
                []
            ],
            "price_inc_vat": "float",
            "price_ex_vat": "float",
            "price_inc_vat_label": "string",
            "price_ex_vat_label": "string"
        }
    ],
    "voucher": {
        "code": "string",
        "value": "float",
        "type": "string",
        "label": "string"
    },
    "is_duty_free": "boolean",
    "price_subtotal_ex_vat": "float",
    "price_subtotal_inc_vat": "float",
    "price_total_ecotax": "float",
    "price_total_ex_vat": "float",
    "price_total_vat": "float",
    "price_total_inc_vat": "float",
    "price_subtotal_ex_vat_label": "string",
    "price_subtotal_inc_vat_label": "string",
    "price_total_ecotax_label": "string",
    "price_total_ex_vat_label": "string",
    "price_total_vat_label": "string",
    "price_total_inc_vat_label": "string",
    "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"
    }
}
NomTypeDescription
currencystringDevise
min_order_amountfloatMontant minimal de commande sur le site
items_countintegerNombre d'articles dans le panier
itemsFacultatifobjectArticles du panier
variant_idintegerIdentifiant de la variante
typestringType d'article. Les valeurs possibles sont : product, voucher
namestringIntitulé de la variante
skustringRéférence de la variante
product_idintegerIdentifiant du produit
product_namestringNom du produit
product_descriptionstringDescription du produit
product_headerstringChapô du produit
product_excerptstringAccroche du produit
product_urlstringURL du produit
is_discountedbooleanProduit remisé
discount_ratefloatRemise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
price_ex_vatfloatPrix unitaire HT
price_inc_vatfloatPrix unitaire TTC
price_base_ex_vatfloatPrix unitaire de base non remisé HT
price_base_inc_vatfloatPrix unitaire de base non remisé TTC
price_ecotaxfloatMontant de l'eco taxe
price_ex_vat_labelFacultatifstringPrix unitaire HT formaté
price_inc_vat_labelFacultatifstringPrix unitaire TTC formaté
price_base_ex_vat_labelFacultatifstringPrix unitaire de base non remisé HT formaté
price_base_inc_vat_labelFacultatifstringPrix unitaire de base non remisé TTC formaté
price_ecotax_labelFacultatifstringMontant de l'eco taxe formaté
quantityintegerQuantité
quantity_maxFacultatifintegerQuantité maximale autorisée dans le panier
quantity_max_warnbooleanErreur de dépassement de quantité maximale
price_total_ex_vatfloatPrix total HT
price_total_inc_vatfloatPrix total TTC
price_total_ex_vat_labelFacultatifstringPrix total HT formaté
price_total_inc_vat_labelFacultatifstringPrix total TTC formaté
thumbFacultatifobjectIllustration de l'article
idintegerIdentifiant du media
titleFacultatifstringNom
descriptionFacultatifstringDescription
urlstringURL du média
url_miniaturestringURL de la miniature
url_vignettestringURL de la vignette
url_g_miniaturestringURL de la grande miniature
url_g_vignettestringURL de la grande vignette
optionsFacultatifobjectOptions du panier
option_idintegerIdentifiant de l'option
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
namestringNom de l'option
descriptionstringDescription de l'option
quantityFacultatifintegerQuantité, toujours égal à 1
valueFacultatifstringValeur choisie (pour les options de type Liste de valeurs)
optionsFacultatifobjectValeurs possibles (pour les options de type Liste de valeurs)
price_inc_vatfloatPrix TTC
price_ex_vatfloatPrix HT
price_inc_vat_labelFacultatifstringPrix TTC formaté
price_ex_vat_labelFacultatifstringPrix HT formaté
voucherFacultatifobjectBon de réduction
codestringCode du bon
valuefloatValeur du bon
typestringType de bon. Les valeurs possibles sont : percent, amount, shipping
labelstringIntitulé récapitulatif du bon de réduction
is_duty_freebooleanExonération de la TVA
price_subtotal_ex_vatfloatSous total HT des produits du panier
price_subtotal_inc_vatfloatSous total TTC des produits du panier
price_total_ecotaxfloatTotal de l'éco taxe
price_total_ex_vatfloatTotal du panier HT
price_total_vatfloatTotal de la TVA
price_total_inc_vatfloatTotal du panier TTC
price_subtotal_ex_vat_labelFacultatifstringSous total HT des produits du panier formaté
price_subtotal_inc_vat_labelFacultatifstringSous total TTC des produits du panier formaté
price_total_ecotax_labelFacultatifstringTotal de l'éco taxe formaté
price_total_ex_vat_labelFacultatifstringTotal du panier HT formaté
price_total_vat_labelFacultatifstringTotal de la TVA formaté
price_total_inc_vat_labelFacultatifstringTotal du panier TTC formaté
shippingFacultatifobjectLivraison
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

Transporteurs

Modifie les adresses de la commande PUT
/api/v1/cart/addresses.json

Modifie à la fois les adresses de livraison et facturation.

Paramètres supportés par ce endpoint :

NomTypeDescription
billing[firstname]ObligatoirestringPrénom de l'adresse de facturation
billing[lastname]ObligatoirestringNom de l'adresse de facturation
billing[civility]ObligatoirestringCivilité de l'adresse de facturation
Les valeurs attendues sont : m, mme, mlle
billing[address]ObligatoirestringAdresse de facturation
billing[zipcode]ObligatoirestringCode postale de l'adresse de facturation
billing[city]ObligatoirestringVille de l'adresse de facturation
billing[country_id]ObligatoirestringPays de l'adresse de facturation
billing[phone]ObligatoirestringTéléphone de l'adresse de facturation
use_billing_as_shippingbooleanFlag permettant d'indiquer que les données envoyée pour l'adresse de facturation, renseignent également l'adresse de livraion
shipping[firstname]stringPrénom de l'adresse de livraison
shipping[lastname]stringNom de l'adresse de livraison
shipping[civility]stringCivilité de l'adresse de livraison
Les valeurs attendues sont : m, mme, mlle
shipping[address]stringAdresse de livraison
shipping[zipcode]stringCode postale de l'adresse de livraison
shipping[city]stringVille de l'adresse de livraison
shipping[country_id]stringPays de l'adresse de livraison
consentbooleanDonne le consentement au traitement des données
Retourne les adresse de la commande GET
/api/v1/cart/addresses.json

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"
    },
    "use_billing_as_shipping": "boolean",
    "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"
    },
    "is_consent_required": "boolean"
}
NomTypeDescription
billingobjectAdresse 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
use_billing_as_shippingbooleanUtilisation de l'adresse de facturation pour la livraison
shippingobjectAdresse 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
is_consent_requiredbooleanConsentement requis
Liste les transporteurs GET
/api/v1/cart/carriers.json

Retourne la liste des transporteurs possibles pour le panier actuel, suivant les produits et l'adresse de destination.

Format de sortie :

data:[
    {
        "id": "integer",
        "name": "string",
        "shipping_delay": "string",
        "is_free": "boolean",
        "price_ex_vat": "float",
        "price_inc_vat": "float",
        "price_ex_vat_label": "string",
        "price_inc_vat_label": "string",
        "description": "string",
        "is_current": "boolean",
        "type": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "country_id": "integer",
        "country_code": "string",
        "require_scheduling": "string",
        "scheduling_rules": "List"
    }
]
NomTypeDescription
idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
shipping_delayFacultatifstringDélai de livraison
is_freebooleanTransporteur gratuit
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
descriptionstringDescription du transporteur
is_currentbooleanCe transporteur est celui utilisé dans le panier
typestringType de transporteur
companyFacultatifstringNom de la société (en cas de livraison en magasin)
addressFacultatifstringAdresse (en cas de livraison en magasin)
zipcodeFacultatifstringCode postal (en cas de livraison en magasin)
cityFacultatifstringVille (en cas de livraison en magasin)
countryFacultatifstringNom du pays (en cas de livraison en magasin)
country_idFacultatifintegerIdentifiant du pays (en cas de livraison en magasin)
country_codeFacultatifstringCode ISO du pays (en cas de livraison en magasin)
require_schedulingstringPlannification de la date de livraison. Les valeurs possibles sont : no, date, datetime
scheduling_rulesFacultatifListRègles de plannification de la date de livraison
Disponibilité d'un date de livraison GET
/api/v1/cart/carriers/{carrier_id}/schedule.json

Teste la disponibilité d'un date de livraison pour le transporteur indiqué.

Paramètres supportés par ce endpoint :

NomTypeDescription
carrier_idObligatoireintegerIdentifiant unique du transporteur
scheduled_dateObligatoirestringDate de livraison souhaitée
scheduled_hourstringHeure de livraison souhaitée
Change de transporteur PUT
/api/v1/cart/shipping.json

Paramètres supportés par ce endpoint :

NomTypeDescription
carrier_idObligatoireintegerIdentifiant unique du transporteur
scheduled_datestringDate de livraison souhaitée
scheduled_hourstringHeure de livraison souhaitée

Sauvegarde

Sauvegarde le panier GET
/api/v1/cart/backup.json

Retourne un jeton qui identifie le contenu du panier.

Format de sortie :

data:{
    "backup": "string"
}
NomTypeDescription
backupstringJeton
Restaure le panier PUT
/api/v1/cart/backup.json

La restauration du panier utilise un jeton obtenu précédement par la sauvegarde du panier.

Paramètres supportés par ce endpoint :

NomTypeDescription
backupObligatoirestringJeton

Commentaire

Retourne le commentaire GET
/api/v1/cart/comment.json

Format de sortie :

data:{
    "comment": "string"
}
NomTypeDescription
commentstringCommentaire
Ajoute un commentaire PUT
/api/v1/cart/comment.json

Paramètres supportés par ce endpoint :

NomTypeDescription
commentstringCommentaire