Panier

Contenu du panier

Résumé du panier GET

`/api/v1/cart.json`

Paramètres supportés par ce endpoint :

Nom Type Description

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

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"
    }
}

Nom	Type	Description
`currency`	string	Devise
`min_order_amount`	float	Montant minimal de commande sur le site
`items_count`	integer	Nombre d'articles dans le panier
`items`Facultatif	object	Articles du panier
`variant_id`	integer	Identifiant de la variante
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher
`name`	string	Intitulé de la variante
`sku`	string	Référence de la variante
`product_id`	integer	Identifiant du produit
`product_name`	string	Nom du produit
`product_description`	string	Description du produit
`product_header`	string	Chapô du produit
`product_excerpt`	string	Accroche du produit
`product_url`	string	URL du produit
`is_discounted`	boolean	Produit remisé
`discount_rate`	float	Remise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
`price_ex_vat`	float	Prix unitaire HT
`price_inc_vat`	float	Prix unitaire TTC
`price_base_ex_vat`	float	Prix unitaire de base non remisé HT
`price_base_inc_vat`	float	Prix unitaire de base non remisé TTC
`price_ecotax`	float	Montant de l'eco taxe
`price_ex_vat_label`Facultatif	string	Prix unitaire HT formaté
`price_inc_vat_label`Facultatif	string	Prix unitaire TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix unitaire de base non remisé HT formaté
`price_base_inc_vat_label`Facultatif	string	Prix unitaire de base non remisé TTC formaté
`price_ecotax_label`Facultatif	string	Montant de l'eco taxe formaté
`quantity`	integer	Quantité
`quantity_max`Facultatif	integer	Quantité maximale autorisée dans le panier
`quantity_max_warn`	boolean	Erreur de dépassement de quantité maximale
`price_total_ex_vat`	float	Prix total HT
`price_total_inc_vat`	float	Prix total TTC
`price_total_ex_vat_label`Facultatif	string	Prix total HT formaté
`price_total_inc_vat_label`Facultatif	string	Prix total TTC formaté
`thumb`Facultatif	object	Illustration de l'article
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`options`Facultatif	object	Options du panier
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`voucher`Facultatif	object	Bon de réduction
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé récapitulatif du bon de réduction
`is_duty_free`	boolean	Exonération de la TVA
`price_subtotal_ex_vat`	float	Sous total HT des produits du panier
`price_subtotal_inc_vat`	float	Sous total TTC des produits du panier
`price_total_ecotax`	float	Total de l'éco taxe
`price_total_ex_vat`	float	Total du panier HT
`price_total_vat`	float	Total de la TVA
`price_total_inc_vat`	float	Total du panier TTC
`price_subtotal_ex_vat_label`Facultatif	string	Sous total HT des produits du panier formaté
`price_subtotal_inc_vat_label`Facultatif	string	Sous total TTC des produits du panier formaté
`price_total_ecotax_label`Facultatif	string	Total de l'éco taxe formaté
`price_total_ex_vat_label`Facultatif	string	Total du panier HT formaté
`price_total_vat_label`Facultatif	string	Total de la TVA formaté
`price_total_inc_vat_label`Facultatif	string	Total du panier TTC formaté
`shipping`Facultatif	object	Livraison
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Nom du transporteur
`description`Facultatif	string	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	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_number`Facultatif	string	URL de suivi du colis
`require_scheduling`Facultatif	string	Plannification recquise. Les valeurs possibles sont : no, date, datetime
`scheduled_date`Facultatif	string	Date de livraison
`scheduled_hour`Facultatif	string	Heure 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 :

Nom Type Description

mode string Mode 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

items array tableau associatif, variante => quantité souhaitée. La quantité peut être éxprimée de façon absolue ou relative au format X, +X ou -X

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

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"
        }
    }
}

Nom	Type	Description
`summary`	object	Rapport de l'action effectuée
`status`	string	Status. Les valeurs possibles sont : ok, warn, error
`message`Facultatif	string	Message d'erreur
`id`	integer	Identifiant de la variante
`max`Facultatif	integer	Quantité maximale autorisée
`cart`	object	Panier mis à jour
`currency`	string	Devise
`min_order_amount`	float	Montant minimal de commande sur le site
`items_count`	integer	Nombre d'articles dans le panier
`items`Facultatif	object	Articles du panier
`variant_id`	integer	Identifiant de la variante
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher
`name`	string	Intitulé de la variante
`sku`	string	Référence de la variante
`product_id`	integer	Identifiant du produit
`product_name`	string	Nom du produit
`product_description`	string	Description du produit
`product_header`	string	Chapô du produit
`product_excerpt`	string	Accroche du produit
`product_url`	string	URL du produit
`is_discounted`	boolean	Produit remisé
`discount_rate`	float	Remise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
`price_ex_vat`	float	Prix unitaire HT
`price_inc_vat`	float	Prix unitaire TTC
`price_base_ex_vat`	float	Prix unitaire de base non remisé HT
`price_base_inc_vat`	float	Prix unitaire de base non remisé TTC
`price_ecotax`	float	Montant de l'eco taxe
`price_ex_vat_label`Facultatif	string	Prix unitaire HT formaté
`price_inc_vat_label`Facultatif	string	Prix unitaire TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix unitaire de base non remisé HT formaté
`price_base_inc_vat_label`Facultatif	string	Prix unitaire de base non remisé TTC formaté
`price_ecotax_label`Facultatif	string	Montant de l'eco taxe formaté
`quantity`	integer	Quantité
`quantity_max`Facultatif	integer	Quantité maximale autorisée dans le panier
`quantity_max_warn`	boolean	Erreur de dépassement de quantité maximale
`price_total_ex_vat`	float	Prix total HT
`price_total_inc_vat`	float	Prix total TTC
`price_total_ex_vat_label`Facultatif	string	Prix total HT formaté
`price_total_inc_vat_label`Facultatif	string	Prix total TTC formaté
`thumb`Facultatif	object	Illustration de l'article
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`options`Facultatif	object	Options du panier
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`voucher`Facultatif	object	Bon de réduction
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé récapitulatif du bon de réduction
`is_duty_free`	boolean	Exonération de la TVA
`price_subtotal_ex_vat`	float	Sous total HT des produits du panier
`price_subtotal_inc_vat`	float	Sous total TTC des produits du panier
`price_total_ecotax`	float	Total de l'éco taxe
`price_total_ex_vat`	float	Total du panier HT
`price_total_vat`	float	Total de la TVA
`price_total_inc_vat`	float	Total du panier TTC
`price_subtotal_ex_vat_label`Facultatif	string	Sous total HT des produits du panier formaté
`price_subtotal_inc_vat_label`Facultatif	string	Sous total TTC des produits du panier formaté
`price_total_ecotax_label`Facultatif	string	Total de l'éco taxe formaté
`price_total_ex_vat_label`Facultatif	string	Total du panier HT formaté
`price_total_vat_label`Facultatif	string	Total de la TVA formaté
`price_total_inc_vat_label`Facultatif	string	Total du panier TTC formaté
`shipping`Facultatif	object	Livraison
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Nom du transporteur
`description`Facultatif	string	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	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_number`Facultatif	string	URL de suivi du colis
`require_scheduling`Facultatif	string	Plannification recquise. Les valeurs possibles sont : no, date, datetime
`scheduled_date`Facultatif	string	Date de livraison
`scheduled_hour`Facultatif	string	Heure 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 :

