Commandes

Résumé

Résumé des commandes GET
/v1/sites/{code_site}/checkout.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:{
    "pending_count": "integer",
    "processing_count": "integer",
    "processed_count": "integer",
    "shipped_count": "integer",
    "cancelled_count": "integer"
}
NomTypeDescription
pending_countintegerNombre de commandes à traiter
processing_countintegerNombre de commandes en cours
processed_countintegerNombre de commandes traités
shipped_countintegerNombre de commandes expédiées
cancelled_countintegerNombre 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 :

NomTypeDescription
code_siteObligatoirestringCode site
customer_idObligatoireintegerIdentifiant du client
productsObligatoirearrayListe des produits de la commande avec les champs suivants :

Pour un produit Kiubi:
variant_idIdentifiant de la variante
quantityQuantité

Pour un produit personnalisé :
idIdentifiant personnalisé du produit
quantityQuantité
product_nameIntitulé du produit
variant_nameIntitulé de la variante
price_ex_vatPrix unitaire HT (Un prix est obligatoire, HT ou TTC)
price_inc_vatPrix unitaire TTC (Un prix est obligatoire, HT ou TTC)
price_discount_ex_vatPrix promo unitaire HT
price_discount_inc_vatPrix promo unitaire TTC
price_ecotaxMontant de l'écotaxe
vat_rateTaux de TVA
referenceRéférence
weightPoids en gramme
is_virtualProduit virtuel
file_idIdentifiant du fichier à télécharger
optionsarrayListe des options à la commande
billing_addressObligatoirearrayAdresse de facturation avec les champs suivants :
civilityCivilité
lastnameNom
firstnamePrénom
companySociété
addressAdresse
zipcodeCode postal
cityVille
country_idIdentifiant du pays
phoneTéléphone
shipping_addressarrayAdresse de livraison avec les champs suivants :
civilityCivilité
lastnameNom
firstnamePrénom
companySociété
addressAdresse
zipcodeCode postal
cityVille
country_idIdentifiant du pays
payment_idintegerIdentifiant du mode de paiement
payment_namestringIntitulé du mode de paiement
carrier_idintegerIdentifiant du transporteur
carrier_price_inc_vatfloatMontant TTC des frais de port (Un montant est obligatoire, HT ou TTC)
carrier_price_ex_vatfloatMontant HT des frais de port (Un montant est obligatoire, HT ou TTC)
carrier_vat_rateObligatoirefloatTaux de TVA des frais de port
carrier_namestringIntitulé du transporteur
scheduled_datestringDate de livraison souhaitée
scheduled_hourstringHeure de livraison souhaitée

Format de sortie :

data:[]
NomTypeDescription
Liste les commandes GET
/v1/sites/{code_site}/checkout/orders.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
statusstringStatut des commandes parmis les valeurs suivantes :
pendingÀ traiter
processingEn cours
processedTraitées
shippedExpédiées
cancelledAnnulées

