Notre objet paiement dispose d'un variable shipping_info permettant de spécifier un ensemble de valeurs relatives à la livraison de vos commandes au format JSON.

Usage

En conformité avec nos CGV, cette fonctionnalité permet au marchand de partager des informations à propos de l'expedition et de la livraison des commandes payées avec la solution de paiement Alma.

Données

Données de livraison de base

Notre API peut récupérer les données:

Sélectionnées par le client lors de la création de commande
Proposées au client lors de la création de la commande

Dans les deux cas, les données sont représentées par un objet qui contient ces propriétés

Property	Type	Is Required	Description
title	String	REQUIRED	Title of the selected shipping method
amount	Number	REQUIRED	Shipping & handling fee, in cents
carrier	String	OPTIONAL	Name of shipping company
express_delivery	Boolean	OPTIONAL	Whether it's an express delivery (e.g. next-day delivery)
pickup_delivery	Boolean	OPTIONAL	Whether it's a pick-up & go delivery (e.g. Mondial Relay, Relais Colis, ...)

Données de livraison complètes

De manière plus complète, l'API de création de paiement peut recevoir une propriété shipping_info sous la forme suivante :

Property	Type	Is Required	Description
payment.shipping_info	Object	OPTIONAL	Shipping information for the purchase
payment.shipping_info.selected_options	Array	OPTIONAL	A list of shipping info objects selected by the customer
payment.shipping_info.available_options	Array	OPTIONAL	A list of shipping info objects representing the different shipping options the customer was presented for this payment
payment.shipping_info.tracking_id	String	REQUIRED	Tracking ID for the shipment
payment.shipping_info.tracking_url	String	OPTIONAL	Tracking URL for the shipment
payment.shipping_info.is_multi_shipping	Boolean	OPTIONAL	true if the order used a multishipping feature (i.e. several shipping addresses). If not filled, this property will automatically be set to true if `payment.shipping_info.selected_options` is containing multiple objects.
payment.shipping_info.multi_shipping_info	Object	OPTIONAL	A free-form object containing information about the multishipping shipping options

Examples

For a single selected shipping option

{
    "payment": {
        "purchase_amount": 50000,
        "installments_count": 3,
        ...
        "shipping_info": {
            "selected_options": [
                {
                    "title": "Colissimo suivi",
                    "carrier": "La Poste",
                    "amount": 590,
                    "express_delivery": false,
                    "pickup_delivery": false
                }
            ],
            "available_options": [
                {
                    "title": "Colissimo suivi",
                    "carrier": "La Poste",
                    "amount": 590,
                    "express_delivery": false,
                    "pickup_delivery": false
                },
                {
                    "title": "J+1 avant 13h",
                    "carrier": "Chronopost",
                    "amount": 1170,
                    "express_delivery": false,
                    "pickup_delivery": false
                },
                {
                    "title": "Livraison en point relais",
                    "carrier": "MondialRelay",
                    "amount": 350,
                    "express_delivery": false,
                    "pickup_delivery": true
                }
            ],
            "is_multi_shipping": false,
            "multi_shipping_info": {}
        }
    },
}

For multi selected shipping option

{
    "payment": {
        "purchase_amount": 50000,
        "installments_count": 3,
        ...
        "shipping_info": {
            "selected_options": [
                {
                    "title": "Colissimo suivi",
                    "carrier": "La Poste",
                    "amount": 590,
                    "express_delivery": false,
                    "pickup_delivery": false
                },
                {
                    "title": "Livraison en point relais",
                    "carrier": "MondialRelay",
                    "amount": 350,
                    "express_delivery": false,
                    "pickup_delivery": true
                }
            ],
            "available_options": [
                {
                    "title": "Colissimo suivi",
                    "carrier": "La Poste",
                    "amount": 590,
                    "express_delivery": false,
                    "pickup_delivery": false
                },
                {
                    "title": "J+1 avant 13h",
                    "carrier": "Chronopost",
                    "amount": 1170,
                    "express_delivery": false,
                    "pickup_delivery": false
                },
                {
                    "title": "Livraison en point relais",
                    "carrier": "MondialRelay",
                    "amount": 350,
                    "express_delivery": false,
                    "pickup_delivery": true
                }
            ],
            "is_multi_shipping": true
        }
    },
}

👍
Ces informations de livraisons sont également éditables via le endpoint POST /v1/payment/<payment_id>si vous n'avez pas toutes les données nécessaires lors de la création de paiement.

Usage

Données

Données de livraison de base

Données de livraison complètes

Examples

Ces informations de livraisons sont également éditables via le endpoint POST /v1/payment/<payment_id>si vous n'avez pas toutes les données nécessaires lors de la création de paiement.

Ces informations de livraisons sont également éditables via le endpoint `POST` `/v1/payment/<payment_id>`si vous n'avez pas toutes les données nécessaires lors de la création de paiement.