Commandes

Résumé

Résumé des commandes GET

`/v1/sites/{code_site}/checkout.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:{
    "pending_count": "integer",
    "processing_count": "integer",
    "processed_count": "integer",
    "shipped_count": "integer",
    "cancelled_count": "integer"
}

Nom	Type	Description
`pending_count`	integer	Nombre de commandes à traiter
`processing_count`	integer	Nombre de commandes en cours
`processed_count`	integer	Nombre de commandes traités
`shipped_count`	integer	Nombre de commandes expédiées
`cancelled_count`	integer	Nombre de commandes annulées

Commandes

Création d'une commande POST

`/v1/sites/{code_site}/checkout/orders.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

customer_id Obligatoire integer Identifiant du client

products

Obligatoire

array

Liste des produits de la commande avec les champs suivants :

Pour un produit Kiubi:

variant_id	Identifiant de la variante
quantity	Quantité

Pour un produit personnalisé :

id	Identifiant personnalisé du produit
quantity	Quantité
product_name	Intitulé du produit
variant_name	Intitulé de la variante
price_ex_vat	Prix unitaire HT (Un prix est obligatoire, HT ou TTC)
price_inc_vat	Prix unitaire TTC (Un prix est obligatoire, HT ou TTC)
price_discount_ex_vat	Prix promo unitaire HT
price_discount_inc_vat	Prix promo unitaire TTC
price_ecotax	Montant de l'écotaxe
vat_rate	Taux de TVA
reference	Référence
weight	Poids en gramme
is_virtual	Produit virtuel
file_id	Identifiant du fichier à télécharger

options array Liste des options à la commande

billing_address

Obligatoire

array

Adresse de facturation avec les champs suivants :

civility	Civilité
lastname	Nom
firstname	Prénom
company	Société
address	Adresse
zipcode	Code postal
city	Ville
country_id	Identifiant du pays
phone	Téléphone

shipping_address

array

Adresse de livraison avec les champs suivants :

civility	Civilité
lastname	Nom
firstname	Prénom
company	Société
address	Adresse
zipcode	Code postal
city	Ville
country_id	Identifiant du pays
phone	Téléphone

payment_id integer Identifiant du mode de paiement

payment_name string Intitulé du mode de paiement

carrier_id integer Identifiant du transporteur

carrier_price_inc_vat float Montant TTC des frais de port (Un montant est obligatoire, HT ou TTC)

carrier_price_ex_vat float Montant HT des frais de port (Un montant est obligatoire, HT ou TTC)

carrier_vat_rate Obligatoire float Taux de TVA des frais de port

carrier_name string Intitulé du transporteur

scheduled_date string Date de livraison souhaitée

scheduled_hour string Heure de livraison souhaitée

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Liste les commandes GET

`/v1/sites/{code_site}/checkout/orders.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

status

string

Statut des commandes parmis les valeurs suivantes :

pending	À traiter
processing	En cours
processed	Traitées
shipped	Expédiées
cancelled	Annulées

Les valeurs attendues sont : pending, processing, processed, shipped, cancelled

customer_id integer Identifiant du client

term string Terme recherché

is_paid boolean Commande payée

reference string Référence de la commande

creation_date_min string Date de création minimale

creation_date_max string Date de création maximale

payment_date_min string Date de paiement minimale

payment_date_max string Date de paiement maximale

price_total_inc_vat_min float Prix total TTC minimal

price_total_inc_vat_max float Prix total TTC maximal

price_total_ex_vat_min float Prix total HT minimal

price_total_ex_vat_max float Prix total HT maximal

payment_id integer Identifiant du mode de paiement

carrier_id integer Identifiant du transporteur

fidelity_reward_min integer Points de fidélité minimal

fidelity_reward_max integer Points de fidélité maximal

country_id integer Pays de facturation

department string Numéro de département de facturation (pour la france)

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

sort

array

Ordres de tri parmis les critères suivants :

date / -date	Tri selon la date de la commande
modification / -modification	Tri selon la date de dernière modification de la commande
amount / -amount	Tri selon la montant de la commande
schedule / -schedule	Tri selon la date de retrait/livraison prévue

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:[
    {
        "order_id": "integer",
        "reference": "string",
        "customer_id": "integer",
        "customer_email": "string",
        "customer_number": "string",
        "ip_address": "string",
        "reverse_host": "string",
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "status": "string",
        "is_paid": "boolean",
        "payment_id": "integer",
        "payment_name": "string",
        "is_reintegrated": "boolean",
        "payment_date": "string",
        "payment_date_f": "string",
        "payment_date_timestamp": "integer",
        "price_total_inc_vat": "float",
        "price_total_ex_vat": "float",
        "price_total_inc_vat_label": "string",
        "price_total_ex_vat_label": "string",
        "price_vat": "float",
        "price_items_inc_vat": "float",
        "price_items_ex_vat": "float",
        "base_price": "string",
        "currency": "string",
        "is_tax_free": "boolean",
        "comment": "string",
        "shipping": {
            "carrier_id": "integer",
            "name": "string",
            "type": "string",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "vat_rate": "float",
            "weight": "integer",
            "is_free": "boolean",
            "destination": "string",
            "picking_number": "string",
            "scheduled": "string"
        },
        "billing_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "country_id": "integer",
            "phone": "string",
            "is_editable": "boolean"
        },
        "shipping_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "country_id": "integer",
            "phone": "string",
            "is_editable": "boolean"
        },
        "voucher": {
            "code": "string",
            "type": "string",
            "amount": "float"
        },
        "items": [
            {
                "type": "string",
                "product_id": "integer",
                "variant_id": "integer",
                "reference": "string",
                "product_name": "string",
                "variant_name": "string",
                "quantity": "integer",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_total_ex_vat": "float",
                "price_total_inc_vat": "float",
                "is_discounted": "boolean",
                "discount": "float",
                "vat_rate": "float",
                "price_ecotax": "float",
                "price_ecotax_label": "string",
                "is_virtual": "boolean",
                "file_id": "integer"
            }
        ],
        "options": [
            {
                "option_id": "integer",
                "name": "string",
                "quantity": "integer",
                "value": "string",
                "vat_rate": "float",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string"
            }
        ],
        "activity": [
            {
                "message": "string",
                "date": "string",
                "user": "string"
            }
        ],
        "fidelity_reward": "integer",
        "download": {
            "form": "string",
            "xls": "string",
            "coliship": "string"
        },
        "xtra": "List"
    }
]

Nom	Type	Description
`order_id`	integer	Identifiant de la commande
`reference`	string	Référence de la commande
`customer_id`	integer	Identifiant du client
`customer_email`	string	Email du client
`customer_number`	string	Numéro du client
`ip_address`	string	Adresse IP du client
`reverse_host`	string	Reverse host de l'adresse IP
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`status`	string	Statut de la commande
`is_paid`	boolean	Commande payée
`payment_id`	integer	Identifiant du mode de paiement
`payment_name`	string	Intitulé du mode de paiement
`is_reintegrated`	boolean	Commande réintégrée
`payment_date`Facultatif	string	Date de paiement
`payment_date_f`Facultatif	string	Date de paiement formatée
`payment_date_timestamp`Facultatif	integer	Timestamp de la date de paiement
`price_total_inc_vat`	float	Prix total avec TVA
`price_total_ex_vat`	float	Prix total hors TVA
`price_total_inc_vat_label`Facultatif	string	Prix total avec TVA avec devise
`price_total_ex_vat_label`Facultatif	string	Prix total hors TVA avec devise
`price_vat`Facultatif	float	Montant total de tva
`price_items_inc_vat`Facultatif	float	Total TTC des produits du panier
`price_items_ex_vat`Facultatif	float	Total HT des produits du panier
`base_price`	string	Type de prix de base
`currency`	string	Devise
`is_tax_free`	boolean	Exonération des taxes
`comment`	string	Commentaire
`shipping`	object	Mode de transport
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`type`	string	Type de transporteur
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`vat_rate`	float	Taux de TVA
`weight`	integer	Poids du colis
`is_free`	boolean	Frais de port offert
`destination`	string	Pays de destination
`picking_number`	string	Url de suivi du colis
`scheduled`Facultatif	string	Date de planification
`billing_address`	object	Adresse de facturation
`civility`	string	Civilité. Les valeurs possibles sont : Mr, Mrs, Miss
`lastname`	string	Nom
`firstname`	string	Prénom
`company`	string	Société
`address`	string	Adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Pays
`country_id`	integer	Identifiant du pays
`phone`	string	Téléphone
`is_editable`	boolean	Adresse modifiable
`shipping_address`Facultatif	object	Adresse de livraison
`civility`	string	Civilité. Les valeurs possibles sont : Mr, Mrs, Miss
`lastname`	string	Nom
`firstname`	string	Prénom
`company`	string	Société
`address`	string	Adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Pays
`country_id`	integer	Identifiant du pays
`phone`	string	Téléphone
`is_editable`	boolean	Adresse modifiable
`voucher`Facultatif	object	Bon utilisé
`code`	string	Code coupon
`type`	string	Type de coupon. Les valeurs possibles sont : amount, percent, shipping
`amount`	float	Montant du coupon
`items`Facultatif	object	Liste des articles
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher, custom
`product_id`	integer	Identifiant du produit
`variant_id`	integer	Identifiant de la variante
`reference`	string	Référence de la variante
`product_name`	string	Intitulé du produit
`variant_name`	string	Intitulé de la variante
`quantity`	integer	Quantité
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`price_total_ex_vat`Facultatif	float	Prix total hors TVA
`price_total_inc_vat`Facultatif	float	Prix total avec TVA
`is_discounted`	boolean	Prix promotionnel
`discount`	float	Montant de la réduction
`vat_rate`	float	Taux de TVA
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_virtual`	boolean	Produit virtuel
`file_id`Facultatif	integer	Identifiant du fichier à télécharger pour un produit virtuel
`options`Facultatif	object	Liste des options
`option_id`	integer	Identifiant de l'option
`name`	string	Intitulé de l'option
`quantity`	integer	Quantité de l'option
`value`Facultatif	string	Valeur de l'option
`vat_rate`	float	Taux de TVA
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`activity`Facultatif	object	Historique de la commande
`message`	string	Contenu du message
`date`	string	Date de l'action
`user`	string	Nom de l'auteur
`fidelity_reward`	integer	Gain de points de fidélité
`download`Facultatif	object	Liens de téléchargement
`form`	string	Bon de commande
`xls`	string	Export xls
`coliship`Facultatif	string	Export Coliship
`xtra`Facultatif	List	Données supplémentaires

