Airalo Developer Platform
  1. Orders List
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
        • Get order
          GET
      • 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 packages
        GET
      • Get compatible device list
        GET
      • Future Orders
        POST
      • eSIM voucher
        POST
      • Get eSIM
        GET
      • Cancel future orders
        POST
      • Submit order
        POST
      • Refund Request
        POST
      • Get installation instructions
        GET
      • Submit order async
        POST
      • Get usage (data, text & voice)
        GET
      • Submit top-up order
        POST
      • Update eSIM brand
        PUT
    • Guides
      • Step #1 - Authentication
    • 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
    • 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 List

Get order list

GET
/v2/orders
This endpoint allows you to retrieve a list of your orders from the Airalo Partners API. By using various filters, you can customize the results to match specific criteria. 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

Request

Query Params
include
string 
optional
Optional. A comma-separated string to include related data in the response. Possible values are "sims", "user", and "status".
Example:
sims,user,status
filter[created_at]
string 
optional
Optional. A string to filter orders by their creation date. Specify the date range using a dash (-) as a delimiter for correct parsing.
Example:
Y-m-d - Y-m-d
filter[code]
string 
optional
Optional. Filter orders by their order code. This performs a like search using the format '%ORDER_CODE%'.
Example:
20221021-003188
filter[order_status]
string 
optional
Optional. A string to filter orders by their status. Possible values could be obtained from the "Get Order Statuses List" endpoint, and currently limited to"completed", "failed", and "refunded".
Example:
completed
filter[iccid]
string 
optional
Optional. Filter orders by the sim's ICCID. This performs a like search using the format '%SIM_ICCID%'.
Example:
891000000000001868
filter[description]
string 
optional
Optional. A string to filter orders by their description. This performs a like search using the format '%DESCRIPTION%'.
Example:
Your order description
limit
string 
optional
Optional. An integer specifying how many orders will be returned on each page.
Example:
50
page
string 
optional
Optional. An integer specifying the pagination's current page.
Example:
1
Header Params
Accept
string 
required
Example:
application/json
Authorization
string 
required
Example:
Bearer {{token}}
Body Params multipart/form-data
object {0}

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 GET '/v2/orders' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}'

Responses

🟠422Order List (422)
application/json
Body
data
object 
required
limit
string 
required
page
string 
required
meta
object 
required
message
string 
required
Example
{
    "data": {
        "limit": "The limit must be an integer.",
        "page": "The page must be an integer."
    },
    "meta": {
        "message": "the parameter is invalid"
    }
}
🟢200Order List (200)
Previous
Orders List
Next
Get order
Built with