Airalo Developer Platform
  1. Endpoints
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
        POST
      • Get compatible device list
        GET
      • Get packages
        GET
      • Submit order
        POST
      • Submit order async
        POST
      • Submit top-up order
        POST
      • Get eSIM
        GET
      • Get data usage
        GET
      • Get installation instructions
        GET
      • Update eSIM brand
        PUT
      • eSIM voucher
        POST
      • Refund Request
        POST
      • Future Orders
        POST
      • Cancel future orders
        POST
    • 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. Endpoints

Submit order

POST
/v2/orders
This endpoint allows you to submit an order to the Airalo Partners API. Provide the required information, such as quantity and package ID, and include optional description if needed.
The access token, obtained from the "Request Access Token" endpoint, should be included in the request.
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ
direct_apple_installation_url:
Partner API now supports direct installation on iOS devices. With the introduction of Universal Links by Apple, users with iOS 17.4 or higher can directly install eSIMs using a special URL, which can be provided to your end clients if they are using iOS version 17.4 or above.
When to_email is set email will be sent asynchronously, the template is configured in multiple languages, as of now theĀ  message body and subject cannot be given by the Partner
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/orders' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--form 'quantity="1"' \
--form 'package_id="kallur-digital-7days-1gb"' \
--form 'type="sim"' \
--form 'description="1 sim kallur-digital-7days-1gb"' \
--form 'brand_settings_name="our perfect brand"' \
--form 'to_email="valid_email@address.com"' \
--form 'sharing_option[]="link"' \
--form 'copy_address[]="valid_email@address.com"'
Response Response Example
200 - Submit Order (200)
{
  "data": {
    "package_id": "kallur-digital-7days-1gb",
    "quantity": "1",
    "type": "sim",
    "description": "Example description to identify the order",
    "esim_type": "Prepaid",
    "validity": 7,
    "package": "Kallur Digital-1 GB - 7 Days",
    "data": "1 GB",
    "price": 9.5,
    "created_at": "2023-02-27 14:09:55",
    "id": 9666,
    "code": "20230227-009666",
    "currency": "USD",
    "manual_installation": "<p><b>eSIM name: </b>Kallur Digital</p><p><b>Coverage:</b> Faroe Islands</p><p><b>To manually activate the eSIM on your eSIM capable device:</b></p><p>1. Settings> Cellular/Mobile> Add Cellular/Mobile Plan.</p><p>2. Manually enter the SM-DP+ Address and activation code.</p><p>3. Confirm the eSIM plan details</p><p>4. Label the eSIM.</p><p><b>To access Data:</b></p><p>1. Enable data roaming.</p><p><b>To top-up:</b></p><p></p><p>Visit airalo.com/my-esims or \"My eSIMs\" tab in your Airaloo app.</p><p><br></p>",
    "qrcode_installation": "<p><b>eSIM name:</b> Kallur Digital</p><p><b>Coverage: </b>Faroe Islands</p><p><b>To activate the eSIM by scanning the QR code on your eSIM capable device you need to print or display this QR code on other device:</b></p><p>1. Settings> Cellular/Mobile> Add Cellular/Mobile Plan.</p><p>2. Scan QR code</p><p>3. Confirm the eSIM plan details</p><p>4. Label the eSIM</p><p><b>To access Data:</b></p><p>1. Enable data roaming</p>",
    "installation_guides": {
      "en": "https://sandbox.airalo.com/installation-guide"
    },
    "brand_settings_name": "our perfect brand",
    "sims": [
      {
        "id": 11047,
        "created_at": "2023-02-27 14:09:55",
        "iccid": "891000000000009125",
        "lpa": "lpa.airalo.com",
        "imsis": null,
        "matching_id": "TEST",
        "qrcode": "LPA:1$lpa.airalo.com$TEST",
        "qrcode_url": "https://sandbox.airalo.com/qr?expires=1763820595&id=13301&signature=1f0d45226a3857bd0645bf77225b7aee7e250f926763ee1d1a6e4be7fefde71e",
        "direct_apple_installation_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$wbg.prod.ondemandconnectivity.com$Y7MRQ886FCDJD4RH",
        "airalo_code": null,
        "apn_type": "automatic",
        "apn_value": null,
        "is_roaming": true,
        "confirmation_code": null
      }
    ]
  },
  "meta": {
    "message": "success"
  }
}

Request

Header Params
Accept
stringĀ 
required
Example:
application/json
Authorization
stringĀ 
required
Example:
Bearer {{token}}
Body Params multipart/form-data
quantity
stringĀ 
required
Required. The quantity of items in the order. Maximum of 50.
Example:
1
package_id
stringĀ 
required
Required. The package ID associated with the order. You can obtain this from the "Packages / Get Packages" endpoint.
Example:
kallur-digital-7days-1gb
type
stringĀ 
required
Optional. The only possible value for this endpoint is "sim". If left empty, default "sim" value will be used.
Example:
sim
description
stringĀ 
required
Optional. A custom description for the order, which can help you identify it later.
Example:
1 sim kallur-digital-7days-1gb
brand_settings_name
stringĀ 
required
Nullable. The definition under what brand the eSIM should be shared. Null for unbranded.
Example:
our perfect brand
to_email
stringĀ 
required
Optional. If specified, email with esim sharing will be sent. sharing_option should be specified as well.
Example:
valid_email@address.com
sharing_option[]
stringĀ 
required
Optional. Array. Required when to_email is set. Available options: link, pdf
Example:
link
copy_address[]
stringĀ 
required
Optional. Array. It uses when to_email is set.
Example:
valid_email@address.com

Responses

🟢200Submit Order (200)
application/json
Body
data
objectĀ 
required
package_id
stringĀ 
required
quantity
stringĀ 
required
type
stringĀ 
required
description
stringĀ 
required
esim_type
stringĀ 
required
validity
integerĀ 
required
package
stringĀ 
required
data
stringĀ 
required
price
numberĀ 
required
created_at
stringĀ 
required
id
integerĀ 
required
code
stringĀ 
required
currency
stringĀ 
required
manual_installation
stringĀ 
required
qrcode_installation
stringĀ 
required
installation_guides
objectĀ 
required
brand_settings_name
stringĀ 
required
sims
arrayĀ [object {14}]Ā 
required
meta
objectĀ 
required
message
stringĀ 
required
🟢200Submit Order with Voice&Data package (200)
🟠422Submit Order (422)
🟠422Submit Order (422) SIM quantity is not available
🟠422Submit Order (422) Brand doesn't exist
🟢200Submit Order (200) with email share
Modified atĀ 2025-05-07 10:26:40
Previous
Get packages
Next
Submit order async
Built with