Nom Type Description

variant_id Obligatoire integer Identifiant numérique de la variante

quantity string Quantité absolue ou relative au format X, +X ou -X (+1 par défaut)

mode string Mode 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_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

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"
        }
    }
}

Nom	Type	Description
`summary`	object	Rapport de l'action effectuée
`status`	string	Status. Les valeurs possibles sont : ok, warn, error
`message`Facultatif	string	Message d'erreur
`id`	integer	Identifiant de la variante
`max`Facultatif	integer	Quantité maximale autorisée
`cart`	object	Panier mis à jour
`currency`	string	Devise
`min_order_amount`	float	Montant minimal de commande sur le site
`items_count`	integer	Nombre d'articles dans le panier
`items`Facultatif	object	Articles du panier
`variant_id`	integer	Identifiant de la variante
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher
`name`	string	Intitulé de la variante
`sku`	string	Référence de la variante
`product_id`	integer	Identifiant du produit
`product_name`	string	Nom du produit
`product_description`	string	Description du produit
`product_header`	string	Chapô du produit
`product_excerpt`	string	Accroche du produit
`product_url`	string	URL du produit
`is_discounted`	boolean	Produit remisé
`discount_rate`	float	Remise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
`price_ex_vat`	float	Prix unitaire HT
`price_inc_vat`	float	Prix unitaire TTC
`price_base_ex_vat`	float	Prix unitaire de base non remisé HT
`price_base_inc_vat`	float	Prix unitaire de base non remisé TTC
`price_ecotax`	float	Montant de l'eco taxe
`price_ex_vat_label`Facultatif	string	Prix unitaire HT formaté
`price_inc_vat_label`Facultatif	string	Prix unitaire TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix unitaire de base non remisé HT formaté
`price_base_inc_vat_label`Facultatif	string	Prix unitaire de base non remisé TTC formaté
`price_ecotax_label`Facultatif	string	Montant de l'eco taxe formaté
`quantity`	integer	Quantité
`quantity_max`Facultatif	integer	Quantité maximale autorisée dans le panier
`quantity_max_warn`	boolean	Erreur de dépassement de quantité maximale
`price_total_ex_vat`	float	Prix total HT
`price_total_inc_vat`	float	Prix total TTC
`price_total_ex_vat_label`Facultatif	string	Prix total HT formaté
`price_total_inc_vat_label`Facultatif	string	Prix total TTC formaté
`thumb`Facultatif	object	Illustration de l'article
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`options`Facultatif	object	Options du panier
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`voucher`Facultatif	object	Bon de réduction
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé récapitulatif du bon de réduction
`is_duty_free`	boolean	Exonération de la TVA
`price_subtotal_ex_vat`	float	Sous total HT des produits du panier
`price_subtotal_inc_vat`	float	Sous total TTC des produits du panier
`price_total_ecotax`	float	Total de l'éco taxe
`price_total_ex_vat`	float	Total du panier HT
`price_total_vat`	float	Total de la TVA
`price_total_inc_vat`	float	Total du panier TTC
`price_subtotal_ex_vat_label`Facultatif	string	Sous total HT des produits du panier formaté
`price_subtotal_inc_vat_label`Facultatif	string	Sous total TTC des produits du panier formaté
`price_total_ecotax_label`Facultatif	string	Total de l'éco taxe formaté
`price_total_ex_vat_label`Facultatif	string	Total du panier HT formaté
`price_total_vat_label`Facultatif	string	Total de la TVA formaté
`price_total_inc_vat_label`Facultatif	string	Total du panier TTC formaté
`shipping`Facultatif	object	Livraison
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Nom du transporteur
`description`Facultatif	string	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	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_number`Facultatif	string	URL de suivi du colis
`require_scheduling`Facultatif	string	Plannification recquise. Les valeurs possibles sont : no, date, datetime
`scheduled_date`Facultatif	string	Date de livraison
`scheduled_hour`Facultatif	string	Heure de livraison

Supprime un produit du panier DELETE

`/api/v1/cart/items/{variant_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`variant_id`	Obligatoire	integer	Identifiant 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 :

Nom Type Description

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

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"
        }
    ]
}

