Personnaliser dynamiquement les options d'expédition

Actualisez les options de livraison en fonction de l'adresse de livraison du client.

Découvrez comment mettre à jour automatiquement les options de livraison en fonction de l’adresse que votre client saisit dans Checkout.

Cas d’utilisation

Valider une adresse : Confirmez si vous pouvez expédier un produit à l’adresse d’un client en utilisant vos propres règles de validation personnalisées. Vous pouvez également créer une interface utilisateur personnalisée permettant aux clients de confirmer leur adresse préférée.
Afficher les options de livraison pertinentes : Affichez uniquement les modes de livraison disponibles, en fonction de l’adresse du client. Par exemple, proposez la livraison le lendemain uniquement pour les adresses dans votre pays.
Calculer de manière dynamique les frais de livraison : Calculez et affichez les frais de livraison en fonction de l’adresse de livraison du client.
Mettre à jour les frais de livraison en fonction du montant total de la commande : Proposez des frais de livraison basés sur l’adresse de livraison ou le montant total de la commande (par exemple, la livraison gratuite pour les commandes supérieures à 100 USD). Pour les paiements autorisant les changements de quantité ou les ventes croisées, consultez la page Mise à jour dynamique des postes.

Limitations

Uniquement pris en charge en mode paiement. Les frais de livraison ne sont pas disponibles en mode abonnement.
Ne prend pas en charge les mises à jour en réponse à des modifications apportées en dehors de la page de paiement.

Créer une session Checkout
Côté serveur

Sur votre serveur, créez une session Checkout.

Définissez le champ ui_mode sur embedded.
Définissez le champ permissions.update_shipping_details sur server_only.
Définissez le champ shipping_address_collection.allowed_countries sur la liste des pays auxquels vous souhaitez offrir des services de livraison.
Définissez l’attribut shipping_options.shipping_rate_data qui crée des frais de livraison fictifs avec un montant de 0 USD.

Par défaut, le client Stripe Checkout met automatiquement à jour le champ shipping_details de l’objet Checkout Session avec les informations d’expédition saisies par le client, y compris son nom et son adresse.

Avertissement

Lorsque le champ permissions.update_shipping_details est défini sur server_only, la mise à jour automatique côté client est désactivée et seul votre serveur peut mettre à jour les informations d’expédition à l’aide de votre clé secrète Stripe.

Personnaliser les options d'expédition
Côté serveur

À partir de votre serveur, créez un nouvel endpoint pour calculer les options d’expédition en fonction de l’adresse de livraison du client.