Liste les commandes abandonnées GET

`/v1/sites/{code_site}/checkout/orders/aborted.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 100)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

sort

array

Ordres de tri parmis les critères suivants :

date / -date

Tri selon la date de la commande

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:[
    {
        "order_id": "integer",
        "reference": "string",
        "customer_id": "integer",
        "customer_email": "string",
        "customer_number": "string",
        "ip_address": "string",
        "reverse_host": "string",
        "creation_date": "string",
        "modification_date": "string",
        "payment_id": "integer",
        "payment_name": "string",
        "payment_status": "string",
        "payment_date": "string",
        "price_total_inc_vat": "float",
        "price_total_ex_vat": "float",
        "price_total_inc_vat_label": "string",
        "price_total_ex_vat_label": "string",
        "price_vat": "float",
        "price_items_inc_vat": "float",
        "price_items_ex_vat": "float",
        "base_price": "string",
        "currency": "string",
        "is_tax_free": "boolean",
        "shipping": {
            "carrier_id": "integer",
            "name": "string",
            "type": "string",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "vat_rate": "float",
            "weight": "integer",
            "is_free": "boolean",
            "destination": "string",
            "picking_number": "string",
            "scheduled": "string"
        },
        "billing_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "country_id": "integer",
            "phone": "string",
            "is_editable": "boolean"
        },
        "shipping_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "country_id": "integer",
            "phone": "string",
            "is_editable": "boolean"
        },
        "voucher": {
            "code": "string",
            "type": "string",
            "amount": "float"
        },
        "items": [
            {
                "type": "string",
                "product_id": "integer",
                "variant_id": "integer",
                "reference": "string",
                "product_name": "string",
                "variant_name": "string",
                "quantity": "integer",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string",
                "price_total_ex_vat": "float",
                "price_total_inc_vat": "float",
                "is_discounted": "boolean",
                "discount": "float",
                "vat_rate": "float",
                "price_ecotax": "float",
                "price_ecotax_label": "string",
                "is_virtual": "boolean",
                "file_id": "integer"
            }
        ],
        "options": [
            {
                "option_id": "integer",
                "name": "string",
                "quantity": "integer",
                "value": "string",
                "vat_rate": "float",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string"
            }
        ],
        "activity": [
            {
                "message": "string",
                "date": "string",
                "user": "string"
            }
        ],
        "fidelity_reward": "integer",
        "xtra": "List"
    }
]

Nom	Type	Description
`order_id`	integer	Identifiant de la commande
`reference`	string	Référence de la commande
`customer_id`	integer	Identifiant du client
`customer_email`	string	Email du client
`customer_number`	string	Numéro du client
`ip_address`	string	Adresse IP du client
`reverse_host`	string	Reverse host de l'adresse IP
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification
`payment_id`	integer	Identifiant du mode de paiement
`payment_name`	string	Intitulé du mode de paiement
`payment_status`Facultatif	string	Statut pour les paiements bancaires
`payment_date`Facultatif	string	Date de paiement
`price_total_inc_vat`	float	Prix total avec TVA
`price_total_ex_vat`	float	Prix total hors TVA
`price_total_inc_vat_label`Facultatif	string	Prix total avec TVA avec devise
`price_total_ex_vat_label`Facultatif	string	Prix total hors TVA avec devise
`price_vat`Facultatif	float	Montant total de tva
`price_items_inc_vat`Facultatif	float	Total TTC des produits du panier
`price_items_ex_vat`Facultatif	float	Total HT des produits du panier
`base_price`	string	Type de prix de base
`currency`	string	Devise
`is_tax_free`	boolean	Exonération des taxes
`shipping`	object	Mode de transport
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`type`	string	Type de transporteur
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`vat_rate`	float	Taux de TVA
`weight`	integer	Poids du colis
`is_free`	boolean	Frais de port offert
`destination`	string	Pays de destination
`picking_number`	string	Url de suivi du colis
`scheduled`Facultatif	string	Date de planification
`billing_address`	object	Adresse de facturation
`civility`	string	Civilité. Les valeurs possibles sont : Mr, Mrs, Miss
`lastname`	string	Nom
`firstname`	string	Prénom
`company`	string	Société
`address`	string	Adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Pays
`country_id`	integer	Identifiant du pays
`phone`	string	Téléphone
`is_editable`	boolean	Adresse modifiable
`shipping_address`Facultatif	object	Adresse de livraison
`civility`	string	Civilité. Les valeurs possibles sont : Mr, Mrs, Miss
`lastname`	string	Nom
`firstname`	string	Prénom
`company`	string	Société
`address`	string	Adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Pays
`country_id`	integer	Identifiant du pays
`phone`	string	Téléphone
`is_editable`	boolean	Adresse modifiable
`voucher`Facultatif	object	Bon utilisé
`code`	string	Code coupon
`type`	string	Type de coupon. Les valeurs possibles sont : amount, percent, shipping
`amount`	float	Montant du coupon
`items`Facultatif	object	Liste des articles
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher, custom
`product_id`	integer	Identifiant du produit
`variant_id`	integer	Identifiant de la variante
`reference`	string	Référence de la variante
`product_name`	string	Intitulé du produit
`variant_name`	string	Intitulé de la variante
`quantity`	integer	Quantité
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`price_total_ex_vat`Facultatif	float	Prix total hors TVA
`price_total_inc_vat`Facultatif	float	Prix total avec TVA
`is_discounted`	boolean	Prix promotionnel
`discount`	float	Montant de la réduction
`vat_rate`	float	Taux de TVA
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_virtual`	boolean	Produit virtuel
`file_id`Facultatif	integer	Identifiant du fichier à télécharger pour un produit virtuel
`options`Facultatif	object	Liste des options
`option_id`	integer	Identifiant de l'option
`name`	string	Intitulé de l'option
`quantity`	integer	Quantité de l'option
`value`Facultatif	string	Valeur de l'option
`vat_rate`	float	Taux de TVA
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`activity`Facultatif	object	Historique de la commande
`message`	string	Contenu du message
`date`	string	Date de l'action
`user`	string	Nom de l'auteur
`fidelity_reward`	integer	Gain de points de fidélité
`xtra`Facultatif	List	Données supplémentaires