Nom	Type	Description
`available`	object	Options disponibles
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`in_cart`	object	Options souscrites
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté

Ajoute une option PUT

`/api/v1/cart/options/{option_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

option_id Obligatoire integer Identifiant de l'option à la commande

value string Valeur de l'option à la commande pour les options de type zone de texte ou liste déroulante

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

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"
        }
    }
}

Nom	Type	Description
`summary`	object	Rapport de l'action effectuée
`status`	string	Status. Les valeurs possibles sont : ok, warn, error
`message`Facultatif	string	Message d'erreur
`id`	integer	Identifiant de la variante
`max`Facultatif	integer	Quantité maximale autorisée
`options`	object	Options à la commande
`available`	object	Options disponibles
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`in_cart`	object	Options souscrites
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`cart`	object	Panier
`currency`	string	Devise
`min_order_amount`	float	Montant minimal de commande sur le site
`items_count`	integer	Nombre d'articles dans le panier
`items`Facultatif	object	Articles du panier
`variant_id`	integer	Identifiant de la variante
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher
`name`	string	Intitulé de la variante
`sku`	string	Référence de la variante
`product_id`	integer	Identifiant du produit
`product_name`	string	Nom du produit
`product_description`	string	Description du produit
`product_header`	string	Chapô du produit
`product_excerpt`	string	Accroche du produit
`product_url`	string	URL du produit
`is_discounted`	boolean	Produit remisé
`discount_rate`	float	Remise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
`price_ex_vat`	float	Prix unitaire HT
`price_inc_vat`	float	Prix unitaire TTC
`price_base_ex_vat`	float	Prix unitaire de base non remisé HT
`price_base_inc_vat`	float	Prix unitaire de base non remisé TTC
`price_ecotax`	float	Montant de l'eco taxe
`price_ex_vat_label`Facultatif	string	Prix unitaire HT formaté
`price_inc_vat_label`Facultatif	string	Prix unitaire TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix unitaire de base non remisé HT formaté
`price_base_inc_vat_label`Facultatif	string	Prix unitaire de base non remisé TTC formaté
`price_ecotax_label`Facultatif	string	Montant de l'eco taxe formaté
`quantity`	integer	Quantité
`quantity_max`Facultatif	integer	Quantité maximale autorisée dans le panier
`quantity_max_warn`	boolean	Erreur de dépassement de quantité maximale
`price_total_ex_vat`	float	Prix total HT
`price_total_inc_vat`	float	Prix total TTC
`price_total_ex_vat_label`Facultatif	string	Prix total HT formaté
`price_total_inc_vat_label`Facultatif	string	Prix total TTC formaté
`thumb`Facultatif	object	Illustration de l'article
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`options`Facultatif	object	Options du panier
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`voucher`Facultatif	object	Bon de réduction
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé récapitulatif du bon de réduction
`is_duty_free`	boolean	Exonération de la TVA
`price_subtotal_ex_vat`	float	Sous total HT des produits du panier
`price_subtotal_inc_vat`	float	Sous total TTC des produits du panier
`price_total_ecotax`	float	Total de l'éco taxe
`price_total_ex_vat`	float	Total du panier HT
`price_total_vat`	float	Total de la TVA
`price_total_inc_vat`	float	Total du panier TTC
`price_subtotal_ex_vat_label`Facultatif	string	Sous total HT des produits du panier formaté
`price_subtotal_inc_vat_label`Facultatif	string	Sous total TTC des produits du panier formaté
`price_total_ecotax_label`Facultatif	string	Total de l'éco taxe formaté
`price_total_ex_vat_label`Facultatif	string	Total du panier HT formaté
`price_total_vat_label`Facultatif	string	Total de la TVA formaté
`price_total_inc_vat_label`Facultatif	string	Total du panier TTC formaté
`shipping`Facultatif	object	Livraison
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Nom du transporteur
`description`Facultatif	string	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	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_number`Facultatif	string	URL de suivi du colis
`require_scheduling`Facultatif	string	Plannification recquise. Les valeurs possibles sont : no, date, datetime
`scheduled_date`Facultatif	string	Date de livraison
`scheduled_hour`Facultatif	string	Heure de livraison

