Submit order - Airalo Developer Platform

This endpoint allows you to submit an order to the Airalo Partner API by providing the required parameters, such as package_id and quantity. You may also include an optional description field to track your internal order ID or add any relevant notes related to the order.

For more information and best practices, visit our FAQ page.

When submitting the order, the response includes the field direct_apple_installation_url with installation instructions that now provide Apple’s universal link, enabling direct installation on devices running iOS 17.4 or later for a smoother user experience.

You can also provide your user’s email address using the to_email parameter, which will send an email to your user asynchronously. The email uses a white-label template powered by our eSIM cloud feature. It provides your users with a link to access and install the eSIM, includes installation instructions, and supports multiple languages.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Submit Order (200)

application/json

Body

Examples

Submit Order (200)Success

{
    "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"
    }
}

🟢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