Récupérer la session Checkout en utilisant l’identifiant checkoutSessionId` du corps de la demande.
Validez les informations de livraison du client fournies dans le corps de la demande.
Calculez les options d’expédition en fonction de l’adresse de livraison du client et des articles de la session Checkout.
Modifiez la session Checkout avec les shipping_details et les shipping_options du client.

Sélectionner une langueRuby
Python
PHP
Node.js
.NET
Go
Java
 No results
require 'sinatra'
require 'json'
require 'stripe'

set :port, 4242

# Set your secret key. Remember to switch to your live secret key in production!
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = "sk_test_BQokikJOvBiI2HlWgH4olfQ2"


# Return a boolean indicating whether the shipping details are valid
def validate_shipping_details(shipping_details)
  # TODO: Remove error and implement...
  raise NotImplementedError.new(<<~MSG)
    Validate the shipping details the customer has entered.
  MSG
end

# Return an array of the updated shipping options or the original options if no update is needed
def calculate_shipping_options(shipping_details, session)
  # TODO: Remove error and implement...
  raise NotImplementedError.new(<<~MSG)
    Calculate shipping options based on the customer's shipping details and the
    Checkout Session's line items.
  MSG
end

post '/calculate-shipping-options' do
  content_type :json
  request.body.rewind
  request_data = JSON.parse(request.body.read)

  checkout_session_id = request_data['checkout_session_id']
  shipping_details = request_data['shipping_details']

  # 1. Retrieve the Checkout Session
  session = Stripe::Checkout::Session.retrieve(checkout_session_id)

  # 2. Validate the shipping details
  if !validate_shipping_details(shipping_details)
    return { type: 'error', message: "We can't ship to your address. Please choose a different address." }.to_json
  end

  # 3. Calculate the shipping options
  shipping_options = calculate_shipping_options(shipping_details, session)

  # 4. Update the Checkout Session with the customer's shipping details and shipping options
  if shipping_options
    Stripe::Checkout::Session.update(checkout_session_id, {
      collected_information: { shipping_details: shipping_details },
      shipping_options: shipping_options
    })

    return { type: 'object', value: { succeeded: true } }.to_json
  else
    return { type: 'error', message: "We can't find shipping options. Please try again." }.to_json
  end
end

Monter Checkout
Côté client

Checkout est disponible dans Stripe.js. Intégrez le script Stripe.js à votre page en l’ajoutant à l’en-tête de votre fichier HTML. Ensuite, créez un nœud DOM vide (conteneur) à utiliser pour le montage.

index.html
<head>
  <script src="https://js.stripe.com/basil/stripe.js"></script>
</head>
<body>
  <div id="checkout">
    <!-- Checkout will insert the payment form here -->
  </div>
</body>

Initialisez Stripe.js avec votre clé API publique.

index.js
// Set your publishable key: remember to change this to your live publishable key in production
// See your keys here: https://dashboard.stripe.com/apikeys
const stripe = Stripe('pk_test_TYooMQauvdEDq54NiTphI7jx'
);

Créez une fonction fetchClientSecret asynchrone qui demande à votre serveur de créer la session Checkout et de récupérer la clé secrète du client.

Créez une fonction asynchrone onShippingDetailsChange qui envoie une requête à votre serveur pour calculer les options d’expédition en fonction de l’adresse de livraison du client. Stripe Checkout appelle la fonction lorsque le client remplit le formulaire avec les informations de livraison.

index.js
initialize();

async function initialize() {
  // Fetch Checkout Session and retrieve the client secret
  const fetchClientSecret = async () => {
    const response = await fetch("/create-checkout-session", {
      method: "POST",
    });
    const { clientSecret } = await response.json();
    return clientSecret;
  };

  // Call your backend to set shipping options
  const onShippingDetailsChange = async (shippingDetailsChangeEvent) => {
    const {checkoutSessionId, shippingDetails} = shippingDetailsChangeEvent;
    const response = await fetch("/calculate-shipping-options", {
      method: "POST",
      body: JSON.stringify({
        checkout_session_id: checkoutSessionId,
        shipping_details: shippingDetails,
      })
    })

    if (response.type === 'error') {
      return Promise.resolve({type: "reject", errorMessage: response.message});
    } else {
      return Promise.resolve({type: "accept"});
    }
  };

  // Initialize Checkout
  const checkout = await stripe.initEmbeddedCheckout({
    fetchClientSecret,
    onShippingDetailsChange,
  });

  // Mount Checkout
  checkout.mount('#checkout');
}

Mise en garde

Renvoyez toujours une Promise à partir de votre fonction onShippingDetailsChange et résolvez-la avec un objet ResultAction.

Le client Checkout met à jour l’interface utilisateur en fonction du résultat de la fonction onShippingDetailsChange.

Lorsque le résultat présente type: "accept", l’interface utilisateur de Checkout affiche les options d’expédition que vous avez définies sur votre serveur.
Lorsque le résultat est type: "reject", l’interface utilisateur de Checkout affiche le message d’erreur que vous avez défini dans le résultat.

Si vous le souhaitez, vous pouvez écouter onShippingDetailsChange et créer une interface utilisateur personnalisée permettant aux clients de sélectionner et de confirmer leur adresse préférée parmi plusieurs adresses possibles.

Checkout s’affiche dans un iframe qui envoie de manière sécurisée les informations de paiement à Stripe via une connexion HTTPS.

Erreur fréquente

Évitez de placer Checkout dans un autre iframe, car certains moyens de paiement nécessitent une redirection vers une autre page pour la confirmation du paiement.

Tester l'intégration

Suivez ces étapes pour tester votre intégration et vous assurer que vos options de livraison personnalisées fonctionnent correctement.

Configurez un environnement de test qui reflète votre configuration en mode production. Utilisez les clés API d’environnement de test Stripe pour cet environnement.
Simulez différentes adresses de livraison pour vérifier que votre fonction calculateShippingOptions traite correctement les différents scénarios.
Vérifiez la logique côté serveur en utilisant des outils de journalisation ou de débogage pour confirmer que votre serveur :
- Récupère la session Checkout.
- Valide les informations de livraison.
- Calcule les options de livraison.
- Ajoute de nouvelles informations et options de livraison à la session Checkout. Assurez-vous que la réponse de modification contient les nouvelles informations et options d’expédition.
Vérifiez la logique côté client en effectuant plusieurs fois le processus de paiement dans votre navigateur. Observez la façon dont l’interface utilisateur se met à jour après avoir saisi les informations de l’expédition. Vérifiez que :
- La fonction onShippingDetailsChange est appelée comme prévu.
- Les options de livraison sont correctement mises à jour en fonction de l’adresse fournie.
- Les messages d’erreur s’affichent correctement lorsque l’expédition n’est pas disponible.
Saisissez des adresses de livraison non valides ou simulez des erreurs de serveur pour tester la gestion des erreurs, côté serveur et côté client.