Supprime une option DELETE

`/api/v1/cart/options/{option_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`option_id`	Obligatoire	integer	Identifiant de l'option à la commande

Format de sortie :

Schéma JSON
Modèle

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"
    }
}

Nom	Type	Description
`currency`	string	Devise
`min_order_amount`	float	Montant minimal de commande sur le site
`items_count`	integer	Nombre d'articles dans le panier
`items`Facultatif	object	Articles du panier
`variant_id`	integer	Identifiant de la variante
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher
`name`	string	Intitulé de la variante
`sku`	string	Référence de la variante
`product_id`	integer	Identifiant du produit
`product_name`	string	Nom du produit
`product_description`	string	Description du produit
`product_header`	string	Chapô du produit
`product_excerpt`	string	Accroche du produit
`product_url`	string	URL du produit
`is_discounted`	boolean	Produit remisé
`discount_rate`	float	Remise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
`price_ex_vat`	float	Prix unitaire HT
`price_inc_vat`	float	Prix unitaire TTC
`price_base_ex_vat`	float	Prix unitaire de base non remisé HT
`price_base_inc_vat`	float	Prix unitaire de base non remisé TTC
`price_ecotax`	float	Montant de l'eco taxe
`price_ex_vat_label`Facultatif	string	Prix unitaire HT formaté
`price_inc_vat_label`Facultatif	string	Prix unitaire TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix unitaire de base non remisé HT formaté
`price_base_inc_vat_label`Facultatif	string	Prix unitaire de base non remisé TTC formaté
`price_ecotax_label`Facultatif	string	Montant de l'eco taxe formaté
`quantity`	integer	Quantité
`quantity_max`Facultatif	integer	Quantité maximale autorisée dans le panier
`quantity_max_warn`	boolean	Erreur de dépassement de quantité maximale
`price_total_ex_vat`	float	Prix total HT
`price_total_inc_vat`	float	Prix total TTC
`price_total_ex_vat_label`Facultatif	string	Prix total HT formaté
`price_total_inc_vat_label`Facultatif	string	Prix total TTC formaté
`thumb`Facultatif	object	Illustration de l'article
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`options`Facultatif	object	Options du panier
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`voucher`Facultatif	object	Bon de réduction
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé récapitulatif du bon de réduction
`is_duty_free`	boolean	Exonération de la TVA
`price_subtotal_ex_vat`	float	Sous total HT des produits du panier
`price_subtotal_inc_vat`	float	Sous total TTC des produits du panier
`price_total_ecotax`	float	Total de l'éco taxe
`price_total_ex_vat`	float	Total du panier HT
`price_total_vat`	float	Total de la TVA
`price_total_inc_vat`	float	Total du panier TTC
`price_subtotal_ex_vat_label`Facultatif	string	Sous total HT des produits du panier formaté
`price_subtotal_inc_vat_label`Facultatif	string	Sous total TTC des produits du panier formaté
`price_total_ecotax_label`Facultatif	string	Total de l'éco taxe formaté
`price_total_ex_vat_label`Facultatif	string	Total du panier HT formaté
`price_total_vat_label`Facultatif	string	Total de la TVA formaté
`price_total_inc_vat_label`Facultatif	string	Total du panier TTC formaté
`shipping`Facultatif	object	Livraison
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Nom du transporteur
`description`Facultatif	string	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	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_number`Facultatif	string	URL de suivi du colis
`require_scheduling`Facultatif	string	Plannification recquise. Les valeurs possibles sont : no, date, datetime
`scheduled_date`Facultatif	string	Date de livraison
`scheduled_hour`Facultatif	string	Heure de livraison