Les valeurs attendues sont : pending, processing, processed, shipped, cancelled
customer_idintegerIdentifiant du client
termstringTerme recherché
is_paidbooleanCommande payée
referencestringRéférence de la commande
creation_date_minstringDate de création minimale
creation_date_maxstringDate de création maximale
payment_date_minstringDate de paiement minimale
payment_date_maxstringDate de paiement maximale
price_total_inc_vat_minfloatPrix total TTC minimal
price_total_inc_vat_maxfloatPrix total TTC maximal
price_total_ex_vat_minfloatPrix total HT minimal
price_total_ex_vat_maxfloatPrix total HT maximal
payment_idintegerIdentifiant du mode de paiement
carrier_idintegerIdentifiant du transporteur
fidelity_reward_minintegerPoints de fidélité minimal
fidelity_reward_maxintegerPoints de fidélité maximal
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
date / -dateTri selon la date de la commande
modification / -modificationTri selon la date de dernière modification de la commande
amount / -amountTri selon la montant de la commande
schedule / -scheduleTri selon la date de retrait/livraison prévue
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:[
    {
        "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",
        "use_billing_as_shipping": "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",
            "phone": "string"
        },
        "shipping_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "phone": "string"
        },
        "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"
        }
    }
]
NomTypeDescription
order_idintegerIdentifiant de la commande
referencestringRéférence de la commande
customer_idintegerIdentifiant du client
customer_emailstringEmail du client
customer_numberstringNuméro du client
ip_addressstringAdresse IP du client
reverse_hoststringReverse host de l'adresse IP
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
statusstringStatut de la commande
is_paidbooleanCommande payée
payment_idintegerIdentifiant du mode de paiement
payment_namestringIntitulé du mode de paiement
is_reintegratedbooleanCommande réintégrée
payment_dateFacultatifstringDate de paiement
payment_date_fFacultatifstringDate de paiement formatée
payment_date_timestampFacultatifintegerTimestamp de la date de paiement
price_total_inc_vatfloatPrix total avec TVA
price_total_ex_vatfloatPrix total hors TVA
price_total_inc_vat_labelFacultatifstringPrix total avec TVA avec devise
price_total_ex_vat_labelFacultatifstringPrix total hors TVA avec devise
price_vatFacultatiffloatMontant total de tva
price_items_inc_vatFacultatiffloatTotal TTC des produits du panier
price_items_ex_vatFacultatiffloatTotal HT des produits du panier
base_pricestringType de prix de base
currencystringDevise
is_tax_freebooleanExonération des taxes
commentstringCommentaire
use_billing_as_shippingbooleanAdresse de facturation et livraison identiques
shippingobjectMode de transport
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
typestringType de transporteur
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
vat_ratefloatTaux de TVA
weightintegerPoids du colis
is_freebooleanFrais de port offert
destinationstringPays de destination
picking_numberstringUrl de suivi du colis
scheduledFacultatifstringDate de planification
billing_addressobjectAdresse de facturation
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
shipping_addressobjectAdresse de livraison
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
voucherFacultatifobjectBon utilisé
codestringCode coupon
typestringType de coupon. Les valeurs possibles sont : amount, percent, shipping
amountfloatMontant du coupon
itemsFacultatifobjectListe des articles
typestringType d'article. Les valeurs possibles sont : product, voucher, custom
product_idintegerIdentifiant du produit
variant_idintegerIdentifiant de la variante
referencestringRéférence de la variante
product_namestringIntitulé du produit
variant_namestringIntitulé de la variante
quantityintegerQuantité
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_total_ex_vatFacultatiffloatPrix total hors TVA
price_total_inc_vatFacultatiffloatPrix total avec TVA
is_discountedbooleanPrix promotionnel
discountfloatMontant de la réduction
vat_ratefloatTaux de TVA
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_virtualbooleanProduit virtuel
file_idFacultatifintegerIdentifiant du fichier à télécharger pour un produit virtuel
optionsFacultatifobjectListe des options
option_idintegerIdentifiant de l'option
namestringIntitulé de l'option
quantityintegerQuantité de l'option
valueFacultatifstringValeur de l'option
vat_ratefloatTaux de TVA
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
activityFacultatifobjectHistorique de la commande
messagestringContenu du message
datestringDate de l'action
userstringNom de l'auteur
fidelity_rewardintegerGain de points de fidélité
downloadFacultatifobjectLiens de téléchargement
formstringBon de commande
xlsstringExport xls
colishipFacultatifstringExport Coliship
Liste les commandes abandonnées GET
/v1/sites/{code_site}/checkout/orders/aborted.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
date / -dateTri selon la date de la commande
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:[
    {
        "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",
        "use_billing_as_shipping": "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",
            "phone": "string"
        },
        "shipping_address": {
            "civility": "string",
            "lastname": "string",
            "firstname": "string",
            "company": "string",
            "address": "string",
            "zipcode": "string",
            "city": "string",
            "country": "string",
            "phone": "string"
        },
        "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"
        }
    }
]
NomTypeDescription
order_idintegerIdentifiant de la commande
referencestringRéférence de la commande
customer_idintegerIdentifiant du client
customer_emailstringEmail du client
customer_numberstringNuméro du client
ip_addressstringAdresse IP du client
reverse_hoststringReverse host de l'adresse IP
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
statusstringStatut de la commande
is_paidbooleanCommande payée
payment_idintegerIdentifiant du mode de paiement
payment_namestringIntitulé du mode de paiement
is_reintegratedbooleanCommande réintégrée
payment_dateFacultatifstringDate de paiement
payment_date_fFacultatifstringDate de paiement formatée
payment_date_timestampFacultatifintegerTimestamp de la date de paiement
price_total_inc_vatfloatPrix total avec TVA
price_total_ex_vatfloatPrix total hors TVA
price_total_inc_vat_labelFacultatifstringPrix total avec TVA avec devise
price_total_ex_vat_labelFacultatifstringPrix total hors TVA avec devise
price_vatFacultatiffloatMontant total de tva
price_items_inc_vatFacultatiffloatTotal TTC des produits du panier
price_items_ex_vatFacultatiffloatTotal HT des produits du panier
base_pricestringType de prix de base
currencystringDevise
is_tax_freebooleanExonération des taxes
commentstringCommentaire
use_billing_as_shippingbooleanAdresse de facturation et livraison identiques
shippingobjectMode de transport
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
typestringType de transporteur
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
vat_ratefloatTaux de TVA
weightintegerPoids du colis
is_freebooleanFrais de port offert
destinationstringPays de destination
picking_numberstringUrl de suivi du colis
scheduledFacultatifstringDate de planification
billing_addressobjectAdresse de facturation
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
shipping_addressobjectAdresse de livraison
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
voucherFacultatifobjectBon utilisé
codestringCode coupon
typestringType de coupon. Les valeurs possibles sont : amount, percent, shipping
amountfloatMontant du coupon
itemsFacultatifobjectListe des articles
typestringType d'article. Les valeurs possibles sont : product, voucher, custom
product_idintegerIdentifiant du produit
variant_idintegerIdentifiant de la variante
referencestringRéférence de la variante
product_namestringIntitulé du produit
variant_namestringIntitulé de la variante
quantityintegerQuantité
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_total_ex_vatFacultatiffloatPrix total hors TVA
price_total_inc_vatFacultatiffloatPrix total avec TVA
is_discountedbooleanPrix promotionnel
discountfloatMontant de la réduction
vat_ratefloatTaux de TVA
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_virtualbooleanProduit virtuel
file_idFacultatifintegerIdentifiant du fichier à télécharger pour un produit virtuel
optionsFacultatifobjectListe des options
option_idintegerIdentifiant de l'option
namestringIntitulé de l'option
quantityintegerQuantité de l'option
valueFacultatifstringValeur de l'option
vat_ratefloatTaux de TVA
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
activityFacultatifobjectHistorique de la commande
messagestringContenu du message
datestringDate de l'action
userstringNom de l'auteur
fidelity_rewardintegerGain de points de fidélité
downloadFacultatifobjectLiens de téléchargement
formstringBon de commande
xlsstringExport xls
colishipFacultatifstringExport Coliship
Réintègre une commande PUT
/v1/sites/{code_site}/checkout/orders/aborted/{order_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
order_idObligatoireintegerIdentifiant 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 :

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

Format de sortie :

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",
    "use_billing_as_shipping": "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",
        "phone": "string"
    },
    "shipping_address": {
        "civility": "string",
        "lastname": "string",
        "firstname": "string",
        "company": "string",
        "address": "string",
        "zipcode": "string",
        "city": "string",
        "country": "string",
        "phone": "string"
    },
    "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"
    }
}
NomTypeDescription
order_idintegerIdentifiant de la commande
referencestringRéférence de la commande
customer_idintegerIdentifiant du client
customer_emailstringEmail du client
customer_numberstringNuméro du client
ip_addressstringAdresse IP du client
reverse_hoststringReverse host de l'adresse IP
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
statusstringStatut de la commande
is_paidbooleanCommande payée
payment_idintegerIdentifiant du mode de paiement
payment_namestringIntitulé du mode de paiement
is_reintegratedbooleanCommande réintégrée
payment_dateFacultatifstringDate de paiement
payment_date_fFacultatifstringDate de paiement formatée
payment_date_timestampFacultatifintegerTimestamp de la date de paiement
price_total_inc_vatfloatPrix total avec TVA
price_total_ex_vatfloatPrix total hors TVA
price_total_inc_vat_labelFacultatifstringPrix total avec TVA avec devise
price_total_ex_vat_labelFacultatifstringPrix total hors TVA avec devise
price_vatFacultatiffloatMontant total de tva
price_items_inc_vatFacultatiffloatTotal TTC des produits du panier
price_items_ex_vatFacultatiffloatTotal HT des produits du panier
base_pricestringType de prix de base
currencystringDevise
is_tax_freebooleanExonération des taxes
commentstringCommentaire
use_billing_as_shippingbooleanAdresse de facturation et livraison identiques
shippingobjectMode de transport
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
typestringType de transporteur
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
vat_ratefloatTaux de TVA
weightintegerPoids du colis
is_freebooleanFrais de port offert
destinationstringPays de destination
picking_numberstringUrl de suivi du colis
scheduledFacultatifstringDate de planification
billing_addressobjectAdresse de facturation
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
shipping_addressobjectAdresse de livraison
civilitystringCivilité. Les valeurs possibles sont : Mr, Mrs, Miss
lastnamestringNom
firstnamestringPrénom
companystringSociété
addressstringAdresse
zipcodestringCode postal
citystringVille
countrystringPays
phoneFacultatifstringTéléphone
voucherFacultatifobjectBon utilisé
codestringCode coupon
typestringType de coupon. Les valeurs possibles sont : amount, percent, shipping
amountfloatMontant du coupon
itemsFacultatifobjectListe des articles
typestringType d'article. Les valeurs possibles sont : product, voucher, custom
product_idintegerIdentifiant du produit
variant_idintegerIdentifiant de la variante
referencestringRéférence de la variante
product_namestringIntitulé du produit
variant_namestringIntitulé de la variante
quantityintegerQuantité
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
price_total_ex_vatFacultatiffloatPrix total hors TVA
price_total_inc_vatFacultatiffloatPrix total avec TVA
is_discountedbooleanPrix promotionnel
discountfloatMontant de la réduction
vat_ratefloatTaux de TVA
price_ecotaxfloatMontant de l'éco-taxe
price_ecotax_labelFacultatifstringMontant de l'éco-taxe avec devise
is_virtualbooleanProduit virtuel
file_idFacultatifintegerIdentifiant du fichier à télécharger pour un produit virtuel
optionsFacultatifobjectListe des options
option_idintegerIdentifiant de l'option
namestringIntitulé de l'option
quantityintegerQuantité de l'option
valueFacultatifstringValeur de l'option
vat_ratefloatTaux de TVA
price_ex_vatFacultatiffloatPrix hors TVA
price_inc_vatFacultatiffloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
activityFacultatifobjectHistorique de la commande
messagestringContenu du message
datestringDate de l'action
userstringNom de l'auteur
fidelity_rewardintegerGain de points de fidélité
downloadFacultatifobjectLiens de téléchargement
formstringBon de commande
xlsstringExport xls
colishipFacultatifstringExport Coliship
Modifie une commande PUT
/v1/sites/{code_site}/checkout/orders/{order_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
order_idObligatoireintegerIdentifiant de la commande
is_paidbooleanCommande payée
statusstringStatut de la commande parmis les valeurs suivantes :
pendingÀ traiter
processingEn cours
processedTraitée
shippedExpédiée
cancelledAnnulée

Les valeurs attendues sont : pending, processing, processed, shipped, cancelled
commentstringNote sur la commande
picking_numberstringUrl du suivi de colis
notifybooleanNotification du changement d'état
Historique d'une commande GET
/v1/sites/{code_site}/checkout/orders/{order_id}/activity.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
order_idObligatoireintegerIdentifiant de la commande

Format de sortie :

data:[
    {
        "message": "string",
        "date": "string",
        "user": "string"
    }
]
NomTypeDescription
messagestringContenu du message
datestringDate de l'action
userstringNom 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 :

NomTypeDescription
code_siteObligatoirestringCode site
order_idObligatoireintegerIdentifiant de la commande
messageObligatoirestringTexte 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 :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "payment_id": "integer",
        "name": "string",
        "type": "string",
        "is_enabled": "boolean",
        "position": "integer",
        "config": "List",
        "notification_url": "string"
    }
]
NomTypeDescription
payment_idintegerIdentifiant du mode de paiement
namestringIntitulé du mode de paiement
typestringType du mode de paiement
is_enabledbooleanMode de paiement actif
positionintegerPosition dans la liste des modes de paiement
configFacultatifListDonnées de configuration
notification_urlFacultatifstringDonnées de configuration
Réordonne les modes de paiements PUT
/v1/sites/{code_site}/checkout/payments.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
orderObligatoirearrayListe 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 :

