POST /api_esim/addEsimOrder — Place a SIM card order

This is the core ordering endpoint. Pass a SKU ID and price ID (from Get Packages) to purchase one or more SIM cards. The response includes eSIM activation details — SM-DP+ address, activation code, LPA string, and PDF link.

POST https://bpm.mioesim.com/api_esim/addEsimOrder

Request parameters

string

required

Session token from Login.

string

required

Product SKU ID.

string

required

Package price ID from Get Packages.

string

required

Number of SIM cards to order.

string

required

Request signature.

string

Required when supportDaypass=1. Number of days for a DayPass order (must satisfy minDay–maxDay).

string

Required when mustDate=1. Plan start date in MM/dd/yyyy format.

string

Controls response format: 0 or empty = return order number only; 1 = return full order details; 2 = return PDF URL info.

string

Required for physical SIM orders. DP identifier from Get DP Info.

string

For physical SIM: comma-separated list of ICCIDs. Count must equal count.

string

Customer email address. eSIM PDF is sent here if isSendEmail=1.

string

1 to send email; 0 or empty to skip.

string

PDF language code (e.g. en-US, zh-CN). Defaults to English. See PDF Languages.

string

Your platform’s order ID for reconciliation.

string

Your platform’s line item ID.

string

Optional order notes.

Response fields

When backInfo=1, the response includes full order details:

object

Show Order fields

string

MIOeSIM order number (e.g. EP20240124000013).

string

Product display name.

string

Order creation time (GMT+8).

integer

Quantity ordered.

string

Total price charged.

integer

Order status. See Order Statuses.

integer

Package price ID.

array

eSIM card details — one entry per SIM card ordered.

Show Card fields

string

Card ICCID.

string

eSIM phone number.

string

SM-DP+ server address.

string

Activation code.

string

LPA string for Android: LPA:1$sm_dp_address$activationCode.

string

Latest date to activate the eSIM.

string

Total data (e.g. "6GB").

integer

Validity in days.

string

Data consumed in MB.

string

PDF download link (when generated).

string

APN setting.

Example

curl -X POST https://bpm.mioesim.com/api_esim/addEsimOrder \
  -d "token=YOUR_TOKEN" \
  -d "skuId=45" \
  -d "priceId=441" \
  -d "count=1" \
  -d "backInfo=1" \
  -d "customerEmail=user@example.com" \
  -d "isSendEmail=1" \
  -d "pdfLanguage=en-US" \
  -d "sign=YOUR_SIGN"

{ "code": "0", "message": "success", "data": "EP20240124000013" }

{
  "code": "0",
  "message": "success",
  "data": {
    "orderNum": "EP20240124000013",
    "display": "Australia",
    "purchaseDate": "2024-01-24(GMT+8)",
    "count": 1,
    "price": "9.89",
    "status": 0,
    "priceId": 9726,
    "cardApiDtoList": [
      {
        "iccid": "934801019851134300",
        "mobileNumber": "0841823354",
        "sm_dp_address": "ais.prod.ondemandconnectivity.com",
        "activationCode": "SEW7JEBMFGPRVSPD",
        "code": "LPA:1$ais.prod.ondemandconnectivity.com$SEW7JEBMFGPRVSPD",
        "activateBefore": "2024-02-24(GMT+8)",
        "data": "6GB",
        "validity": 8,
        "usedMB": "0.0",
        "apn": "plus"
      }
    ]
  }
}

Use Verify Resources before placing large orders to confirm sufficient card inventory.

Authentication

eSIM Products

Orders

Physical SIM

ICCID & Cards

Account

By API Code

POST /api_esim/addEsimOrder — Place a SIM card order

Request parameters

Response fields

Example

​Request parameters

​Response fields

​Example

Request parameters

Response fields

Example