Réintègre une commande PUT

`/v1/sites/{code_site}/checkout/orders/aborted/{order_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`order_id`	Obligatoire	integer	Identifiant de la commande

Détail d'une commande GET

`/v1/sites/{code_site}/checkout/orders/{order_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

order_id Obligatoire integer Identifiant de la commande

extra_fields

array

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

activity	Historique de la commande
price_label	Label des prix dans la devise du site
xtra	Données personnalisées

Format de sortie :

Schéma JSON
Modèle

data:{
    "order_id": "integer",
    "reference": "string",
    "customer_id": "integer",
    "customer_email": "string",
    "customer_number": "string",
    "ip_address": "string",
    "reverse_host": "string",
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "status": "string",
    "is_paid": "boolean",
    "payment_id": "integer",
    "payment_name": "string",
    "is_reintegrated": "boolean",
    "payment_date": "string",
    "payment_date_f": "string",
    "payment_date_timestamp": "integer",
    "price_total_inc_vat": "float",
    "price_total_ex_vat": "float",
    "price_total_inc_vat_label": "string",
    "price_total_ex_vat_label": "string",
    "price_vat": "float",
    "price_items_inc_vat": "float",
    "price_items_ex_vat": "float",
    "base_price": "string",
    "currency": "string",
    "is_tax_free": "boolean",
    "comment": "string",
    "shipping": {
        "carrier_id": "integer",
        "name": "string",
        "type": "string",
        "price_ex_vat": "float",
        "price_inc_vat": "float",
        "price_ex_vat_label": "string",
        "price_inc_vat_label": "string",
        "vat_rate": "float",
        "weight": "integer",
        "is_free": "boolean",
        "destination": "string",
        "picking_number": "string",
        "scheduled": "string"
    },
    "billing_address": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "country_id": "integer",
        "phone": "string",
        "is_editable": "boolean"
    },
    "shipping_address": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "country_id": "integer",
        "phone": "string",
        "is_editable": "boolean"
    },
    "voucher": {
        "code": "string",
        "type": "string",
        "amount": "float"
    },
    "items": [
        {
            "type": "string",
            "product_id": "integer",
            "variant_id": "integer",
            "reference": "string",
            "product_name": "string",
            "variant_name": "string",
            "quantity": "integer",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string",
            "price_total_ex_vat": "float",
            "price_total_inc_vat": "float",
            "is_discounted": "boolean",
            "discount": "float",
            "vat_rate": "float",
            "price_ecotax": "float",
            "price_ecotax_label": "string",
            "is_virtual": "boolean",
            "file_id": "integer"
        }
    ],
    "options": [
        {
            "option_id": "integer",
            "name": "string",
            "quantity": "integer",
            "value": "string",
            "vat_rate": "float",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string"
        }
    ],
    "activity": [
        {
            "message": "string",
            "date": "string",
            "user": "string"
        }
    ],
    "fidelity_reward": "integer",
    "download": {
        "form": "string",
        "xls": "string",
        "coliship": "string"
    },
    "xtra": "List"
}

Nom	Type	Description
`order_id`	integer	Identifiant de la commande
`reference`	string	Référence de la commande
`customer_id`	integer	Identifiant du client
`customer_email`	string	Email du client
`customer_number`	string	Numéro du client
`ip_address`	string	Adresse IP du client
`reverse_host`	string	Reverse host de l'adresse IP
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`status`	string	Statut de la commande
`is_paid`	boolean	Commande payée
`payment_id`	integer	Identifiant du mode de paiement
`payment_name`	string	Intitulé du mode de paiement
`is_reintegrated`	boolean	Commande réintégrée
`payment_date`Facultatif	string	Date de paiement
`payment_date_f`Facultatif	string	Date de paiement formatée
`payment_date_timestamp`Facultatif	integer	Timestamp de la date de paiement
`price_total_inc_vat`	float	Prix total avec TVA
`price_total_ex_vat`	float	Prix total hors TVA
`price_total_inc_vat_label`Facultatif	string	Prix total avec TVA avec devise
`price_total_ex_vat_label`Facultatif	string	Prix total hors TVA avec devise
`price_vat`Facultatif	float	Montant total de tva
`price_items_inc_vat`Facultatif	float	Total TTC des produits du panier
`price_items_ex_vat`Facultatif	float	Total HT des produits du panier
`base_price`	string	Type de prix de base
`currency`	string	Devise
`is_tax_free`	boolean	Exonération des taxes
`comment`	string	Commentaire
`shipping`	object	Mode de transport
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`type`	string	Type de transporteur
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`vat_rate`	float	Taux de TVA
`weight`	integer	Poids du colis
`is_free`	boolean	Frais de port offert
`destination`	string	Pays de destination
`picking_number`	string	Url de suivi du colis
`scheduled`Facultatif	string	Date de planification
`billing_address`	object	Adresse de facturation
`civility`	string	Civilité. Les valeurs possibles sont : Mr, Mrs, Miss
`lastname`	string	Nom
`firstname`	string	Prénom
`company`	string	Société
`address`	string	Adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Pays
`country_id`	integer	Identifiant du pays
`phone`	string	Téléphone
`is_editable`	boolean	Adresse modifiable
`shipping_address`Facultatif	object	Adresse de livraison
`civility`	string	Civilité. Les valeurs possibles sont : Mr, Mrs, Miss
`lastname`	string	Nom
`firstname`	string	Prénom
`company`	string	Société
`address`	string	Adresse
`zipcode`	string	Code postal
`city`	string	Ville
`country`	string	Pays
`country_id`	integer	Identifiant du pays
`phone`	string	Téléphone
`is_editable`	boolean	Adresse modifiable
`voucher`Facultatif	object	Bon utilisé
`code`	string	Code coupon
`type`	string	Type de coupon. Les valeurs possibles sont : amount, percent, shipping
`amount`	float	Montant du coupon
`items`Facultatif	object	Liste des articles
`type`	string	Type d'article. Les valeurs possibles sont : product, voucher, custom
`product_id`	integer	Identifiant du produit
`variant_id`	integer	Identifiant de la variante
`reference`	string	Référence de la variante
`product_name`	string	Intitulé du produit
`variant_name`	string	Intitulé de la variante
`quantity`	integer	Quantité
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`price_total_ex_vat`Facultatif	float	Prix total hors TVA
`price_total_inc_vat`Facultatif	float	Prix total avec TVA
`is_discounted`	boolean	Prix promotionnel
`discount`	float	Montant de la réduction
`vat_rate`	float	Taux de TVA
`price_ecotax`	float	Montant de l'éco-taxe
`price_ecotax_label`Facultatif	string	Montant de l'éco-taxe avec devise
`is_virtual`	boolean	Produit virtuel
`file_id`Facultatif	integer	Identifiant du fichier à télécharger pour un produit virtuel
`options`Facultatif	object	Liste des options
`option_id`	integer	Identifiant de l'option
`name`	string	Intitulé de l'option
`quantity`	integer	Quantité de l'option
`value`Facultatif	string	Valeur de l'option
`vat_rate`	float	Taux de TVA
`price_ex_vat`Facultatif	float	Prix hors TVA
`price_inc_vat`Facultatif	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
`activity`Facultatif	object	Historique de la commande
`message`	string	Contenu du message
`date`	string	Date de l'action
`user`	string	Nom de l'auteur
`fidelity_reward`	integer	Gain de points de fidélité
`download`Facultatif	object	Liens de téléchargement
`form`	string	Bon de commande
`xls`	string	Export xls
`coliship`Facultatif	string	Export Coliship
`xtra`Facultatif	List	Données supplémentaires

