How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Soracom

Soracom Order API

- [Coupon codes](/en/guides/accounting/payment/register-coupon/)- [Long term discounts](/en/docs/air/volume-discount/)- Order management- Product catalog

Documentation Provider Profile APIs.io OpenAPI GitHub

Soracom Order API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 14 operations across 13 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.

Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.

14 operations 13 paths 27 schemas 5 GET4 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom Order API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Soracom-API-Key (api_key). An API key is passed in the header as X-Soracom-Token (api_token).

  • api_key — API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…
  • api_token — API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…

Paths & Operations 14

Across 13 paths, the API surfaces 14 operations — 5 GET, 4 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Order 14

- [Coupon codes](/en/guides/accounting/payment/register-coupon/) - [Long term discounts](/en/docs/air/volume-discount/) - Order management - Product catalog

POST
/coupons
Create coupon quotation
createCouponQuotation body → 201
PUT
/coupons/{order_id}/confirm
Confirm coupon order
confirmCouponOrder 1 param → 200
GET
/orders
Get a list of confirmed order history
listOrders → 200
POST
/orders
Create Quotation
createQuotation body → 201
GET
/orders/{order_id}
Get a confirmed order
getOrder 1 param → 200
PUT
/orders/{order_id}/cancel
Cancel order
cancelOrder 1 param → 204
PUT
/orders/{order_id}/confirm
Confirm order
confirmOrder 1 param → 200
PUT
/orders/{order_id}/resource_initial_setting
Update resource initial setting for an order
updateOrderedResourceInitialSetting 1 param body → 200400404
GET
/orders/{order_id}/subscribers
List ordered subscribers
listOrderedSubscribers 3 params → 200
POST
/orders/{order_id}/subscribers/register
Register subscribers for operator
registerOrderedSim 1 param → 204
GET
/products
List products
listProducts 1 param → 200
POST
/volume_discounts
Create long term discount quotation
createVolumeDiscountQuotation body → 201
PUT
/volume_discounts/{order_id}/confirm
Confirm long-term discount order
confirmVolumeDiscountOrder 1 param → 200
GET
/volume_discounts/available_discounts
List available long term discounts
listAvailableDiscounts → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are GetOrderResponse (26 properties), ProductModel (20 properties), EstimatedOrderModel (18 properties), ShippingAddressModel (12 properties). Each schema is shown below with its type and property counts.

CreateEstimatedVolumeDiscountRequest
object
5 properties 4 required
CreateEstimatedCouponRequest
object
1 property 1 required
ShippingCostModel
object
Shipping cost.
6 properties
GetOrderResponse
object
26 properties
PriceByQuantity
object
3 properties
ListOrderResponse
object
1 property
OrderItemModel
object
2 properties
SimInitialSetting
object
Sim initial setting for the specific subscription.
3 properties
ListProductResponse
object
2 properties
OrderedSubscriber
object
8 properties
ResourceInitialSetting
object
Initial setting for the resource.
1 property
EstimatedOrderModel
object
18 properties
AvailableLongTermDiscountResponse
object
1 property
ProductModel
object
Product.
20 properties
GetVolumeDiscountResponse
object
12 properties
CreateEstimatedOrderRequest
object
4 properties
ShippingOptionOfNekopos
object
Available for Japan operators only.
2 properties
EstimatedOrderItemModel
object
4 properties
EstimatedVolumeDiscountModel
object
5 properties
ListOrderedSubscriberResponse
object
1 property
ShippingLabelDetail
object
4 properties 2 required
CouponResponse
object
7 properties
VolumeDiscountModel
object
Long term discount.
11 properties
ShippingAddressModel
object
Shipping address.
12 properties 4 required
AvailableLongTermDiscountModel
object
6 properties
ShippingOptionOfExpeditedShipping
object
Available for United States and Canada operators only.
1 property
EstimatedCouponModel
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-order-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
AE Profile APIs.io
Soracom Group Configuration API
AE Profile APIs.io
Soracom Billing API
AE Profile APIs.io
Soracom Stats and Diagnostics API
AE Profile APIs.io
Soracom Auth and Access Management API
AE Profile APIs.io
Soracom Lagoon API
AE Profile APIs.io
Soracom Cloud Camera Services API
AE Profile APIs.io
Soracom Batch API
AE Profile APIs.io
Soracom Analysis API
AE Profile APIs.io
Soracom API Sandbox: Coupon API
AE Profile APIs.io
Soracom API Sandbox: Operator API
AE Profile APIs.io
Soracom API Sandbox: Order API
AE Profile APIs.io
#Order
← Back to S APIs
API Details
ID
soracom:soracom-order-api
Base URL
https://api.soracom.io/v1
Docs
https://users.soracom.io/ja-jp/tools/api/reference/#/Sim
Provider
Soracom
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=soracom-order-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-order-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Soracom Order API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.