NomTypeDescription
code_siteObligatoirestringCode site
payment_idObligatoireintegerIdentifiant du mode de paiement

Format de sortie :

data:{
    "payment_id": "integer",
    "name": "string",
    "type": "string",
    "is_enabled": "boolean",
    "position": "integer",
    "config": "List",
    "notification_url": "string"
}
NomTypeDescription
payment_idintegerIdentifiant du mode de paiement
namestringIntitulé du mode de paiement
typestringType du mode de paiement
is_enabledbooleanMode de paiement actif
positionintegerPosition dans la liste des modes de paiement
configFacultatifListDonnées de configuration
notification_urlFacultatifstringDonné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 :

NomTypeDescription
code_siteObligatoirestringCode site
payment_idObligatoireintegerIdentifiant du mode de paiement
is_enabledbooleanActivation du mode de paiement
configarrayParamètres de configuration du mode de paiement.

Chèque:
ordreOrdre du libellé du chèque
intitule_longIntitulé du mode de paiement
messageMessage de confirmation

Virement :
IBANIBAN
BICBIC
rib_banqueRIB : Banque
rib_guichetRIB : Guichet
rib_compteRIB : N° de compte
rib_cleRIB : Clé
domicileDomiciliation
intitule_longIntitulé du mode de paiement
messageMessage de confirmation