Modifie une commande PUT

`/v1/sites/{code_site}/checkout/orders/{order_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

order_id Obligatoire integer Identifiant de la commande

is_paid boolean Commande payée

status

string

Statut de la commande parmis les valeurs suivantes :

pending	À traiter
processing	En cours
processed	Traitée
shipped	Expédiée
cancelled	Annulée

Les valeurs attendues sont : pending, processing, processed, shipped, cancelled

comment string Note sur la commande

picking_number string Url du suivi de colis

notify boolean Notification du changement d'état

billing_address

array

Adresse de facturation avec les champs suivants :

civility	Civilité
lastname	Nom
firstname	Prénom
company	Société
address	Adresse
zipcode	Code postal
city	Ville
country_id	Identifiant du pays
phone	Téléphone

shipping_address

array

Adresse de livraison, hors transporteur points relais et pickup, avec les champs suivants :

civility	Civilité
lastname	Nom
firstname	Prénom
company	Société
address	Adresse
zipcode	Code postal
city	Ville
country_id	Identifiant du pays

Historique d'une commande GET

`/v1/sites/{code_site}/checkout/orders/{order_id}/activity.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`order_id`	Obligatoire	integer	Identifiant de la commande

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "message": "string",
        "date": "string",
        "user": "string"
    }
]

Nom	Type	Description
`message`	string	Contenu du message
`date`	string	Date de l'action
`user`	string	Nom de l'auteur

Ajoute une entrée dans l'historique POST

`/v1/sites/{code_site}/checkout/orders/{order_id}/activity.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`order_id`	Obligatoire	integer	Identifiant de la commande
`message`	Obligatoire	string	Texte de l'historique

Moyens de paiements

Liste les modes de paiements GET

`/v1/sites/{code_site}/checkout/payments.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "payment_id": "integer",
        "name": "string",
        "type": "string",
        "is_enabled": "boolean",
        "position": "integer",
        "config": "List",
        "notification_url": "string"
    }
]

Nom	Type	Description
`payment_id`	integer	Identifiant du mode de paiement
`name`	string	Intitulé du mode de paiement
`type`	string	Type du mode de paiement
`is_enabled`	boolean	Mode de paiement actif
`position`	integer	Position dans la liste des modes de paiement
`config`Facultatif	List	Données de configuration
`notification_url`Facultatif	string	Données de configuration

Réordonne les modes de paiements PUT

`/v1/sites/{code_site}/checkout/payments.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`order`	Obligatoire	array	Liste des identifiants des modes de paiments

Détail d'un mode de paiements GET

`/v1/sites/{code_site}/checkout/payments/{payment_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`payment_id`	Obligatoire	integer	Identifiant du mode de paiement

Format de sortie :

Schéma JSON
Modèle

data:{
    "payment_id": "integer",
    "name": "string",
    "type": "string",
    "is_enabled": "boolean",
    "position": "integer",
    "config": "List",
    "notification_url": "string"
}

Nom	Type	Description
`payment_id`	integer	Identifiant du mode de paiement
`name`	string	Intitulé du mode de paiement
`type`	string	Type du mode de paiement
`is_enabled`	boolean	Mode de paiement actif
`position`	integer	Position dans la liste des modes de paiement
`config`Facultatif	List	Données de configuration
`notification_url`Facultatif	string	Données de configuration

Modifie un mode de paiements PUT

`/v1/sites/{code_site}/checkout/payments/{payment_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

payment_id Obligatoire integer Identifiant du mode de paiement

is_enabled boolean Activation du mode de paiement

config

array

Paramètres de configuration du mode de paiement.

Chèque:

ordre	Ordre du libellé du chèque
intitule_long	Intitulé du mode de paiement
message	Message de confirmation

Virement :

IBAN	IBAN
BIC	BIC
rib_banque	RIB : Banque
rib_guichet	RIB : Guichet
rib_compte	RIB : N° de compte
rib_cle	RIB : Clé
domicile	Domiciliation
intitule_long	Intitulé du mode de paiement
message	Message de confirmation

Paypal :

email	Email du compte PayPal
intitule_long	Intitulé du mode de paiement
message	Message de confirmation

Paybox :

site	Numéro du site
banque	Banque
mode	Mode de signature (hmac ou cgi)
hmac	Clé de hachage pour le mode hmac
rang	Rang
id	Identifiant Paybox
intitule_long	Intitulé du mode de paiement
message	Message de confirmation

CM-CIC :

tpe	Numéro de TPE
societe	Code société
key	Clé
banque	Banque
mode	Mode (test ou prod)
intitule_long	Intitulé du mode de paiement
message	Message de confirmation

ATOS SIPS :

intitule_long	Intitulé du mode de paiement
version	Version du certificat
banque	Banque
certif	Nom du certificat
certif_payload	Contenu du certificat (base64encodé)
message	Message de confirmation
auto_return	Retour automatique au site marchand

SystemPay :

tpe	Identifiant boutique
key	Certificat
mode	Mode (test ou prod)
hash	Algorythme de hachage (sha1 ou sha256)
banque	Banque
intitule_long	Intitulé du mode de paiement
message	Message de confirmation

Transporteurs

Liste les transporteurs GET

`/v1/sites/{code_site}/checkout/carriers.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "carrier_id": "integer",
        "name": "string",
        "is_enabled": "boolean",
        "is_default": "boolean",
        "is_deletable": "boolean",
        "description": "string",
        "position": "integer",
        "type": "string"
    }
]

Nom	Type	Description
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`is_enabled`	boolean	Transporteur actif
`is_default`	boolean	Transporteur par défaut
`is_deletable`	boolean	Transporteur supprimable
`description`	string	Description du transporteur
`position`	integer	Position dans la liste des transporteurs
`type`	string	Type de transporteur

Crée un transporteur POST

