Airalo Developer Platform
  1. WOOCOMMERCE PLUGIN
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Go live checklist
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Submit order
        • Submit order async
        • Future orders
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • Submit top-up order
        • Get top-up package list
        • Get eSIMs list
        • Get eSIM package history
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
        • Future Orders
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks opt-in and flow
        • Webhooks guide
        • Webhook definition
        • Notification: Low data
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Credit limit
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Async orders
          • Opt in
          • Get notification details
          • Opt out
        • Webhook simulator
      • Check balance
        • Get balance
      • Request refund
        • Request refund
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. WOOCOMMERCE PLUGIN

Introduction

The Airalo Plugin for WooCommerce is designed to seamlessly sync eSIM packages from our platform to your WooCommerce store and handle order submissions automatically. This plugin simplifies the management of eSIM products and ensures smooth communication between your WooCommerce store and our backend services.

Features#

Product synchronization: Automatically sync Airalo eSIM packages from our platform to your WooCommerce store, keeping your product listings up to date.
Order submission: Once an order is paid, the plugin submits the order details to our Partner REST API endpoint, ensuring efficient processing and fulfillment.
Easy configuration: Set up credentials and configure product sync options within the WooCommerce admin panel, making the integration process straightforward and user-friendly.

Account creation#

We’ll onboard you onto the Airalo Partner Platform to give you access to the API credentials needed for the Airalo WooCommerce Plugin.
Once your company is created, you’ll receive an email to set up your password. This will enable you to sign in to the Airalo Partner Platform and securely retrieve your API credentials.

Usage#

Install the plugin: Install the plugin from the WordPress Plugin Store.
Configure credentials: Navigate to the plugin settings and enter your Airalo Partner API credentials to establish a connection with our platform.
Configure product sync options: Set up synchronization preferences to control how Airalo eSIM packages are imported and displayed in your WooCommerce store.
Automatic order handling: The plugin will automatically handle order submissions to our Partner REST API endpoint when an order is marked as paid.

My eSIMs page#

The My eSIMs page provides an overview of eSIMs purchased by your customers if they are registered in your shop.
Your users can access their eSIMs, view installation instructions along with the QR code and all relevant details (including direct installation when accessing from iOS 17+), and monitor their eSIM data usage at any time.
To implement the My eSIMs page, you need to create a new page in WordPress and insert the provided shortcode [airalo_woocommerce_my_esim]. The plugin takes care of the rest. Once you have saved and published your new page, you can add it to your menu to make it visible to your customers. This page can also be referenced in your WooCommerce email templates.

Server requirements#

As suggested by the WooCommerce team below are the minimum server requirements for having the plugin run efficiently:
WordPress version 6.3 or great.
PHP version 7.4 or greater.
MySQL version 5.67 or greater OR MariaDB version 10.4 or greater.
WordPress memory limit of 256 MB or greater.
HTTPS support.
You can refer to their Server Requirements page for more in-depth details.
Modified at 2025-09-02 15:04:53
Previous
Technical notes
Next
How to install the Airalo Plugin for WooCommerce
Built with