Partner API (B2B)
Products
GET /b2b/v1/products — search esimoa products by country, keyword, duration, data and more.
Request#
GET
/b2b/v1/productscurl "https://api.esimoa.com/b2b/v1/products?country=JP&isUnlimited=true&minDays=5&sortBy=price&limit=20" \
-H "X-API-Key: $ESIMOA_PARTNER_KEY"const params = new URLSearchParams({
country: 'JP',
isUnlimited: 'true',
minDays: '5',
sortBy: 'price',
limit: '20',
page: '1',
});
const res = await fetch(`https://api.esimoa.com/b2b/v1/products?${params}`, {
headers: { 'X-API-Key': process.env.ESIMOA_PARTNER_KEY },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.message}`);
const { data: products, total, page, limit } = body;import os
import requests
res = requests.get(
"https://api.esimoa.com/b2b/v1/products",
params={"country": "JP", "isUnlimited": "true", "minDays": 5, "sortBy": "price", "limit": 20, "page": 1},
headers={"X-API-Key": os.environ["ESIMOA_PARTNER_KEY"]},
timeout=10,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['message']}")
products = body["data"]Query parameters#
All parameters are optional. Out-of-range values return 400; unknown parameters are ignored.
| Parameter | Type | Description |
|---|---|---|
country | string | ISO 3166-1 alpha-2 country code (e.g. JP). Other formats return 400 |
q | string | Keyword (up to 60 characters) |
isUnlimited | boolean | true = unlimited only, false = exclude unlimited — true | false (1 | 0 also accepted) |
minDays · maxDays | integer | Validity range in days, 1–365 |
minDataGB | number | Minimum data in GB, 0–1000 |
hasLocalNumber | boolean | Includes a local phone number — true | false (1 | 0 also accepted) |
isMultiCountry | boolean | Multi-country product — true | false (1 | 0 also accepted) |
sortBy | string | recommended (default) | price | validity | data |
sortOrder | string | asc | desc — defaults per sortBy when omitted |
page | integer | Starts at 1, default 1 |
limit | integer | 1–50, default 20 |
Sorting#
| sortBy | Default sortOrder | Meaning |
|---|---|---|
| recommended | desc | esimoa recommended ranking (includes sales) — same order as the website |
| price | asc | Lowest price first |
| validity | asc | Shortest validity first |
| data | desc | Most data first |
Pagination#
page starts at 1. The response echoes page and limit along with total, so the last page is ceil(total / limit).
Response#
200 OKjson
{
"success": true,
"data": [
{
"id": "partner_9VKPYQ3JRYVK5797",
"name": "Japan Unlimited 5일",
"country": "Japan",
"countryCode": "JP",
"coverageCountries": ["JP"],
"isMultiCountry": false,
"dataAmount": "Unlimited",
"isUnlimited": true,
"validityDays": 5,
"priceKRW": 12000,
"currency": "KRW",
"networkType": "5G",
"localNetworks": ["SoftBank"],
"isLocalNetwork": true,
"fupPolicy": null,
"hotspotEnabled": true,
"hasLocalNumber": false,
"voiceMinutes": null,
"smsCount": null,
"supportTopUp": false,
"supportsUsim": false,
"activationType": "instant"
}
],
"total": 128,
"page": 1,
"limit": 20
}The PartnerProduct object#
| Field | Type | Description |
|---|---|---|
id | string | 'partner_<packageCode>' — the same product id used on esimoa.com |
name | string | Display name in the form "<area> <data> <N>일" (Korean day suffix). Build your own label from the structured fields for other languages |
country | string | Coverage area label (multi-country products list their countries) |
countryCode | string? | ISO country code — omitted when not available |
coverageCountries | string[] | Country codes the product works in |
region | string? | Region — omitted when not available |
isMultiCountry | boolean | Multi-country product |
dataAmount | string | Catalog label ('10GB', 'Unlimited', '1GB/Day + Unlimited' …) |
dataAmountGB | number? | Data in GB — omitted for fully unlimited products |
isUnlimited | boolean | Unlimited plan |
validityDays | integer | Validity in days |
priceKRW / currency | integer / 'KRW' | esimoa retail price in KRW — there is no partner price in v1 |
networkType | string | Network (e.g. 5G) — '' when unknown |
localNetworks | string[] | Local carriers |
isLocalNetwork | boolean | Uses a local network rather than roaming |
fupPolicy | string | null | Fair-use policy (FUP) text |
hotspotEnabled | boolean | null | Tethering allowed — null = unknown |
hasLocalNumber | boolean | Includes a local phone number |
voiceMinutes | integer | null | Voice minutes — -1 = unlimited, null = not provided |
smsCount | integer | null | SMS count — null = not provided |
supportTopUp | boolean | null | Can be topped up — null = unknown |
supportsUsim | boolean | Also sold as a physical USIM |
activationType | string | Activation type (e.g. 'instant') |
Note
Supplier and cost fields are never part of the response. Fields are only ever added and names and meanings do not change — parse so unknown fields are ignored.