Bon de réduction

Retourne le bon du panier GET

`/api/v1/cart/voucher.json`

Format de sortie :

Schéma JSON
Modèle

data:{
    "code": "string",
    "value": "float",
    "type": "string",
    "label": "string"
}

Nom	Type	Description
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé 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 :

Nom Type Description

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label 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 :

Nom Type Description

code string Code du bon de réduction

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

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"
    }
}

Nom	Type	Description
`currency`	string	Devise
`min_order_amount`	float	Montant minimal de commande sur le site
`items_count`	integer	Nombre d'articles dans le panier
`items`Facultatif	object	Articles du panier
`variant_id`	integer	Identifiant de la variante
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher
`name`	string	Intitulé de la variante
`sku`	string	Référence de la variante
`product_id`	integer	Identifiant du produit
`product_name`	string	Nom du produit
`product_description`	string	Description du produit
`product_header`	string	Chapô du produit
`product_excerpt`	string	Accroche du produit
`product_url`	string	URL du produit
`is_discounted`	boolean	Produit remisé
`discount_rate`	float	Remise sous forme d'un multiplicateur (ex = 0.9 signifie 10% de remise)
`price_ex_vat`	float	Prix unitaire HT
`price_inc_vat`	float	Prix unitaire TTC
`price_base_ex_vat`	float	Prix unitaire de base non remisé HT
`price_base_inc_vat`	float	Prix unitaire de base non remisé TTC
`price_ecotax`	float	Montant de l'eco taxe
`price_ex_vat_label`Facultatif	string	Prix unitaire HT formaté
`price_inc_vat_label`Facultatif	string	Prix unitaire TTC formaté
`price_base_ex_vat_label`Facultatif	string	Prix unitaire de base non remisé HT formaté
`price_base_inc_vat_label`Facultatif	string	Prix unitaire de base non remisé TTC formaté
`price_ecotax_label`Facultatif	string	Montant de l'eco taxe formaté
`quantity`	integer	Quantité
`quantity_max`Facultatif	integer	Quantité maximale autorisée dans le panier
`quantity_max_warn`	boolean	Erreur de dépassement de quantité maximale
`price_total_ex_vat`	float	Prix total HT
`price_total_inc_vat`	float	Prix total TTC
`price_total_ex_vat_label`Facultatif	string	Prix total HT formaté
`price_total_inc_vat_label`Facultatif	string	Prix total TTC formaté
`thumb`Facultatif	object	Illustration de l'article
`id`	integer	Identifiant du media
`title`Facultatif	string	Nom
`description`Facultatif	string	Description
`url`	string	URL du média
`url_miniature`	string	URL de la miniature
`url_vignette`	string	URL de la vignette
`url_g_miniature`	string	URL de la grande miniature
`url_g_vignette`	string	URL de la grande vignette
`options`Facultatif	object	Options du panier
`option_id`	integer	Identifiant de l'option
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`name`	string	Nom de l'option
`description`	string	Description de l'option
`quantity`Facultatif	integer	Quantité, toujours égal à 1
`value`Facultatif	string	Valeur choisie (pour les options de type Liste de valeurs)
`options`Facultatif	object	Valeurs possibles (pour les options de type Liste de valeurs)
`price_inc_vat`	float	Prix TTC
`price_ex_vat`	float	Prix HT
`price_inc_vat_label`Facultatif	string	Prix TTC formaté
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`voucher`Facultatif	object	Bon de réduction
`code`	string	Code du bon
`value`	float	Valeur du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, amount, shipping
`label`	string	Intitulé récapitulatif du bon de réduction
`is_duty_free`	boolean	Exonération de la TVA
`price_subtotal_ex_vat`	float	Sous total HT des produits du panier
`price_subtotal_inc_vat`	float	Sous total TTC des produits du panier
`price_total_ecotax`	float	Total de l'éco taxe
`price_total_ex_vat`	float	Total du panier HT
`price_total_vat`	float	Total de la TVA
`price_total_inc_vat`	float	Total du panier TTC
`price_subtotal_ex_vat_label`Facultatif	string	Sous total HT des produits du panier formaté
`price_subtotal_inc_vat_label`Facultatif	string	Sous total TTC des produits du panier formaté
`price_total_ecotax_label`Facultatif	string	Total de l'éco taxe formaté
`price_total_ex_vat_label`Facultatif	string	Total du panier HT formaté
`price_total_vat_label`Facultatif	string	Total de la TVA formaté
`price_total_inc_vat_label`Facultatif	string	Total du panier TTC formaté
`shipping`Facultatif	object	Livraison
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Nom du transporteur
`description`Facultatif	string	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	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_number`Facultatif	string	URL de suivi du colis
`require_scheduling`Facultatif	string	Plannification recquise. Les valeurs possibles sont : no, date, datetime
`scheduled_date`Facultatif	string	Date de livraison
`scheduled_hour`Facultatif	string	Heure 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 :

Nom		Type	Description
`billing[firstname]`	Obligatoire	string	Prénom de l'adresse de facturation
`billing[lastname]`	Obligatoire	string	Nom de l'adresse de facturation
`billing[civility]`	Obligatoire	string	Civilité de l'adresse de facturation Les valeurs attendues sont : m, mme, mlle
`billing[address]`	Obligatoire	string	Adresse de facturation
`billing[zipcode]`	Obligatoire	string	Code postale de l'adresse de facturation
`billing[city]`	Obligatoire	string	Ville de l'adresse de facturation
`billing[country_id]`	Obligatoire	string	Pays de l'adresse de facturation
`billing[phone]`	Obligatoire	string	Téléphone de l'adresse de facturation
`use_billing_as_shipping`		boolean	Flag permettant d'indiquer que les données envoyée pour l'adresse de facturation, renseignent également l'adresse de livraion
`shipping[firstname]`		string	Prénom de l'adresse de livraison
`shipping[lastname]`		string	Nom de l'adresse de livraison
`shipping[civility]`		string	Civilité de l'adresse de livraison Les valeurs attendues sont : m, mme, mlle
`shipping[address]`		string	Adresse de livraison
`shipping[zipcode]`		string	Code postale de l'adresse de livraison
`shipping[city]`		string	Ville de l'adresse de livraison
`shipping[country_id]`		string	Pays de l'adresse de livraison
`shipping[phone]`		string	Téléphone de l'adresse de livraison
`consent`		boolean	Donne le consentement au traitement des données

Retourne les adresse de la commande GET

`/api/v1/cart/addresses.json`

Format de sortie :

Schéma JSON
Modèle

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"
}

Nom	Type	Description
`billing`	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
`use_billing_as_shipping`	boolean	Utilisation de l'adresse de facturation pour la livraison
`shipping`	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
`is_consent_required`	boolean	Consentement 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. Il est également possible de forcer arbitrairement un pays.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`country_id`		integer	Pays
`zipcode`		string	Code postal (pour la france)

Format de sortie :

Schéma JSON
Modèle

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"
    }
]

Nom	Type	Description
`id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`shipping_delay`Facultatif	string	Délai de livraison
`is_free`	boolean	Transporteur gratuit
`price_ex_vat`	float	Prix hors TVA
`price_inc_vat`	float	Prix avec TVA
`price_ex_vat_label`Facultatif	string	Prix hors TVA avec devise
`price_inc_vat_label`Facultatif	string	Prix avec TVA avec devise
`description`	string	Description du transporteur
`is_current`	boolean	Ce transporteur est celui utilisé dans le panier
`type`	string	Type de transporteur
`company`Facultatif	string	Nom de la société (en cas de livraison en magasin)
`address`Facultatif	string	Adresse (en cas de livraison en magasin)
`zipcode`Facultatif	string	Code postal (en cas de livraison en magasin)
`city`Facultatif	string	Ville (en cas de livraison en magasin)
`country`Facultatif	string	Nom du pays (en cas de livraison en magasin)
`country_id`Facultatif	integer	Identifiant du pays (en cas de livraison en magasin)
`country_code`Facultatif	string	Code ISO du pays (en cas de livraison en magasin)
`require_scheduling`	string	Plannification de la date de livraison. Les valeurs possibles sont : no, date, datetime
`scheduling_rules`Facultatif	List	Règles de plannification de la date de livraison

