Airalo Developer Platform
  1. Guides
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Partner with Airalo
    • Attribute descriptions
    • FAQ
    • 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
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Guides
      • Step #1 - Authentication
    • Quick start
      • Request access token
      • Get packages
      • Submit order
      • Get installation instructions
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
      • Get compatible device list
      • Get packages
      • Submit order
      • Submit order async
      • Submit top-up order
      • Get eSIM
      • Get data usage
      • Get installation instructions
      • Update eSIM brand
      • eSIM voucher
      • Refund Request
      • Future Orders
      • Cancel future orders
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY INTEGRATION
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Guides

How to install the Airalo Shopify App

Follow these steps to configure the Airalo Shopify App:
1
Install the app
Search for the Airalo app in the Shopify App store and click Install. You can find a direct link to the app here.
2
Get your API credentials in the Airalo Partner Platform
1.
Navigate to the Partner Platform.
2.
Select the API Integration menu. (Note that it is only available for dedicated users.)
3.
Copy the API Client ID and API Client Secret.
image.png
3
Enter the API credentials in the Airalo Shopify App settings
Use the credentials provided by the Airalo Partner API to authenticate the plugin.
Screenshot 2025-04-23 at 15.26.48.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 the client_id and client_secret into the app settings under the production credentials.
4
Configure your synchronization settings
Language: Choose the preferred language for product descriptions. Note that the sandbox environment only supports a few languages, while the production environment supports 53 languages.
Sync images: Enable this option if you want to use the Airalo images assigned to eSIM packages.
Auto sync: Enable this if you want new eSIM packages to be published automatically. If not, they will sync as “Draft” for manual review.
Update product title / Update product description
If these options are checked, the Airalo app will automatically update the product title and description. If unchecked, the title and description will only be set when the product is first created and won’t be updated later. This is useful if you want to write your own product titles and descriptions.
5
Configure the webhook token
Configuring the webhook token is necessary to ensure secure communication between Shopify and Airalo.
1.
Open Settings by clicking the bottom left corner.
2.
From the side menu, select Notifications.
3.
Choose the Webhooks option.
4.
Copy the entire string displayed under "Your webhooks will be signed with." Ensure you copy the full value.
5.
Go back to the Airalo app configuration page.
6.
Paste the webhook token into the Webhook Token field.
Screenshot 2025-04-11 at 11.55.06.png
Screenshot 2025-04-11 at 11.55.57.png
6
Save your settings
After configuring all the necessary options, click Save Settings to apply the settings.
7
Sync products and orders
The Airalo Shopify App will now automatically sync eSIM packages every hour.
You can initiate the synchronization by clicking the Synchronize Packages button.
8
Register order synchronization with Airalo
Please follow these steps to set up the required webhook for your store:
1.
Open Settings by clicking the bottom left corner.
2.
From the side menu, select Notifications.
3.
Choose the Webhooks option.
4.
Click Create webhook (top right of the Webhooks section).
5.
In the Event dropdown, select Order creation.
6.
In the Format dropdown, select JSON.
7.
In the URL field, enter the following endpoint:
https://airalo-shpf.partners.airalo.com/api/v1/order
8.
Click Save.
That’s it! Your webhook is now set up and will notify our system every time a new order is created.
Screenshot 2025-04-23 at 15.17.37.png
9
Configure retail prices manually or via export/import
Screenshot 2025-04-11 at 13.21.30.png
10
Configure payment gateway
Ensure your payment gateway is set up in Shopify.
Modified at 2025-04-30 10:06:25
Previous
Introduction
Next
How to set up prices in Shopify
Built with