`/v1/sites/{code_site}/checkout/carriers.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`tax_id`		integer	Identifiant de la taxe
`name`		string	Intitulé du transporteur
`type`		string	Type de transporteur Les valeurs attendues sont : magasin, tranchespoids, local
`is_enabled`		boolean	Transporteur actif

Format de sortie :

Schéma JSON
Modèle

data:{
    "carrier_id": "integer",
    "name": "string",
    "is_enabled": "boolean",
    "is_default": "boolean",
    "is_deletable": "boolean",
    "description": "string",
    "position": "integer",
    "type": "string",
    "company": "string",
    "address": "string",
    "zipcode": "string",
    "city": "string",
    "country_id": "integer",
    "country": "string",
    "socolissimo_id": "string",
    "socolissimo_secret": "string",
    "socolissimo_pickup_free_threshold": "float",
    "socolissimo_be_enabled": "boolean",
    "socolissimo_be_extra": "float",
    "socolissimo_login": "string",
    "socolissimo_password": "string",
    "socolissimo_gmaps": "string",
    "socolissimo_delay": "int",
    "export_type": "string",
    "coliship_type": "string",
    "coliship_tradername": "string",
    "dpd_customer_center": "string",
    "dpd_customer": "string",
    "dpd_gmaps": "string",
    "dpd_insurance_threshold": "float",
    "dpd_gsm_notification": "boolean",
    "mondialrelay_customer": "string",
    "mondialrelay_secret": "string",
    "mondialrelay_brand": "string",
    "mondialrelay_insurance_level": "string",
    "mondialrelay_insurance_threshold": "float",
    "mondialrelay_delay": "integer",
    "mondialrelay_gmaps": "string",
    "tax_id": "integer",
    "threshold": "float",
    "require_scheduling": "string",
    "open_days": "List",
    "closed_days": "List",
    "limit_hour": "string",
    "scheduling_interval_min": "int",
    "scheduling_interval_max": "int"
}

Nom	Type	Description
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`is_enabled`	boolean	Transporteur actif
`is_default`	boolean	Transporteur par défaut
`is_deletable`	boolean	Transporteur supprimable
`description`	string	Description du transporteur
`position`	integer	Position dans la liste des transporteurs
`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_id`Facultatif	integer	Identifiant du pays (en cas de livraison en magasin)
`country`Facultatif	string	Nom du pays (en cas de livraison en magasin)
`socolissimo_id`Facultatif	string	Identifiant SoColissimo
`socolissimo_secret`Facultatif	string	Clé secrète SoColissimo
`socolissimo_pickup_free_threshold`Facultatif	float	Franco de port pour les points relais
`socolissimo_be_enabled`Facultatif	boolean	Activation de la livraison en Belgique
`socolissimo_be_extra`Facultatif	float	Surcoût des livraison en Belgique
`socolissimo_login`Facultatif	string	Identifiant Socolissimo
`socolissimo_password`Facultatif	string	Mot de passe Socolissimo
`socolissimo_gmaps`Facultatif	string	Clé API Google Maps pour Socolissimo
`socolissimo_delay`Facultatif	int	Nombre de jours nécessaires à la préparation de la commande
`export_type`Facultatif	string	Compatibilité avec un transporteur tiers. Les valeurs possibles sont : , coliship, dpd, mondialrelay
`coliship_type`Facultatif	string	Remise contre signature
`coliship_tradername`Facultatif	string	Nom commercial du chargeur
`dpd_customer_center`Facultatif	string	Code agende DPD
`dpd_customer`Facultatif	string	Numéro de contrat DPD
`dpd_gmaps`Facultatif	string	Clé API Google Maps pour DPD
`dpd_insurance_threshold`Facultatif	float	Seuil d'assurance DPD
`dpd_gsm_notification`Facultatif	boolean	Notification par SMS DPD
`mondialrelay_customer`Facultatif	string	Code enseigne Mondial Relay
`mondialrelay_secret`Facultatif	string	Clé secrète Mondial Relay
`mondialrelay_brand`Facultatif	string	Code marque Mondial Relay
`mondialrelay_insurance_level`Facultatif	string	Niveau d'assurance Mondial Relay
`mondialrelay_insurance_threshold`Facultatif	float	Seuil d'assurance Mondial Relay
`mondialrelay_delay`Facultatif	integer	Nombre de jours nécessaires à la préparation de la commande
`mondialrelay_gmaps`Facultatif	string	Clé API Google Maps pour Mondial Relay
`tax_id`Facultatif	integer	Identifiant de la taxe
`threshold`Facultatif	float	Seuil d'achat minimal (HT ou TTC suivant la configuration du catalogue)
`require_scheduling`	string	Plannification de la date de livraison
`open_days`Facultatif	List	Jours ouvrés
`closed_days`Facultatif	List	Jours de fermetures exceptionelles
`limit_hour`Facultatif	string	Heure de bascule
`scheduling_interval_min`Facultatif	int	Nombre de jour minimal avant livraison
`scheduling_interval_max`Facultatif	int	Nombre de jour maximal pour la livraison

Réordonne les transporteurs PUT

`/v1/sites/{code_site}/checkout/carriers.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`order`	Obligatoire	array	Liste des identifiants des transporteurs

Estime des frais de ports GET

`/v1/sites/{code_site}/checkout/carriers/estimations.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

country_id Obligatoire integer Identification du pays de livraison

postal_code Obligatoire string Code postal de livraison

weight Obligatoire integer Poids en gramme

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:[
    {
        "carrier_id": "integer",
        "carrier_name": "string",
        "carrier_type": "string",
        "price_ex_vat": "float",
        "price_inc_vat": "float",
        "price_ex_vat_label": "string",
        "price_inc_vat_label": "string",
        "vat_rate": "float"
    }
]

Nom	Type	Description
`carrier_id`	integer	Identifiant du transporteur
`carrier_name`	string	Intitulé du transporteur
`carrier_type`	string	Type du transporteur
`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
`vat_rate`	float	Taux de TVA

Détail d'un transporteur GET

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur

Format de sortie :

Schéma JSON
Modèle

data:{
    "carrier_id": "integer",
    "name": "string",
    "is_enabled": "boolean",
    "is_default": "boolean",
    "is_deletable": "boolean",
    "description": "string",
    "position": "integer",
    "type": "string",
    "company": "string",
    "address": "string",
    "zipcode": "string",
    "city": "string",
    "country_id": "integer",
    "country": "string",
    "socolissimo_id": "string",
    "socolissimo_secret": "string",
    "socolissimo_pickup_free_threshold": "float",
    "socolissimo_be_enabled": "boolean",
    "socolissimo_be_extra": "float",
    "socolissimo_login": "string",
    "socolissimo_password": "string",
    "socolissimo_gmaps": "string",
    "socolissimo_delay": "int",
    "export_type": "string",
    "coliship_type": "string",
    "coliship_tradername": "string",
    "dpd_customer_center": "string",
    "dpd_customer": "string",
    "dpd_gmaps": "string",
    "dpd_insurance_threshold": "float",
    "dpd_gsm_notification": "boolean",
    "mondialrelay_customer": "string",
    "mondialrelay_secret": "string",
    "mondialrelay_brand": "string",
    "mondialrelay_insurance_level": "string",
    "mondialrelay_insurance_threshold": "float",
    "mondialrelay_delay": "integer",
    "mondialrelay_gmaps": "string",
    "tax_id": "integer",
    "threshold": "float",
    "require_scheduling": "string",
    "open_days": "List",
    "closed_days": "List",
    "limit_hour": "string",
    "scheduling_interval_min": "int",
    "scheduling_interval_max": "int"
}

Nom	Type	Description
`carrier_id`	integer	Identifiant du transporteur
`name`	string	Intitulé du transporteur
`is_enabled`	boolean	Transporteur actif
`is_default`	boolean	Transporteur par défaut
`is_deletable`	boolean	Transporteur supprimable
`description`	string	Description du transporteur
`position`	integer	Position dans la liste des transporteurs
`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_id`Facultatif	integer	Identifiant du pays (en cas de livraison en magasin)
`country`Facultatif	string	Nom du pays (en cas de livraison en magasin)
`socolissimo_id`Facultatif	string	Identifiant SoColissimo
`socolissimo_secret`Facultatif	string	Clé secrète SoColissimo
`socolissimo_pickup_free_threshold`Facultatif	float	Franco de port pour les points relais
`socolissimo_be_enabled`Facultatif	boolean	Activation de la livraison en Belgique
`socolissimo_be_extra`Facultatif	float	Surcoût des livraison en Belgique
`socolissimo_login`Facultatif	string	Identifiant Socolissimo
`socolissimo_password`Facultatif	string	Mot de passe Socolissimo
`socolissimo_gmaps`Facultatif	string	Clé API Google Maps pour Socolissimo
`socolissimo_delay`Facultatif	int	Nombre de jours nécessaires à la préparation de la commande
`export_type`Facultatif	string	Compatibilité avec un transporteur tiers. Les valeurs possibles sont : , coliship, dpd, mondialrelay
`coliship_type`Facultatif	string	Remise contre signature
`coliship_tradername`Facultatif	string	Nom commercial du chargeur
`dpd_customer_center`Facultatif	string	Code agende DPD
`dpd_customer`Facultatif	string	Numéro de contrat DPD
`dpd_gmaps`Facultatif	string	Clé API Google Maps pour DPD
`dpd_insurance_threshold`Facultatif	float	Seuil d'assurance DPD
`dpd_gsm_notification`Facultatif	boolean	Notification par SMS DPD
`mondialrelay_customer`Facultatif	string	Code enseigne Mondial Relay
`mondialrelay_secret`Facultatif	string	Clé secrète Mondial Relay
`mondialrelay_brand`Facultatif	string	Code marque Mondial Relay
`mondialrelay_insurance_level`Facultatif	string	Niveau d'assurance Mondial Relay
`mondialrelay_insurance_threshold`Facultatif	float	Seuil d'assurance Mondial Relay
`mondialrelay_delay`Facultatif	integer	Nombre de jours nécessaires à la préparation de la commande
`mondialrelay_gmaps`Facultatif	string	Clé API Google Maps pour Mondial Relay
`tax_id`Facultatif	integer	Identifiant de la taxe
`threshold`Facultatif	float	Seuil d'achat minimal (HT ou TTC suivant la configuration du catalogue)
`require_scheduling`	string	Plannification de la date de livraison
`open_days`Facultatif	List	Jours ouvrés
`closed_days`Facultatif	List	Jours de fermetures exceptionelles
`limit_hour`Facultatif	string	Heure de bascule
`scheduling_interval_min`Facultatif	int	Nombre de jour minimal avant livraison
`scheduling_interval_max`Facultatif	int	Nombre de jour maximal pour la livraison

