Airalo Developer Platform
  1. Guides
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. Guides

How to install the Airalo Plugin for WooCommerce

Follow these steps to install and configure the Airalo Plugin for WooCommerce.

Install and activate the plugin#

Log in to WordPress.
Navigate to the plugin section in your admin dashboard.
Click Add New Plugin.
Search for “Airalo” to find the Airalo Plugin for WooCommerce.
Click Install Now.
Navigate to the “Installed Plugins” page.
Click Activate.

Configure API settings#

Get your API credentials from the Airalo Partner Platform:
Log in to the Airalo Partner Platform.
Select the API Integration menu. Note that it is only available for dedicated users.
Copy the API Client ID and API Client Secret.
Screenshot 2025-08-06 at 12.56.38.png
Enter the API credentials in the Airalo plugin settings:
Return to WordPress.
Click Airalo in the left-hand navigation menu.
Enter the credentials provided in the Airalo Partner Platform to authenticate the plugin.
Screenshot 2025-08-06 at 12.34.37.png
If you encounter issues with your API credentials, ensure they are copied correctly. Log in to the Partner Platform, navigate to the API Integration menu, and copy-paste client_id and client_secret into the plugin settings under Sandbox Credentials.
If the plugin shows an error related to a missing Sodium Library, contact your admin or cloud provider to enable it (some providers disable it by default, though it's essential for secure content encryption as part of PHP).

Configure synchronization settings#

Language: Choose the preferred language for product descriptions.
Use and auto-sync Airalo eSIM images: Enable this option if you want to use the Airalo images assigned to eSIM packages.
Use and auto-sync Airalo eSIM names: Enable this option if you want to use the Airalo names assigned to eSIM packages.
Auto-publish new eSIMs: Enable this if you want new eSIM packages to be published automatically. If not, they will sync as “Draft” for manual review. (Disabled by default).
Note: At this time, new eSIMs may be auto-published without a price. You’ll need to update the price manually until an update is released.
Auto-publish when price updates: Enable this if you have price automation configured and want products to be published automatically upon price changes. (Disabled by default).
Auto-send eSIM Cloud email to users: Enable this to automatically send users the default email we provide. You can customize it with your own branding assets under Brand settings in Company settings, accessible from the top-right navigation of the Airalo Partner Platform.
Auto-sync product title overwriting edits: Enable this to pull eSIM package titles from the Airalo Partner Platform and display them in WooCommerce. This will overwrite any manual edits you have made.
Auto-sync product description overwriting edits: Enable this to automatically sync product descriptions from the Airalo Partner Platform and display them in WooCommerce. This will overwrite any manual edits you have made.
Screenshot 2025-08-06 at 12.39.23.png
After configuring all necessary options, click Save Settings.

Sync products#

The plugin will automatically sync eSIM packages every hour.
You can initiate the synchronization by clicking the Sync Now button.
Note: Though auto-syncing is set to occur every hour, actual times may vary based on store traffic and may go up to every 3 hours.

Configure prices and publish products#

Go to the Products tab in the left-hand navigation menu.
If you opted to sync products as “Draft,” you will need to review and publish them manually. You can do this per product or by exporting and importing a CSV file.
For individual updates:
Hover over a product title and click Edit.
Scroll down to add the Regular price.
Change the Status to Published.
Click Update.
individual-update.png
For a mass update:
Click Export.
Specify which columns to export: SKU, Name, and Attributes.
Check “Yes, export all custom meta.”
Click Generate CSV.
mass-update.png
Open the CSV file.
Add a column matching the attribute name in WooCommerce. In this case, “regular price.”
Populate the regular price for each package.
csv-sample.png
In the Published column, enter a “1” for all products.
Go back to the Products page in WordPress.
Click Import.
Choose your CSV file and select “Update existing products.”
Click Continue.
import-products-screen.png
In the Column mapping section, scroll down and click Run the Importer.
mapping-screen.png
The products will be imported.
Click View Products to go back to the Products page.
import-success-screen.png

Configure payment gateway#

Once you are done updating your products, you can configure the payment gateway.

Set up the My eSIMs page#

The My eSIMs page gives your registered customers an overview of the eSIMs they have purchased. They can access their eSIMs, proceed with installation, and monitor their data usage from this page. Otherwise, they will only be able to access this information via email.
Here’s how to implement the My eSIMs page:
Click Pages in the left-hand navigation menu.
Click Add Page.
Select your page template.
Click the three dots in the top right-hand corner.
Click Code editor.
my-esims-page.png
Change the title to My eSIMs.
Replace the existing code with the shortcode: [airalo_woocommerce_my_esim].
Click Publish.
woocomm-myesim-page.png
Click View page to see the My eSIMs page.
To customize the colors of your My eSIMs page, follow the instructions on How to customize the "My eSIMs" page colors in WooCommerce.
esim-colors-page.png

Set up the eSIMs Cloud email (optional)#

On the Airalo WooCommerce settings page, you have the option to use our default email “eSIMs Cloud” to deliver eSIMs to your customers. By default, this email is branded as “Airalo Partners”, but you can customize it with your own branding.
esim-ready-email.png
Log in to the Airalo Partner Platform.
From the top-right navigation, go to Company settings.
Select the Brand settings tab.
Click Add new brand.
Upload your branding assets.
Save your changes.
Place a new order with the eSIMs Cloud setting enabled.
The eSIMs Cloud email will be updated to reflect the branding assets you uploaded.
esim-ready-email-code.png

Set up customer emails#

Access the email templates menu:
Click Email Templates in the left-hand navigation menu.
A list of email templates will be displayed.
Identify the emails to modify:
You need to modify the following two email templates:
Processing order: Used for online payments such as credit cards, PayPal, etc.
Order on-hold: Used for offline payments such as bank transfers or cash on delivery.
customer-email-setup.png
Edit the email templates:
Click the Edit button for each email template.
Locate the section where order details are displayed.
Add a new section to inform the user where they can find their eSIM details.
Include a button or link to the My eSIMs page.
template-view.png
Match the email design to your website branding:
Adjust the colors, fonts, and layout to match your website's theme. Most email customization plugins provide options to modify:
Logo
Header and footer colors
Font styles
Button styles
Background and text colors
Save and preview the changes:
After making the modifications, save the template.
Use the Preview tool to see how the email will appear to customers.
If the preview looks good, proceed with sending a test email.

Test in sandbox mode#

Once you have completed the above configuration, you can run test orders in Sandbox mode.
Note: Sandbox orders currently do not appear on the Airalo Partner Platform, but will soon be available.

Request to go live#

Once you have successfully run some test orders in Sandbox mode, you can reach out to your Airalo Account Manager to switch your company account to Production mode.
Note: The same credentials you used for Sandbox mode are still valid for Production mode. If you encounter any issues with the credentials, follow the same steps as you did in your initial setup.
Review settings and sync products:
Go to WordPress.
Click Airalo in the left-hand navigation menu.
Review your synchronization settings.
Click Sync Now to sync products.

Need help?#

We’re here for you! Please go to Help & Support in the Partner Platform for troubleshooting assistance.
Modified at 2025-09-12 09:35:30
Previous
Introduction
Next
How to customize the "My eSIMs" page colors in WooCommerce
Built with