Paypal :
emailEmail du compte PayPal
intitule_longIntitulé du mode de paiement
messageMessage de confirmation

Paybox :
siteNuméro du site
banqueBanque
modeMode de signature (hmac ou cgi)
hmacClé de hachage pour le mode hmac
rangRang
idIdentifiant Paybox
intitule_longIntitulé du mode de paiement
messageMessage de confirmation

CM-CIC :
tpeNuméro de TPE
societeCode société
keyClé
banqueBanque
modeMode (test ou prod)
intitule_longIntitulé du mode de paiement
messageMessage de confirmation

ATOS SIPS :
intitule_longIntitulé du mode de paiement
versionVersion du certificat
banqueBanque
certifNom du certificat
certif_payloadContenu du certificat (base64encodé)
messageMessage de confirmation
auto_returnRetour automatique au site marchand

SystemPay :
tpeIdentifiant boutique
keyCertificat
modeMode (test ou prod)
hashAlgorythme de hachage (sha1 ou sha256)
banqueBanque
intitule_longIntitulé du mode de paiement
messageMessage de confirmation

Transporteurs

Liste les transporteurs GET
/v1/sites/{code_site}/checkout/carriers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site

Format de sortie :

data:[
    {
        "carrier_id": "integer",
        "name": "string",
        "is_enabled": "boolean",
        "is_default": "boolean",
        "is_deletable": "boolean",
        "description": "string",
        "position": "integer",
        "type": "string"
    }
]
NomTypeDescription
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
is_enabledbooleanTransporteur actif
is_defaultbooleanTransporteur par défaut
is_deletablebooleanTransporteur supprimable
descriptionstringDescription du transporteur
positionintegerPosition dans la liste des transporteurs
typestringType de transporteur
Crée un transporteur POST
/v1/sites/{code_site}/checkout/carriers.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
tax_idintegerIdentifiant de la taxe
namestringIntitulé du transporteur
typestringType de transporteur
Les valeurs attendues sont : magasin, tranchespoids, local
is_enabledbooleanTransporteur actif