Modifie un transporteur PUT

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur
`name`		string	Intitulé du transporteur
`description`		string	Description du transporteur
`threshold`		float	Seuil d'achat minimal (HT ou TTC suivant la configuration du catalogue)
`is_enabled`		boolean	Transporteur actif
`is_default`		boolean	Transporteur par défaut
`tax_id`		integer	Identifiant de la taxe
`socolissimo_id`		string	Identifiant SoColissimo
`socolissimo_secret`		string	Clé secrète SoColissimo
`socolissimo_pickup_free_threshold`		float	Franco de port pour les points relais
`socolissimo_be_enabled`		boolean	Activation de la livraison en Belgique
`socolissimo_be_extra`		float	Surcoût des livraison en Belgique
`socolissimo_login`		string	Identifiant SoColissimo
`socolissimo_password`		string	Mot de passe SoColissimo
`socolissimo_delay`		integer	Délai de préparation de colis
`socolissimo_gmaps`		string	Clé API Google Maps pour SoColissimo
`coliship_type`		string	Remise contre signature
`coliship_tradername`		string	Nom commercial du chargeur
`export_type`		string	Compatibilité avec un transporteur tiers Les valeurs attendues sont : , coliship, dpd, mondialrelay
`dpd_customer_center`		string	Code agende DPD
`dpd_customer`		string	Numéro de contrat DPD
`dpd_gmaps`		string	Clé API Google Maps pour DPD
`dpd_insurance_threshold`		float	Seuil d'assurance DPD
`dpd_gsm_notification`		boolean	Notification par SMS DPD
`mondialrelay_customer`		string	Code enseigne Mondial Relay
`mondialrelay_secret`		string	Clé secrète Mondial Relay
`mondialrelay_delay`		integer	Nombres de jours nécessaires à la préparation de la commande
`mondialrelay_insurance_level`		string	Niveau d'assurance Mondial Relay Les valeurs attendues sont : ceil, floor
`mondialrelay_insurance_threshold`		float	Seuil d'assurance Mondial Relay
`mondialrelay_brand`		string	Code marque Mondial Relay
`mondialrelay_gmaps`		string	Clé API Google Maps pour Mondial Relay
`company`		string	Nom de la société (en cas de livraison en magasin)
`address`		string	Adresse (en cas de livraison en magasin)
`zipcode`		string	Code postal (en cas de livraison en magasin)
`city`		string	Ville (en cas de livraison en magasin)
`country_id`		integer	Identifiant du pays (en cas de livraison en magasin)
`require_scheduling`		string	Plannification de la date de livraison
`closed_days`		array	Jours de fermetures exceptionelles
`limit_hour`		string	Heure de bascule
`scheduling_interval_min`		integer	Nombre de jour minimal avant livraison
`scheduling_interval_max`		integer	Nombre de jour maximal pour la livraison
`open_days`		array	Jours ouvrés

Supprime un transporteur DELETE

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur

Liste les pays configurés GET

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/countries.json`

Liste les pays configurés pour un transporteur de type 'tranche/poids'.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

carrier_id Obligatoire integer Identifiant du transporteur

extra_fields

array

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

all_countries

Liste tous les pays, même ceux qui n'ont pas de tranches

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "country_id": "integer",
        "code": "string",
        "name": "string",
        "count": "integer"
    }
]

Nom	Type	Description
`country_id`	integer	Identifiant du pays
`code`	string	Code ISO du pays
`name`	string	Nom du pays
`count`	integer	Nombre de tranches

Liste les tranches de poids GET

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/countries/{country_id}.json`

Liste les tranches de poids d'un transporteur pour un pays ainsi que franco de port applicable et les délais de livraison.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

carrier_id Obligatoire integer Identifiant du transporteur

country_id Obligatoire integer Identifiant du 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:{
    "country_id": "integer",
    "free_threshold": "float",
    "delay": "string",
    "steps": [
        {
            "weight": "integer",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string"
        }
    ]
}

Nom	Type	Description
`country_id`	integer	Identifiant du pays
`free_threshold`Facultatif	float
`delay`Facultatif	string
`steps`	object
`weight`	integer	Poids
`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

Modifie les tranches de poids PUT

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/countries/{country_id}.json`

Supprime et redéfinis les tranches de poids d'un transporteur pour un pays ainsi que franco de port applicable et les délais de livraison.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur
`country_id`	Obligatoire	integer	Identifiant du pays
`free_threshold`		float	Franco de port
`delay`		string	Délai de livraison
`steps`		array	Tranches de poids

Supprime les tranches de poids DELETE

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/countries/{country_id}.json`

Supprime les tranches de poids d'un transporteur pour un pays ainsi que franco de port applicable et les délais de livraison.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur
`country_id`	Obligatoire	integer	Identifiant du pays

Teste la disponibilité d'un date de livraison GET

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/schedule.json`

Paramètres supportés par ce endpoint :

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

Liste les zones configurés GET

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/zones.json`

Liste les zones configurés pour un transporteur de type 'local'.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "zone_id": "integer",
        "postal_codes": "List",
        "free_threshold": "float",
        "steps": [
            {
                "weight": "integer",
                "price_ex_vat": "float",
                "price_inc_vat": "float",
                "price_ex_vat_label": "string",
                "price_inc_vat_label": "string"
            }
        ]
    }
]

Nom	Type	Description
`zone_id`	integer	Identifiant de la zone
`postal_codes`	List	Codes postaux de la zone
`free_threshold`Facultatif	float	Franco de port
`steps`Facultatif	object
`weight`	integer	Poids
`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

Ajoute une zone POST

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/zones.json`

Crée une zone pour un transporteur de type 'local' à partir d'un ensemble de codes postaux.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur
`postal_codes`		array	Liste des codes postaux
`free_threshold`		float	Franco de port

Format de sortie :

Schéma JSON
Modèle

data:{
    "zone_id": "integer",
    "postal_codes": "List",
    "free_threshold": "float",
    "steps": [
        {
            "weight": "integer",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string"
        }
    ]
}

Nom	Type	Description
`zone_id`	integer	Identifiant de la zone
`postal_codes`	List	Codes postaux de la zone
`free_threshold`Facultatif	float	Franco de port
`steps`Facultatif	object
`weight`	integer	Poids
`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

