Submit order async

POST

/v2/orders-async

This endpoint allows you to submit an asynchronous order to the Airalo Partners API. This ensures greater performance and reduces the wait time for your desired flow. Each async order will generate unique nanoid stored in reponse's request_id - Make sure you store this id in your system, as it is a reference for the order which is pending processing. You should check map it for every successfully received order response on your webhook url.

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/orders-async' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--form 'quantity="1"' \
--form 'package_id="kallur-digital-7days-1gb"' \
--form 'type="sim"' \
--form 'description="1 sim kallur-digital-7days-1gb"' \
--form 'webhook_url="https://your-webhook.com"'

Response Example

202 - Submit Order Async (202)

{
  "data": {
    "request_id": "3NhR3gKmqCWK7IWppurpDX3Cg",
    "accepted_at": "2024-07-11 15:26:02"
  },
  "meta": {
    "message": "success"
  }
}

Request

Header Params

string

required

Example:

application/json

Authorization

string

required

Example:

Bearer {ACCESS_TOKEN}

Body Params multipart/form-data

quantity

string

required

Required. The quantity of items in the order. Maximum of 50.

Example:

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

webhook_url

string

required

Optional. A custom, valid url to which you will receive the order details data asynchronously. Note that you can optin or provide in request. The webhook_url if provided in payload will overwrite the one which is opted in.

Example:

https://your-webhook.com

Responses

🟢202Submit Order Async (202)

application/json

Body

data

object

required

request_id

string

required

accepted_at

string

required