Format de sortie :

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",
    "use_coliship": "boolean",
    "coliship_type": "string",
    "coliship_tradername": "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"
}
NomTypeDescription
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
is_enabledbooleanTransporteur actif
is_defaultbooleanTransporteur par défaut
is_deletablebooleanTransporteur supprimable
descriptionstringDescription du transporteur
positionintegerPosition dans la liste des transporteurs
typestringType de transporteur
companyFacultatifstringNom de la société (en cas de livraison en magasin)
addressFacultatifstringAdresse (en cas de livraison en magasin)
zipcodeFacultatifstringCode postal (en cas de livraison en magasin)
cityFacultatifstringVille (en cas de livraison en magasin)
country_idFacultatifintegerIdentifiant du pays (en cas de livraison en magasin)
countryFacultatifstringNom du pays (en cas de livraison en magasin)
socolissimo_idFacultatifstringIdentifiant SoColissimo
socolissimo_secretFacultatifstringClé secrète SoColissimo
socolissimo_pickup_free_thresholdFacultatiffloatFranco de port pour les points relais
socolissimo_be_enabledFacultatifbooleanActivation de la livraison en Belgique
socolissimo_be_extraFacultatiffloatSurcoût des livraison en Belgique
use_colishipFacultatifbooleanUtilisation de Coliship (ex : INET Expéditor)
coliship_typeFacultatifstringRemise contre signature
coliship_tradernameFacultatifstringNom commercial du chargeur
tax_idFacultatifintegerIdentifiant de la taxe
thresholdFacultatiffloatSeuil d'achat minimal (HT ou TTC suivant la configuration du catalogue)
require_schedulingstringPlannification de la date de livraison
open_daysFacultatifListJours ouvrés
closed_daysFacultatifListJours de fermetures exceptionelles
limit_hourFacultatifstringHeure de bascule
scheduling_interval_minFacultatifintNombre de jour minimal avant livraison
scheduling_interval_maxFacultatifintNombre 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 :

NomTypeDescription
code_siteObligatoirestringCode site
orderObligatoirearrayListe 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 :