Liste les tranches de poids GET

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/zones/{zone_id}.json`

Liste les tranches de poids d'un transporteur de type 'local'.

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

carrier_id Obligatoire integer Identifiant du transporteur

zone_id Obligatoire integer Identifiant de la zone

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:{
    "zone_id": "integer",
    "postal_codes": "List",
    "free_threshold": "float",
    "steps": [
        {
            "weight": "integer",
            "price_ex_vat": "float",
            "price_inc_vat": "float",
            "price_ex_vat_label": "string",
            "price_inc_vat_label": "string"
        }
    ]
}

Nom	Type	Description
`zone_id`	integer	Identifiant de la zone
`postal_codes`	List	Codes postaux de la zone
`free_threshold`Facultatif	float	Franco de port
`steps`Facultatif	object
`weight`	integer	Poids
`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

Modifie les tranches de poids PUT

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/zones/{zone_id}.json`

Supprime et redéfinis toutes les tranches de poids d'un transporteur de type 'local'.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur
`zone_id`	Obligatoire	integer	Identifiant de la zone
`free_threshold`		float	Franco de port
`postal_codes`		array	Codes postaux
`steps`		array	Tranches de poids

Supprime les tranches de poids DELETE

`/v1/sites/{code_site}/checkout/carriers/{carrier_id}/zones/{zone_id}.json`

Supprime les tranches de poids d'un transporteur de type 'local'.

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`carrier_id`	Obligatoire	integer	Identifiant du transporteur
`zone_id`	Obligatoire	integer	Identifiant de la zone

Options à la commande

Liste les options à la commande GET

`/v1/sites/{code_site}/checkout/options.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

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:[
    {
        "option_id": "integer",
        "name": "string",
        "description": "string",
        "is_enabled": "boolean",
        "tax_id": "integer",
        "price_ex_vat": "float",
        "price_inc_vat": "float",
        "price_ex_vat_label": "string",
        "price_inc_vat_label": "string",
        "type": "string",
        "values": [
            []
        ],
        "position": "integer",
        "creation_date": "string",
        "modification_date": "string"
    }
]

Nom	Type	Description
`option_id`	integer	Identifiant de l'option
`name`	string	Intitulé de l'option
`description`	string	Description de l'option
`is_enabled`	boolean	Affichage de l'option
`tax_id`	integer	Identifiant de la taxe
`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
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`values`	object	Liste des choix pour une option de type select
`position`	integer	Position dans la liste des options
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Ajoute une option à la commande POST

`/v1/sites/{code_site}/checkout/options.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

type

Obligatoire

string

Type d'option :

simple	Simple
textarea	Zone de texte
select	Liste déroulante

Les valeurs attendues sont : simple, textarea, select

name string Libellé de l'option

description string Description de l'option

is_enabled boolean Affichage de l'option

tax_id integer Identifiant de la taxe

price_ex_vat float Prix HT de l'option

price_inc_vat float Prix TTC de l'option

values array Valeurs possible pour une option de type liste déroulante

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Réordonne les options à la commande PUT

`/v1/sites/{code_site}/checkout/options.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`order`	Obligatoire	array	Liste des identifiants des options à la commande

Détail d'une option à la commande GET

`/v1/sites/{code_site}/checkout/options/{option_id}.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

option_id Obligatoire integer Identifiant de l'option

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:{
    "option_id": "integer",
    "name": "string",
    "description": "string",
    "is_enabled": "boolean",
    "tax_id": "integer",
    "price_ex_vat": "float",
    "price_inc_vat": "float",
    "price_ex_vat_label": "string",
    "price_inc_vat_label": "string",
    "type": "string",
    "values": [
        []
    ],
    "position": "integer",
    "creation_date": "string",
    "modification_date": "string"
}

Nom	Type	Description
`option_id`	integer	Identifiant de l'option
`name`	string	Intitulé de l'option
`description`	string	Description de l'option
`is_enabled`	boolean	Affichage de l'option
`tax_id`	integer	Identifiant de la taxe
`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
`type`	string	Type d'option. Les valeurs possibles sont : simple, textarea, select
`values`	object	Liste des choix pour une option de type select
`position`	integer	Position dans la liste des options
`creation_date`	string	Date de création
`modification_date`Facultatif	string	Date de dernière modification

Modifie une option à la commande PUT

`/v1/sites/{code_site}/checkout/options/{option_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`option_id`	Obligatoire	integer	Identifiant de l'option
`name`		string	Libellé de l'option
`description`		string	Description de l'option
`is_enabled`		boolean	Affichage de l'option
`tax_id`		integer	Identifiant de la taxe
`price_ex_vat`		float	Prix HT de l'option
`price_inc_vat`		float	Prix TTC de l'option
`values`		array	Valeurs possible pour une option de type liste déroulante

Supprime une option à la commande DELETE

`/v1/sites/{code_site}/checkout/options/{option_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`option_id`	Obligatoire	integer	Identifiant de l'option

Bon de réduction

Liste les bons de réduction GET

`/v1/sites/{code_site}/checkout/vouchers.json`

Paramètres supportés par ce endpoint :

Nom Type Description

code_site Obligatoire string Code site

term string Recherche par intitulé

type string Type de remise
Les valeurs attendues sont : amount, percent, shipping

value_min float Valeur minimale

value_max float Valeur maximale

is_enabled boolean Actif

start_date_min string Date de début de validité minimale

start_date_max string Date de début de validité maximale

end_date_min string Date de fin de validité minimale

end_date_max string Date de fin de validité maximale

limit integer Nombre d'éléments par page (valeur par défaut : 20, maximum : 20)

page integer Numéro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)

sort

array

Ordres de tri parmis les critères suivants :

code / -code	Tri selon le code du bon
start_date / -start_date	Tri selon la date de début de validité du bon
end_date / -end_date	Tri selon la date de fin de validité du bon

Format de sortie :

Schéma JSON
Modèle

data:[
    {
        "voucher_id": "integer",
        "code": "string",
        "type": "string",
        "value": "float",
        "value_label": "string",
        "start_date": "string",
        "start_date_f": "string",
        "end_date": "string",
        "end_date_f": "string",
        "is_enabled": "boolean",
        "stock": "integer",
        "is_stock_unlimited": "boolean",
        "quota": "integer",
        "is_quota_unlimited": "boolean",
        "used": "integer",
        "threshold": "float",
        "threshold_label": "string",
        "has_restrictions": "boolean",
        "restrictions": {
            "allow": {
                "products": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ],
                "categories": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ],
                "customers": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ],
                "groups": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ]
            },
            "deny": {
                "products": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ],
                "categories": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ],
                "customers": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ],
                "groups": [
                    {
                        "restriction_id": "integer",
                        "name": "string"
                    }
                ]
            }
        },
        "creation_date": "string",
        "creation_date_f": "string",
        "creation_date_timestamp": "integer",
        "modification_date": "string",
        "modification_date_f": "string",
        "modification_date_timestamp": "integer",
        "carrier_id": "integer"
    }
]

Nom	Type	Description
`voucher_id`	integer	Identifiant du bon de réduction
`code`	string	Code du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, shipping, amount
`value`	float	Montant du bon
`value_label`	string	Montant du bon avec la devise
`start_date`	string	Date de début de validité
`start_date_f`	string	Date formatée de début de validité
`end_date`	string	Date de fin de validité
`end_date_f`	string	Date formatée de fin de validité
`is_enabled`	boolean	Bon actif
`stock`	integer	Nombre maximum d'utilisation possible du bon
`is_stock_unlimited`	boolean	Utilisation illimité
`quota`	integer	Nombre maximum d'utilisation du bon par un même client
`is_quota_unlimited`	boolean	Utilisation illimité par client
`used`	integer	Nombre d'utilisation actuel
`threshold`	float	Seuil d'achat
`threshold_label`	string	Seuil d'achat en pourcentage
`has_restrictions`	boolean	Bon à usage restreint
`restrictions`Facultatif	object	Restrictions
`allow`	object	Restrictions sur des produits
`products`	object	Restrictions sur des produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`categories`	object	Restrictions sur des catégories de produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`customers`	object	Restrictions sur des clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`groups`	object	Restrictions sur des groupes de clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`deny`	object	Restrictions sur des catégories de produits
`products`	object	Restrictions sur des produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`categories`	object	Restrictions sur des catégories de produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`customers`	object	Restrictions sur des clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`groups`	object	Restrictions sur des groupes de clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`carrier_id`Facultatif	integer	Identifiant du mode de transport pour les bons frais de port offert

Crée un bon de réduction POST

`/v1/sites/{code_site}/checkout/vouchers.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`code`		string	Code du nouveau bon de réduction
`type`		string	Type du bon de réduction Les valeurs attendues sont : amount, percent, shipping
`is_enabled`	Obligatoire	boolean	Determine si le bon est actif ou non
`start_date`	Obligatoire	Date	Date de début de validité du bon (00h01)
`end_date`	Obligatoire	Date	Date de fin de validité du bon (23h59)
`value`	Obligatoire	float	Montant de la remise
`threshold`	Obligatoire	float	Seuil d'achat
`carrier_id`		integer	Identifiant unique du transporteur pour les bons de type shipping
`quota`	Obligatoire	integer	Nombre de fois que le bon de réduction est utilisable par client
`is_quota_unlimited`	Obligatoire	boolean	Determine si le bon de réduction est utilisable par un même client un nombre illimité de fois
`stock`	Obligatoire	integer	Nombre de fois que le bon de réduction est utilisable sur le site
`is_stock_unlimited`	Obligatoire	boolean	Determine si le bon de réduction est utilisable sur le site un nombre illimité de fois

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Détail d'un bon de réduction GET

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant unique du bon de réduction

Format de sortie :

Schéma JSON
Modèle

data:{
    "voucher_id": "integer",
    "code": "string",
    "type": "string",
    "value": "float",
    "value_label": "string",
    "start_date": "string",
    "start_date_f": "string",
    "end_date": "string",
    "end_date_f": "string",
    "is_enabled": "boolean",
    "stock": "integer",
    "is_stock_unlimited": "boolean",
    "quota": "integer",
    "is_quota_unlimited": "boolean",
    "used": "integer",
    "threshold": "float",
    "threshold_label": "string",
    "has_restrictions": "boolean",
    "restrictions": {
        "allow": {
            "products": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ],
            "categories": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ],
            "customers": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ],
            "groups": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ]
        },
        "deny": {
            "products": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ],
            "categories": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ],
            "customers": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ],
            "groups": [
                {
                    "restriction_id": "integer",
                    "name": "string"
                }
            ]
        }
    },
    "creation_date": "string",
    "creation_date_f": "string",
    "creation_date_timestamp": "integer",
    "modification_date": "string",
    "modification_date_f": "string",
    "modification_date_timestamp": "integer",
    "carrier_id": "integer"
}

