# REST API Reference

URL: /bengal/api/bengal-demo-commerce/
Section: bengal-demo-commerce
Description: Example OpenAPI specification used to demonstrate Bengal's autodoc OpenAPI extraction. The demo covers authentication, pagination, nested schemas, and polymorphic payment methods.


---

> For a complete page index, fetch /bengal/llms.txt.

# REST API Reference

v1.0.0

Example OpenAPI specification used to demonstrate Bengal's autodoc OpenAPI extraction. The demo covers authentication, pagination, nested schemas, and polymorphic payment methods.

12
Endpoints

23
Schemas

4
Categories

##
Base URLs

`https://api.demo.bengal.sh`

`https://staging.demo.bengal.sh`

##
Authentication

###

bearerAuth

http

`Authorization: Bearer YOUR_TOKEN`

###

apiKeyAuth

apiKey

`X-API-Key: YOUR_API_KEY`

###

oauth2

oauth2

`Authorization: Bearer ACCESS_TOKEN`

##
Categories

### Schemas

0

API data schemas and models.

(#schemas)

### Users

5

(#users)

### Orders

5

(#orders)

### Payments

1

(#payments)

### Inventory

1

(#inventory)

##
Users

GET
`/users`

List users

(#get-users)

POST
`/users`

Create user

(#post-users)

GET
`/users/{userId}`

Get user

(#get-users-userId)

PATCH
`/users/{userId}`

Update user profile

(#patch-users-userId)

POST
`/users/{userId}/sessions`

Create session token

(#post-users-userId-sessions)

##
Orders

GET
`/orders`

List orders

(#get-orders)

POST
`/orders`

Create order

(#post-orders)

GET
`/orders/{orderId}`

Get order

(#get-orders-orderId)

DELETE
`/orders/{orderId}`

Cancel order

(#delete-orders-orderId)

PATCH
`/orders/{orderId}`

Update order status or metadata

(#patch-orders-orderId)

##
Payments

POST
`/orders/{orderId}/payments`

Capture payment for an order

(#post-orders-orderId-payments)

##
Inventory

GET
`/inventory/items/{sku}`

Get inventory item

(#get-inventory-items-sku)

##
Schemas

`BaseResource`
object

(/bengal/api/bengal-demo-commerce/schemas/BaseResource/)

`UserBase`
object

(/bengal/api/bengal-demo-commerce/schemas/UserBase/)

`User`
object

(/bengal/api/bengal-demo-commerce/schemas/User/)

`UserCreate`
object

(/bengal/api/bengal-demo-commerce/schemas/UserCreate/)

`UserUpdate`
object

(/bengal/api/bengal-demo-commerce/schemas/UserUpdate/)

`Address`
object

(/bengal/api/bengal-demo-commerce/schemas/Address/)

`SessionCreate`
object

(/bengal/api/bengal-demo-commerce/schemas/SessionCreate/)

`SessionToken`
object

(/bengal/api/bengal-demo-commerce/schemas/SessionToken/)

`OrderStatus`
string

(/bengal/api/bengal-demo-commerce/schemas/OrderStatus/)

`Money`
object

(/bengal/api/bengal-demo-commerce/schemas/Money/)

`OrderLineItem`
object

(/bengal/api/bengal-demo-commerce/schemas/OrderLineItem/)

`Order`
object

(/bengal/api/bengal-demo-commerce/schemas/Order/)

`OrderCreate`
object

(/bengal/api/bengal-demo-commerce/schemas/OrderCreate/)

`OrderUpdate`
object

(/bengal/api/bengal-demo-commerce/schemas/OrderUpdate/)

`PaginatedUserList`
object

(/bengal/api/bengal-demo-commerce/schemas/PaginatedUserList/)

`PaginatedOrderList`
object

(/bengal/api/bengal-demo-commerce/schemas/PaginatedOrderList/)

`PaymentMethodCard`
object

(/bengal/api/bengal-demo-commerce/schemas/PaymentMethodCard/)

`PaymentMethodBank`
object

(/bengal/api/bengal-demo-commerce/schemas/PaymentMethodBank/)

`PaymentRequest`
object

(/bengal/api/bengal-demo-commerce/schemas/PaymentRequest/)

`Payment`
object

(/bengal/api/bengal-demo-commerce/schemas/Payment/)

`PaymentFailure`
object

(/bengal/api/bengal-demo-commerce/schemas/PaymentFailure/)

`InventoryItem`
object

(/bengal/api/bengal-demo-commerce/schemas/InventoryItem/)

`ErrorResponse`
object

(/bengal/api/bengal-demo-commerce/schemas/ErrorResponse/)
