Airalo Developer Platform
  1. Orders
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • 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
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: 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 packages
      • Get compatible device list
      • Future Orders
      • eSIM voucher
      • Get eSIM
      • Cancel future orders
      • Submit order
      • Refund Request
      • Get installation instructions
      • Submit order async
      • Get usage (data, text & voice)
      • Submit top-up order
      • Update eSIM brand
    • Guides
      • Step #1 - Authentication
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
          GET
        • Get Order
          GET
        • Submit Order
          POST
        • Submit Top-up Order
          POST
      • 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
    • 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
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Orders

Submit Order

POST
/v1/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.

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

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v1/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"'

Responses

🟠422Submit Order (422)
application/json
Body
data
object 
required
package_id
string 
required
quantity
string 
required
meta
object 
required
message
string 
required
Example
{
    "data": {
        "package_id": "The selected package is invalid.",
        "quantity": "The quantity may not be greater than 50."
    },
    "meta": {
        "message": "the parameter is invalid"
    }
}
🟠422Submit Order (422) SIM quantity is not available
🟢200Submit Order (200)
Previous
Get Order
Next
Submit Top-up Order
Built with