Nom	Type	Description
`voucher_id`	integer	Identifiant du bon de réduction
`code`	string	Code du bon
`type`	string	Type de bon. Les valeurs possibles sont : percent, shipping, amount
`value`	float	Montant du bon
`value_label`	string	Montant du bon avec la devise
`start_date`	string	Date de début de validité
`start_date_f`	string	Date formatée de début de validité
`end_date`	string	Date de fin de validité
`end_date_f`	string	Date formatée de fin de validité
`is_enabled`	boolean	Bon actif
`stock`	integer	Nombre maximum d'utilisation possible du bon
`is_stock_unlimited`	boolean	Utilisation illimité
`quota`	integer	Nombre maximum d'utilisation du bon par un même client
`is_quota_unlimited`	boolean	Utilisation illimité par client
`used`	integer	Nombre d'utilisation actuel
`threshold`	float	Seuil d'achat
`threshold_label`	string	Seuil d'achat en pourcentage
`has_restrictions`	boolean	Bon à usage restreint
`restrictions`Facultatif	object	Restrictions
`allow`	object	Restrictions sur des produits
`products`	object	Restrictions sur des produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`categories`	object	Restrictions sur des catégories de produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`customers`	object	Restrictions sur des clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`groups`	object	Restrictions sur des groupes de clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`deny`	object	Restrictions sur des catégories de produits
`products`	object	Restrictions sur des produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`categories`	object	Restrictions sur des catégories de produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`customers`	object	Restrictions sur des clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`groups`	object	Restrictions sur des groupes de clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`creation_date`	string	Date de création
`creation_date_f`	string	Date de création formatée
`creation_date_timestamp`	integer	Timestamp de la date de création
`modification_date`Facultatif	string	Date de dernière modification
`modification_date_f`Facultatif	string	Date de dernière modification formatée
`modification_date_timestamp`Facultatif	integer	Timestamp de la date de dernière modification
`carrier_id`Facultatif	integer	Identifiant du mode de transport pour les bons frais de port offert

Modifie un bon de réduction PUT

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant du bon de réduction
`code`		string	Code du nouveau bon de réduction
`is_enabled`		boolean	Determine si le bon est actif ou non
`start_date`		Date	Date de début de validité du bon (00h01)
`end_date`		Date	Date de fin de validité du bon (23h59)
`value`		float	Montant de la remise
`threshold`		float	Seuil d'achat
`carrier_id`		integer	Identifiant unique du transporteur pour les bons de type shipping
`quota`		integer	Nombre de fois que le bon de réduction est utilisable par client
`is_quota_unlimited`		boolean	Determine si le bon de réduction est utilisable par un même client un nombre illimité de fois
`stock`		integer	Nombre de fois que le bon de réduction est utilisable sur le site
`is_stock_unlimited`		boolean	Determine si le bon de réduction est utilisable sur le site un nombre illimité de fois

Duplique un bon de réduction POST

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant du bon de réduction
`code`		string	Code du nouveau bon de réduction

Format de sortie :

Schéma JSON
Modèle

data:[]

Nom	Type	Description

Supprime un bon de réduction DELETE

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant du bon de réduction

Récupère les restrictions d'un bon de réduction GET

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}/restrictions.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant unique du bon de réduction

Format de sortie :

Schéma JSON
Modèle

data:{
    "allow": {
        "products": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ],
        "categories": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ],
        "customers": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ],
        "groups": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ]
    },
    "deny": {
        "products": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ],
        "categories": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ],
        "customers": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ],
        "groups": [
            {
                "restriction_id": "integer",
                "name": "string"
            }
        ]
    }
}

Nom	Type	Description
`allow`	object	Restrictions sur des produits
`products`	object	Restrictions sur des produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`categories`	object	Restrictions sur des catégories de produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`customers`	object	Restrictions sur des clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`groups`	object	Restrictions sur des groupes de clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`deny`	object	Restrictions sur des catégories de produits
`products`	object	Restrictions sur des produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`categories`	object	Restrictions sur des catégories de produits
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`customers`	object	Restrictions sur des clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction
`groups`	object	Restrictions sur des groupes de clients
`restriction_id`	integer	Identifiant de la restriction
`name`	string	Libellé de l'élément lié à la restriction

Applique des restrictions à un bon de réduction PUT

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}/restrictions.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant du bon de réduction
`allow_customers`		array	Identifiant unique du ou des utilisateurs à autoriser
`allow_groups`		array	Identifiant unique du ou des groupes utilisateurs à autoriser
`allow_products`		array	Identifiant unique du ou des produits auxquels le bon est applicable
`allow_categories`		array	Identifiant unique de la ou des catégories de produits pour lesquelles le bon est applicable
`deny_customers`		array	Identifiant unique du ou des utilisateurs à refuser
`deny_groups`		array	Identifiant unique du ou des groupes utilisateurs à refuser
`deny_products`		array	Identifiant unique du ou des produits pour lesquels le bon n'est pas applicable
`deny_categories`		array	Identifiant unique de la ou des catégories de produits pour lesquelles le bon n'est pas applicable

Retire les restrictions d'un bon de réduction DELETE

`/v1/sites/{code_site}/checkout/vouchers/{voucher_id}/restrictions.json`

Paramètres supportés par ce endpoint :

Nom		Type	Description
`code_site`	Obligatoire	string	Code site
`voucher_id`	Obligatoire	integer	Identifiant du bon de réduction