Estimation des frais de port GET

`/api/v1/cart/carriers/{carrier_id}/estimation.json`

Retourne une estimation des frais de port par le transporteur désigné. Si le pays n'est pas indiqué, c'est celui de l'adresse de livraison qui est utilisé.

Paramètres supportés par ce endpoint :

Nom Type Description

carrier_id Obligatoire integer Identifiant unique du transporteur

country_id integer Pays

extra_fields

array

Inclut des données supplémentaires à la réponse, parmis les suivantes :

price_label

Label des prix dans la devise du site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "price_ex_vat": "float",
        "price_inc_vat": "float",
        "price_ex_vat_label": "string",
        "price_inc_vat_label": "string"
    }
]

Nom	Type	Description
`price_ex_vat`	float	Prix HT
`price_inc_vat`	float	Prix TTC
`price_ex_vat_label`Facultatif	string	Prix HT formaté
`price_inc_vat_label`Facultatif	string	Prix TTC formaté

Cherche des points relais GET

`/api/v1/cart/carriers/{carrier_id}/pickup.json`

Recherche les points relais les plus proches de l'adresse indiquée.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`carrier_id`	Obligatoire	integer	Identifiant unique du transporteur
`address`		string	Adresse
`city`		string	Ville
`zipcode`		string	Code postal
`country_id`		integer	Identifiant du pays

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "relay_id": "string",
        "name": "string",
        "address": "string",
        "address2": "string",
        "address3": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "hint": "string",
        "distance": "float",
        "coord": {
            "lat": "float",
            "lon": "float"
        },
        "opening_hours": "List",
        "closing_period": "List"
    }
]

