Stripe Home Delivery Node JS Addon

Introduction

In this tutorial, we will be exploring the Stripe Home Delivery Node.js Addon, a powerful tool that allows you to integrate home delivery functionality into your Stripe-powered e-commerce platform. With this addon, you can offer a seamless home delivery experience to your customers, allowing them to choose a delivery time and location that suits them best. In this tutorial, we will cover the step-by-step process of setting up and using the Stripe Home Delivery Node.js Addon.

Step 1: Setting up the Stripe Home Delivery Addon

To start using the Stripe Home Delivery Addon, you will need to follow these steps:

1. Install the addon by running the following command in your terminal:

   npm install stripe-home-delivery

2. Import the addon in your Node.js file:

   const StripeHomeDelivery = require('stripe-home-delivery');

3. Initialize the addon by providing your Stripe API key:

   const shd = new StripeHomeDelivery('YOUR_STRIPE_API_KEY');

   Step 2: Configuring the Home Delivery Settings

To configure the home delivery settings, you will need to create a settings object and pass it to the addon. This object should contain the following properties:

• delivery_windows: An array of objects that define the available delivery windows. Each object should have the following properties:
  • start: The start time of the delivery window (in 24-hour format).
  • end: The end time of the delivery window (in 24-hour format).
• delivery_areas: An array of objects that define the available delivery areas. Each object should have the following properties:
  • name: The name of the delivery area (e.g. "My City").
  • lat: The latitude of the delivery area.
  • lng: The longitude of the delivery area.
• minimum_distance: The minimum distance between the customer's location and the delivery area (in meters).
• delivery_fee: The delivery fee (in currency units).
• time_window_resolution: The time window resolution (in minutes).

Here is an example settings object:

const settings = {
  delivery_windows: [
    { start: '09:00', end: '18:00' },
    { start: '18:00', end: '20:00' }
  ],
  delivery_areas: [
    { name: 'My City', lat: 37.7749, lng: -122.4194 },
    { name: 'My Suburb', lat: 37.7858, lng: -122.4364 }
  ],
  minimum_distance: 500,
  delivery_fee: 10,
  time_window_resolution: 30
};

Pass the settings object to the addon by calling the configure method:

shd.configure(settings);

Step 3: Creating a Home Delivery Order

To create a home delivery order, you will need to call the createOrder method and pass the following parameters:

• customer_email: The email address of the customer.
• customer_phone: The phone number of the customer.
• order_items: An array of objects that define the order items. Each object should have the following properties:
  • name: The name of the item.
  • price: The price of the item (in currency units).
  • quantity: The quantity of the item.
• delivery_window: The ID of the delivery window chosen by the customer.
• delivery_area: The ID of the delivery area chosen by the customer.

Here is an example code snippet:

const customer_email = 'customer@example.com';
const customer_phone = '0123456789';
const order_items = [
  { name: 'Product 1', price: 10, quantity: 2 },
  { name: 'Product 2', price: 20, quantity: 1 }
];
const delivery_window = 'window_1';
const delivery_area = 'area_1';

shd.createOrder(customer_email, customer_phone, order_items, delivery_window, delivery_area, (err, order) => {
  if (err) {
    console.error(err);
  } else {
    console.log(order);
  }
});

Step 4: Retrieving a Home Delivery Order

To retrieve a home delivery order, you will need to call the getOrder method and pass the order ID. Here is an example code snippet:

const orderId = 'order_123';
shd.getOrder(orderId, (err, order) => {
  if (err) {
    console.error(err);
  } else {
    console.log(order);
  }
});

Step 5: Updating a Home Delivery Order

To update a home delivery order, you will need to call the updateOrder method and pass the order ID and the updated order data. Here is an example code snippet:

const orderId = 'order_123';
const updated_order = {
  customer_phone: '0987654321',
  delivery_window: 'window_2',
  delivery_area: 'area_2'
};
shd.updateOrder(orderId, updated_order, (err, order) => {
  if (err) {
    console.error(err);
  } else {
    console.log(order);
  }
});

Step 6: Canceling a Home Delivery Order

To cancel a home delivery order, you will need to call the cancelOrder method and pass the order ID. Here is an example code snippet:

const orderId = 'order_123';
shd.cancelOrder(orderId, (err, order) => {
  if (err) {
    console.error(err);
  } else {
    console.log(order);
  }
});

That's it! With these steps, you should now have a complete understanding of how to use the Stripe Home Delivery Node.js Addon. You can now integrate home delivery functionality into your Stripe-powered e-commerce platform and provide a seamless experience to your customers.