NomTypeDescription
code_siteObligatoirestringCode site
country_idObligatoireintegerIdentification du pays de livraison
postal_codeObligatoirestringCode postal de livraison
weightObligatoireintergerPoids en gramme
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:[
    {
        "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"
    }
]
NomTypeDescription
carrier_idintegerIdentifiant du transporteur
carrier_namestringIntitulé du transporteur
carrier_typestringType du transporteur
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
vat_ratefloatTaux de TVA
Détail d'un transporteur GET
/v1/sites/{code_site}/checkout/carriers/{carrier_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur

Format de sortie :

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",
    "use_coliship": "boolean",
    "coliship_type": "string",
    "coliship_tradername": "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"
}
NomTypeDescription
carrier_idintegerIdentifiant du transporteur
namestringIntitulé du transporteur
is_enabledbooleanTransporteur actif
is_defaultbooleanTransporteur par défaut
is_deletablebooleanTransporteur supprimable
descriptionstringDescription du transporteur
positionintegerPosition dans la liste des transporteurs
typestringType de transporteur
companyFacultatifstringNom de la société (en cas de livraison en magasin)
addressFacultatifstringAdresse (en cas de livraison en magasin)
zipcodeFacultatifstringCode postal (en cas de livraison en magasin)
cityFacultatifstringVille (en cas de livraison en magasin)
country_idFacultatifintegerIdentifiant du pays (en cas de livraison en magasin)
countryFacultatifstringNom du pays (en cas de livraison en magasin)
socolissimo_idFacultatifstringIdentifiant SoColissimo
socolissimo_secretFacultatifstringClé secrète SoColissimo
socolissimo_pickup_free_thresholdFacultatiffloatFranco de port pour les points relais
socolissimo_be_enabledFacultatifbooleanActivation de la livraison en Belgique
socolissimo_be_extraFacultatiffloatSurcoût des livraison en Belgique
use_colishipFacultatifbooleanUtilisation de Coliship (ex : INET Expéditor)
coliship_typeFacultatifstringRemise contre signature
coliship_tradernameFacultatifstringNom commercial du chargeur
tax_idFacultatifintegerIdentifiant de la taxe
thresholdFacultatiffloatSeuil d'achat minimal (HT ou TTC suivant la configuration du catalogue)
require_schedulingstringPlannification de la date de livraison
open_daysFacultatifListJours ouvrés
closed_daysFacultatifListJours de fermetures exceptionelles
limit_hourFacultatifstringHeure de bascule
scheduling_interval_minFacultatifintNombre de jour minimal avant livraison
scheduling_interval_maxFacultatifintNombre 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
namestringIntitulé du transporteur
descriptionstringDescription du transporteur
thresholdfloatSeuil d'achat minimal (HT ou TTC suivant la configuration du catalogue)
is_enabledbooleanTransporteur actif
is_defaultbooleanTransporteur par défaut
tax_idintegerIdentifiant de la taxe
socolissimo_idstringIdentifiant SoColissimo
socolissimo_secretstringClé secrète SoColissimo
socolissimo_pickup_free_thresholdfloatFranco de port pour les points relais
socolissimo_be_enabledbooleanActivation de la livraison en Belgique
socolissimo_be_extrafloatSurcoût des livraison en Belgique
coliship_typestringRemise contre signature
coliship_tradernamestringNom commercial du chargeur
use_colishipbooleanUtilisation de Coliship (ex : INET Expéditor)
companystringNom de la société (en cas de livraison en magasin)
addressstringAdresse (en cas de livraison en magasin)
zipcodestringCode postal (en cas de livraison en magasin)
citystringVille (en cas de livraison en magasin)
country_idintegerIdentifiant du pays (en cas de livraison en magasin)
require_schedulingstringPlannification de la date de livraison
closed_daysarrayJours de fermetures exceptionelles
limit_hourstringHeure de bascule
scheduling_interval_minintegerNombre de jour minimal avant livraison
scheduling_interval_maxintegerNombre de jour maximal pour la livraison
open_daysarrayJours ouvrés
Supprime un transporteur DELETE
/v1/sites/{code_site}/checkout/carriers/{carrier_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
all_countriesListe tous les pays, même ceux qui n'ont pas de tranches

Format de sortie :

data:[
    {
        "country_id": "integer",
        "code": "string",
        "name": "string",
        "count": "integer"
    }
]
NomTypeDescription
country_idintegerIdentifiant du pays
codestringCode ISO du pays
namestringNom du pays
countintegerNombre 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
country_idObligatoireintegerIdentifiant du pays
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:{
    "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"
        }
    ]
}
NomTypeDescription
country_idintegerIdentifiant du pays
free_thresholdFacultatiffloat
delayFacultatifstring
stepsobject
weightintegerPoids
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
country_idObligatoireintegerIdentifiant du pays
free_thresholdfloatFranco de port
delaystringDélai de livraison
stepsarrayTranches 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
country_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
scheduled_dateObligatoirestringDate de livraison souhaitée
scheduled_hourstringHeure 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur

Format de sortie :

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"
            }
        ]
    }
]
NomTypeDescription
zone_idintegerIdentifiant de la zone
postal_codesListCodes postaux de la zone
free_thresholdFacultatiffloatFranco de port
stepsFacultatifobject
weightintegerPoids
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
postal_codesarrayListe des codes postaux
free_thresholdfloatFranco de port

Format de sortie :

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"
        }
    ]
}
NomTypeDescription
zone_idintegerIdentifiant de la zone
postal_codesListCodes postaux de la zone
free_thresholdFacultatiffloatFranco de port
stepsFacultatifobject
weightintegerPoids
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
zone_idObligatoireintegerIdentifiant de la zone
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:{
    "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"
        }
    ]
}
NomTypeDescription
zone_idintegerIdentifiant de la zone
postal_codesListCodes postaux de la zone
free_thresholdFacultatiffloatFranco de port
stepsFacultatifobject
weightintegerPoids
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
zone_idObligatoireintegerIdentifiant de la zone
free_thresholdfloatFranco de port
postal_codesarrayCodes postaux
stepsarrayTranches 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 :

NomTypeDescription
code_siteObligatoirestringCode site
carrier_idObligatoireintegerIdentifiant du transporteur
zone_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:[
    {
        "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"
    }
]
NomTypeDescription
option_idintegerIdentifiant de l'option
namestringIntitulé de l'option
descriptionstringDescription de l'option
is_enabledbooleanAffichage de l'option
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
valuesobjectListe des choix pour une option de type select
positionintegerPosition dans la liste des options
creation_datestringDate de création
modification_dateFacultatifstringDate de dernière modification
Ajoute une option à la commande POST
/v1/sites/{code_site}/checkout/options.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
typeObligatoirestringType d'option :
simpleSimple
textareaZone de texte
selectListe déroulante

