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

Swell Orders API

Customer orders, line items, financial totals, and lifecycle.

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

This API exposes 11 JSON Schema definitions.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 11 JSON Schemas.

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 2025-01.

Requests are made against 2 base URLs: https://api.swell.store, https://{storeId}.swell.store.

7 operations 4 paths 8 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-01
Base URL
https://api.swell.store
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Swell Orders API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-Store-Id (SwellStoreId). An API key is passed in the header as Authorization (SwellSecretKey). An API key is passed in the header as Authorization (SwellPublicKey).

  • SwellStoreId — Your Swell store ID, found in the Developer section of the dashboard.
  • SwellSecretKey — Secret API key prefixed with sk. Sent as Authorization: Basic or equivalent custom header by official libraries.
  • SwellPublicKey — Public storefront key, prefixed with pk. Pass as Authorization: pk....

Paths & Operations 7

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

Orders 7

Customer orders, line items, financial totals, and lifecycle.

GET
/orders
List Orders
listOrders 5 params → 200
POST
/orders
Create Order
createOrder body → 201
GET
/orders/{id}
Retrieve Order
getOrder 1 param → 200
PATCH
/orders/{id}
Update Order
updateOrder 1 param body → 200
DELETE
/orders/{id}
Delete Order
deleteOrder 1 param → 200
GET
/api/account/orders
List Account Orders
frontendListAccountOrders → 200
GET
/api/account/orders/{id}
Retrieve Account Order
frontendGetAccountOrder 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Order (25 properties), Order_2 (8 properties), OrderList (3 properties). Each schema is shown below with its type and property counts.

Order
object
25 properties
OrderList
object
3 properties
Money
number
Currency amount expressed in store currency.
ObjectId
string
OrderCreate
OrderUpdate
Order_2
object
8 properties
Money_2
number

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

swell-io-orders-api-openapi.yml Raw ↑

Other APIs Swell publishes across the network.

Swell GraphQL API
Swell Webhooks
Swell Apps Platform
Swell Account Addresses API
Swell Account API
Swell Account Cards API
Swell Account Credits API
Swell Account Session API
Swell Accounts API
Swell Attributes API
Swell Cart API
Swell Carts API
Where this information came from

This is an independent, third-party profile of Swell Orders 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.