Nom	Type	Description
`relay_id`	string	Identifiant du relais
`name`	string	Nom du relais
`address`	string	Adresse
`address2`Facultatif	string	Complément d'adresse
`address3`Facultatif	string	Complément d'adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Code du pays
`hint`Facultatif	string	Aide
`distance`	float	Distance en km
`coord`	object	Géolocalisation
`lat`	float	Latitude
`lon`	float	Longitude
`opening_hours`	List	Horaires d'ouverture
`closing_period`Facultatif	List	Périodes de fermeture

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 :

Nom		Type	Description
`carrier_id`	Obligatoire	integer	Identifiant unique du transporteur
`scheduled_date`	Obligatoire	string	Date de livraison souhaitée
`scheduled_hour`		string	Heure de livraison souhaitée

Change de transporteur PUT

`/api/v1/cart/shipping.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`carrier_id`	Obligatoire	integer	Identifiant unique du transporteur
`scheduled_date`		string	Date de livraison souhaitée
`scheduled_hour`		string	Heure 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 :

Schéma JSON
Modèle

data:{
    "backup": "string"
}

Nom	Type	Description
`backup`	string	Jeton

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 :

Nom		Type	Description
`backup`	Obligatoire	string	Jeton

Commentaire

Retourne le commentaire GET

`/api/v1/cart/comment.json`

Format de sortie :

Schéma JSON
Modèle

data:{
    "comment": "string"
}

Nom	Type	Description
`comment`	string	Commentaire

Ajoute un commentaire PUT

`/api/v1/cart/comment.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`comment`		string	Commentaire