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

Switstack BOM API

The BOM API from Switstack — 6 operation(s) for bom.

Switstack BOM API is one of 8 APIs that Switstack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BOM. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

This API exposes 18 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.28.0.

Requests are made against a single base URL, https://switcloud.switstack.io/.

18 operations 6 paths 19 schemas 3 DELETE6 GET3 PATCH3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.28.0
Base URL
https://switcloud.switstack.io/
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Switstack BOM API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2PasswordBearer) using the password flow.

Paths & Operations 18

Across 6 paths, the API surfaces 18 operations — 3 DELETE, 6 GET, 3 PATCH, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

BOM 18
GET
/api/bom/merchants
List Merchants
list_merchants 5 params → 200422
POST
/api/bom/merchants
Create Merchant
create_merchant body → 201422
GET
/api/bom/merchants/{id}
Get Merchant
get_merchant 1 param → 200422
PUT
/api/bom/merchants/{id}
Update Merchant
update_merchant 1 param body → 200422
PATCH
/api/bom/merchants/{id}
Partial Update Merchant
partial_update_merchant 1 param body → 200422
DELETE
/api/bom/merchants/{id}
Delete Merchant
delete_merchant 1 param → 204422
GET
/api/bom/stores
List Stores
list_stores 5 params → 200422
POST
/api/bom/stores
Create Store
create_store body → 201422
GET
/api/bom/stores/{id}
Get Store
get_store 1 param → 200422
PUT
/api/bom/stores/{id}
Update Store
update_store 1 param body → 200422
PATCH
/api/bom/stores/{id}
Partial Update Store
partial_update_store 1 param body → 200422
DELETE
/api/bom/stores/{id}
Delete Store
delete_store 1 param → 204422
GET
/api/bom/pois
List Pois
list_pois 8 params → 200422
POST
/api/bom/pois
Create Poi
create_poi body → 201422
GET
/api/bom/pois/{id}
Get Poi
get_poi 1 param → 200422
PUT
/api/bom/pois/{id}
Update Poi
update_poi 1 param body → 200422
PATCH
/api/bom/pois/{id}
Partial Update Poi
partial_update_poi 1 param body → 200422
DELETE
/api/bom/pois/{id}
Delete Poi
delete_poi 1 param → 204422

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are POIReadSchema (9 properties), POICreateSchema (8 properties), POIUpdateSchema (7 properties), POIPartialUpdateSchema (7 properties). Each schema is shown below with its type and property counts.

POIBrandType
string
HTTPValidationError
object
1 property
POIStateType
string
POIUpdateSchema
object
7 properties 4 required
StoreReadSchema
object
5 properties 5 required
StoreUpdateSchema
object
3 properties 2 required
MerchantPartialUpdateSchema
object
1 property
Page_TypeVar_Customized_StoreReadSchema_
object
5 properties 5 required
MerchantUpdateSchema
object
1 property 1 required
StorePartialUpdateSchema
object
3 properties
StoreCreateSchema
object
4 properties 2 required
ValidationError
object
3 properties 3 required
POIReadSchema
object
9 properties 6 required
POICreateSchema
object
8 properties 4 required
Page_TypeVar_Customized_MerchantReadSchema_
object
5 properties 5 required
POIPartialUpdateSchema
object
7 properties
Page_TypeVar_Customized_POIReadSchema_
object
5 properties 5 required
MerchantCreateSchema
object
2 properties 1 required
MerchantReadSchema
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

switstack-bom-api-openapi.yml Raw ↑

Other APIs Switstack publishes across the network.

Switstack Auth API
Switstack Config API
Switstack Parser API
Switstack Payment API
Switstack Suite API
Switstack Test API
Switstack Validation API
Where this information came from

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