OpenAPI & Swagger zu Markdown Dokumentationsgenerator

# Aurora Commerce Engine API

> **Version:** `2.4.0`  
> **Specification:** `OpenAPI 3.0.3`  
> **Generated At:** `2026-10-21` via [ToolsAA](https://toolsaa.com)

High-throughput headless commerce API offering order lifecycle management, product catalog indexing, and customer checkout flows.

---

## Base URLs & Servers

| Environment / Description | Server URL |
|:---|:---|
| Production Cluster (Global Anycast) | `https://api.auroracommerce.io/v2` |
| Sandbox Staging Environment | `https://staging-api.auroracommerce.io/v2` |

## Authentication & Security

| Scheme Name | Type | Location / Format | Description |
|:---|:---|:---|:---|
| **`BearerAuth`** | `http` | Format: `bearer` | Enter your signed JWT authorization token in the format 'Bearer <token>'. |

## Table of Contents

- **Orders**
  - [`GET` `/orders`](#get--orders) - List Customer Orders
  - [`POST` `/orders`](#post--orders) - Create New Order
  - [`GET` `/orders/{orderId}`](#get--orders--orderid-) - Retrieve Order by ID
- **Data Models & Schemas**
  - [`Order`](#schema-order)
  - [`OrderItem`](#schema-orderitem)
  - [`CreateOrderRequest`](#schema-createorderrequest)
  - [`ApiError`](#schema-apierror)

---

## API Endpoints Reference

## Tag: Orders

### <a id="get--orders"></a>`GET` /orders

**List Customer Orders**

Retrieves a paginated collection of historical orders filtered by status or date range.

- **Operation ID:** `listOrders`
- **Security:** `BearerAuth`

#### Parameters

| Name | Located In | Type | Required | Description | Example / Default |
|:---|:---|:---|:---:|:---|:---|
| `status` | `query` | `string` | No | Filter orders by current fulfillment state. | - |
| `limit` | `query` | `integer` | No | Maximum number of orders to return per page. | Def: `20` |
| `cursor` | `query` | `string` | No | Opaque pagination cursor from previous response. | - |

#### Responses

| Status Code | Description | Schema Type |
|:---|:---|:---|
| `200` | Successfully retrieved order collection. | `Order[]` |
| `401` | Missing or invalid JWT authorization header. | `ApiError` |

##### Example Response (`200`)
```json
[
  {
    "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
    "customerId": "cust_894321",
    "items": [
      {
        "sku": "PROD-KB-900",
        "quantity": 2,
        "unitPrice": 99.99
      }
    ],
    "totalAmount": 249.99,
    "currency": "USD",
    "status": "paid"
  }
]
```

#### cURL Example
```bash
curl -X GET "https://api.auroracommerce.io/v2/orders" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Accept: application/json"
```

---

### <a id="post--orders"></a>`POST` /orders

**Create New Order**

Validates inventory reserves, charges default payment method, and records a new order.

- **Operation ID:** `createOrder`
- **Security:** `BearerAuth`

#### Request Body

- **Content-Type:** `application/json`
- **Required:** **Yes**
- **Description:** Order items and checkout details.

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `customerId` | `string` | **Yes** | - | `cust_894321` |
| `items` | `OrderItem[]` | **Yes** | - | - |
| `currency` | `string` | **Yes** | - | `USD` |
| `shippingAddress` | `string` | No | - | `742 Evergreen Terrace, Springfield, OR` |

##### Example Request Payload
```json
{
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "currency": "USD",
  "shippingAddress": "742 Evergreen Terrace, Springfield, OR"
}
```

#### Responses

| Status Code | Description | Schema Type |
|:---|:---|:---|
| `201` | Order successfully created and queued for processing. | `Order` |
| `422` | Validation failure or insufficient stock. | `ApiError` |

##### Example Response (`201`)
```json
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "totalAmount": 249.99,
  "currency": "USD",
  "status": "paid"
}
```

#### cURL Example
```bash
curl -X POST "https://api.auroracommerce.io/v2/orders" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{ "customerId": "cust_894321", "items": [ { "sku": "PROD-KB-900", "quantity": 2, "unitPrice": 99.99 } ], "currency": "USD", "shippingAddress": "742 Evergreen Terrace, Springfield, OR" }'
```

---

### <a id="get--orders--orderid-"></a>`GET` /orders/{orderId}

**Retrieve Order by ID**

Fetches full details for an individual order including shipping tracking codes.

- **Operation ID:** `getOrderById`
- **Security:** `BearerAuth`

#### Parameters

| Name | Located In | Type | Required | Description | Example / Default |
|:---|:---|:---|:---:|:---|:---|
| `orderId` | `path` | `string (uuid)` | **Yes** | Target order UUID. | - |

#### Responses

| Status Code | Description | Schema Type |
|:---|:---|:---|
| `200` | Order details found. | `Order` |
| `404` | Specified order does not exist. | `ApiError` |

##### Example Response (`200`)
```json
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "totalAmount": 249.99,
  "currency": "USD",
  "status": "paid"
}
```

#### cURL Example
```bash
curl -X GET "https://api.auroracommerce.io/v2/orders/{orderId}" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "Accept: application/json"
```

---

## Data Models & Schemas

### <a id="schema-order"></a>Schema: `Order`

> Complete customer purchase record and fulfillment state.

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `id` | `string (uuid)` | **Yes** | Unique immutable order identifier. | `9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d` |
| `customerId` | `string` | **Yes** | Associated customer identifier. | `cust_894321` |
| `items` | `OrderItem[]` | **Yes** | List of purchased items. | - |
| `totalAmount` | `number (double)` | **Yes** | Net order balance in standard monetary units. | `249.99` |
| `currency` | `string` | **Yes** | ISO-4217 three-letter currency code. | `USD` |
| `status` | `string` | **Yes** | Current fulfillment lifecycle state. | `paid` |

#### Sample JSON Representation
```json
{
  "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "totalAmount": 249.99,
  "currency": "USD",
  "status": "paid"
}
```

---

### <a id="schema-orderitem"></a>Schema: `OrderItem`

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `sku` | `string` | **Yes** | Stock Keeping Unit identifier. | `PROD-KB-900` |
| `quantity` | `integer` | **Yes** | Number of units purchased. | `2` |
| `unitPrice` | `number` | **Yes** | Price per unit at time of purchase. | `99.99` |

#### Sample JSON Representation
```json
{
  "sku": "PROD-KB-900",
  "quantity": 2,
  "unitPrice": 99.99
}
```

---

### <a id="schema-createorderrequest"></a>Schema: `CreateOrderRequest`

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `customerId` | `string` | **Yes** | - | `cust_894321` |
| `items` | `OrderItem[]` | **Yes** | - | - |
| `currency` | `string` | **Yes** | - | `USD` |
| `shippingAddress` | `string` | No | - | `742 Evergreen Terrace, Springfield, OR` |

#### Sample JSON Representation
```json
{
  "customerId": "cust_894321",
  "items": [
    {
      "sku": "PROD-KB-900",
      "quantity": 2,
      "unitPrice": 99.99
    }
  ],
  "currency": "USD",
  "shippingAddress": "742 Evergreen Terrace, Springfield, OR"
}
```

---

### <a id="schema-apierror"></a>Schema: `ApiError`

| Property | Type | Required | Description | Example |
|:---|:---|:---:|:---|:---|
| `code` | `string` | **Yes** | Machine-readable error code. | `ORDER_NOT_FOUND` |
| `message` | `string` | **Yes** | Human-readable error message. | `The requested order was not found.` |

#### Sample JSON Representation
```json
{
  "code": "ORDER_NOT_FOUND",
  "message": "The requested order was not found."
}
```

---