Les valeurs attendues sont : simple, textarea, select
namestringLibellé de l'option
descriptionstringDescription de l'option
is_enabledbooleanAffichage de l'option
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix HT de l'option
price_inc_vatfloatPrix TTC de l'option
valuesarrayValeurs possible pour une option de type liste déroulante

Format de sortie :

data:[]
NomTypeDescription
Réordonne les options à la commande PUT
/v1/sites/{code_site}/checkout/options.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
orderObligatoirearrayListe 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 :

NomTypeDescription
code_siteObligatoirestringCode site
option_idObligatoireintegerIdentifiant de l'option
extra_fieldsarrayInclut des données supplémentaires à la réponse, parmis les suivantes :
price_labelLabel des prix dans la devise du site

Format de sortie :

data:{
    "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"
}
NomTypeDescription
option_idintegerIdentifiant de l'option
namestringIntitulé de l'option
descriptionstringDescription de l'option
is_enabledbooleanAffichage de l'option
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix hors TVA
price_inc_vatfloatPrix avec TVA
price_ex_vat_labelFacultatifstringPrix hors TVA avec devise
price_inc_vat_labelFacultatifstringPrix avec TVA avec devise
typestringType d'option. Les valeurs possibles sont : simple, textarea, select
valuesobjectListe des choix pour une option de type select
positionintegerPosition dans la liste des options
creation_datestringDate de création
modification_dateFacultatifstringDate 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 :

NomTypeDescription
code_siteObligatoirestringCode site
option_idObligatoireintegerIdentifiant de l'option
namestringLibellé de l'option
descriptionstringDescription de l'option
is_enabledbooleanAffichage de l'option
tax_idintegerIdentifiant de la taxe
price_ex_vatfloatPrix HT de l'option
price_inc_vatfloatPrix TTC de l'option
valuesarrayValeurs 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 :

NomTypeDescription
code_siteObligatoirestringCode site
option_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
termstringRecherche par intitulé
typestringType de remise
Les valeurs attendues sont : amount, percent, shipping
value_minfloatValeur minimale
value_maxfloatValeur maximale
is_enabledbooleanActif
start_date_minstringDate de début de validité minimale
start_date_maxstringDate de début de validité maximale
end_date_minstringDate de fin de validité minimale
end_date_maxstringDate de fin de validité maximale
limitintegerNombre d'éléments par page (valeur par défaut : 20, maximum : 20)
pageintegerNuméro de la page à récupérer. La numérotation démarre à 0 (valeur par défaut)
sortarrayOrdres de tri parmis les critères suivants :
code / -codeTri selon le code du bon
start_date / -start_dateTri selon la date de début de validité du bon
end_date / -end_dateTri selon la date de fin de validité du bon

Format de sortie :

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",
        "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"
    }
]
NomTypeDescription
voucher_idintegerIdentifiant du bon de réduction
codestringCode du bon
typestringType de bon. Les valeurs possibles sont : percent, shipping, amount
valuefloatMontant du bon
value_labelstringMontant du bon avec la devise
start_datestringDate de début de validité
start_date_fstringDate formatée de début de validité
end_datestringDate de fin de validité
end_date_fstringDate formatée de fin de validité
is_enabledbooleanBon actif
stockintegerNombre d'utilisation possible du bon
is_stock_unlimitedbooleanUtilisation illimité
quotaintegerNombre d'utilisation du bon par un même client
is_quota_unlimitedbooleanUtilisation illimité par client
thresholdfloatSeuil d'achat
threshold_labelstringSeuil d'achat en pourcentage
has_restrictionsbooleanBon à usage restreint
restrictionsFacultatifobjectRestrictions
allowobjectRestrictions sur des produits
productsobjectRestrictions sur des produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
categoriesobjectRestrictions sur des catégories de produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
customersobjectRestrictions sur des clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
groupsobjectRestrictions sur des groupes de clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
denyobjectRestrictions sur des catégories de produits
productsobjectRestrictions sur des produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
categoriesobjectRestrictions sur des catégories de produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
customersobjectRestrictions sur des clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
groupsobjectRestrictions sur des groupes de clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
carrier_idFacultatifintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
codestringCode du nouveau bon de réduction
typestringType du bon de réduction
Les valeurs attendues sont : amount, percent, shipping
is_enabledObligatoirebooleanDetermine si le bon est actif ou non
start_dateObligatoireDateDate de début de validité du bon (00h01)
end_dateObligatoireDateDate de fin de validité du bon (23h59)
valueObligatoirefloatMontant de la remise
thresholdObligatoirefloatSeuil d'achat
carrier_idintegerIdentifiant unique du transporteur pour les bons de type shipping
quotaObligatoireintegerNombre de fois que le bon de réduction est utilisable par client
is_quota_unlimitedObligatoirebooleanDetermine si le bon de réduction est utilisable par un même client un nombre illimité de fois
stockObligatoireintegerNombre de fois que le bon de réduction est utilisable sur le site
is_stock_unlimitedObligatoirebooleanDetermine si le bon de réduction est utilisable sur le site un nombre illimité de fois

