Skip to content

Commit 515af5e

Browse files
committed
feat: add documentation for shop endpoint with owned items retrieval
1 parent f9b8ad9 commit 515af5e

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

docs/endpoints/shop.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Shop
3+
sidebar_position: 5
4+
---
5+
6+
This page contains information about the `/shop` endpoint.
7+
8+
## Get owned items
9+
10+
Get all items that the authenticated user owns.
11+
12+
### Request
13+
14+
```http request
15+
GET /api/shop/owned
16+
```
17+
18+
Optional query parameters:
19+
* `type` - Filter items by type. Possible values: `avatar_decoration`.
20+
21+
### Example Response
22+
23+
```json
24+
[
25+
{
26+
"id": "a13bdc64-fd4a-4226-a696-2d5276406ae2",
27+
"type": "avatar_decoration",
28+
"name": "Crown",
29+
"description": "A crown for your avatar.",
30+
"price": 5.00, // Price in Euros
31+
"expires_at": null // Expiration date, if any
32+
}
33+
// ...
34+
]
35+
```

0 commit comments

Comments
 (0)