Skip to main content
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

token
string
required
Session token from Login.
skuId
string
required
Product SKU ID.
priceId
string
required
Package price ID from Get Packages.
count
string
required
Number of SIM cards to order.
sign
string
required
Request signature.
daypassDays
string
Required when supportDaypass=1. Number of days for a DayPass order (must satisfy minDaymaxDay).
beginDate
string
Required when mustDate=1. Plan start date in MM/dd/yyyy format.
backInfo
string
Controls response format: 0 or empty = return order number only; 1 = return full order details; 2 = return PDF URL info.
dpId
string
Required for physical SIM orders. DP identifier from Get DP Info.
iccids
string
For physical SIM: comma-separated list of ICCIDs. Count must equal count.
customerEmail
string
Customer email address. eSIM PDF is sent here if isSendEmail=1.
isSendEmail
string
1 to send email; 0 or empty to skip.
pdfLanguage
string
PDF language code (e.g. en-US, zh-CN). Defaults to English. See PDF Languages.
otherOrderId
string
Your platform’s order ID for reconciliation.
otherItemId
string
Your platform’s line item ID.
remark
string
Optional order notes.

Response fields

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

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"
Use Verify Resources before placing large orders to confirm sufficient card inventory.