Format de sortie :

data:[]
NomTypeDescription
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 :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant unique du bon de réduction

Format de sortie :

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",
    "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"
}
NomTypeDescription
voucher_idintegerIdentifiant du bon de réduction
codestringCode du bon
typestringType de bon. Les valeurs possibles sont : percent, shipping, amount
valuefloatMontant du bon
value_labelstringMontant du bon avec la devise
start_datestringDate de début de validité
start_date_fstringDate formatée de début de validité
end_datestringDate de fin de validité
end_date_fstringDate formatée de fin de validité
is_enabledbooleanBon actif
stockintegerNombre d'utilisation possible du bon
is_stock_unlimitedbooleanUtilisation illimité
quotaintegerNombre d'utilisation du bon par un même client
is_quota_unlimitedbooleanUtilisation illimité par client
thresholdfloatSeuil d'achat
threshold_labelstringSeuil d'achat en pourcentage
has_restrictionsbooleanBon à usage restreint
restrictionsFacultatifobjectRestrictions
allowobjectRestrictions sur des produits
productsobjectRestrictions sur des produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
categoriesobjectRestrictions sur des catégories de produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
customersobjectRestrictions sur des clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
groupsobjectRestrictions sur des groupes de clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
denyobjectRestrictions sur des catégories de produits
productsobjectRestrictions sur des produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
categoriesobjectRestrictions sur des catégories de produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
customersobjectRestrictions sur des clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
groupsobjectRestrictions sur des groupes de clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
creation_datestringDate de création
creation_date_fstringDate de création formatée
creation_date_timestampintegerTimestamp de la date de création
modification_dateFacultatifstringDate de dernière modification
modification_date_fFacultatifstringDate de dernière modification formatée
modification_date_timestampFacultatifintegerTimestamp de la date de dernière modification
carrier_idFacultatifintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant du bon de réduction
codestringCode du nouveau bon de réduction
is_enabledbooleanDetermine si le bon est actif ou non
start_dateDateDate de début de validité du bon (00h01)
end_dateDateDate de fin de validité du bon (23h59)
valuefloatMontant de la remise
thresholdfloatSeuil d'achat
carrier_idintegerIdentifiant unique du transporteur pour les bons de type shipping
quotaintegerNombre de fois que le bon de réduction est utilisable par client
is_quota_unlimitedbooleanDetermine si le bon de réduction est utilisable par un même client un nombre illimité de fois
stockintegerNombre de fois que le bon de réduction est utilisable sur le site
is_stock_unlimitedbooleanDetermine 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 :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant du bon de réduction
codestringCode du nouveau bon de réduction

Format de sortie :

data:[]
NomTypeDescription
Supprime un bon de réduction DELETE
/v1/sites/{code_site}/checkout/vouchers/{voucher_id}.json

Paramètres supportés par ce endpoint :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant unique du bon de réduction

Format de sortie :

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"
            }
        ]
    }
}
NomTypeDescription
allowobjectRestrictions sur des produits
productsobjectRestrictions sur des produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
categoriesobjectRestrictions sur des catégories de produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
customersobjectRestrictions sur des clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
groupsobjectRestrictions sur des groupes de clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
denyobjectRestrictions sur des catégories de produits
productsobjectRestrictions sur des produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
categoriesobjectRestrictions sur des catégories de produits
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
customersobjectRestrictions sur des clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé de l'élément lié à la restriction
groupsobjectRestrictions sur des groupes de clients
restriction_idintegerIdentifiant de la restriction
namestringLibellé 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 :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant du bon de réduction
allow_customersarrayIdentifiant unique du ou des utilisateurs à autoriser
allow_groupsarrayIdentifiant unique du ou des groupes utilisateurs à autoriser
allow_productsarrayIdentifiant unique du ou des produits auxquels le bon est applicable
allow_categoriesarrayIdentifiant unique de la ou des catégories de produits pour lesquelles le bon est applicable
deny_customersarrayIdentifiant unique du ou des utilisateurs à refuser
deny_groupsarrayIdentifiant unique du ou des groupes utilisateurs à refuser
deny_productsarrayIdentifiant unique du ou des produits pour lesquels le bon n'est pas applicable
deny_categoriesarrayIdentifiant 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 :

NomTypeDescription
code_siteObligatoirestringCode site
voucher_idObligatoireintegerIdentifiant du bon de réduction