Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eSIM Go Orders API

Validate, place, and retrieve bundle orders.

eSIM Go Orders API is one of 6 APIs that eSIM Go publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version 2.4.

Requests are made against a single base URL, https://api.esim-go.com/v2.4.

3 operations 2 paths 6 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.4
Base URL
https://api.esim-go.com/v2.4
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

eSIM Go Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Organisation API key. Find it under Account Settings - API Details in your eSIM Go account and send it in the X-API-Key request header.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Orders 3

Validate, place, and retrieve bundle orders.

GET
/orders
List orders
listOrders 2 params → 200
POST
/orders
Create orders
createOrder body → 200
GET
/orders/{orderReference}
Get order detail
getOrder 1 param → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrderResponse (10 properties), InstallDetails (9 properties), OrderLine (6 properties), OrderItem (6 properties). Each schema is shown below with its type and property counts.

OrderItem
object
6 properties
OrderList
object
3 properties
OrderResponse
object
10 properties
OrderLine
object
6 properties
CreateOrderRequest
object
3 properties 2 required
InstallDetails
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

esimgo-orders-api-openapi.yml Raw ↑

Other APIs eSIM Go publishes across the network.

eSIM Go Catalogue API
eSIM Go eSIMs API
eSIM Go Inventory API
eSIM Go Networks API
eSIM Go Organisation API