> ## Documentation Index
> Fetch the complete documentation index at: https://andcze.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> ItemShop v2 — API for item shops on Minecraft servers.

ItemShop v2 is the platform API that Minecraft server owners use to run item shops. One user can own multiple shops, each shop can have multiple servers, and customers buy products that are delivered in-game through a plugin.

The API is built on **NestJS 11** with the **Fastify 5** adapter. All routes are prefixed with `/api/v2`.

## Core concepts

<Columns cols={2}>
  <Card title="Shop" icon="store">
    The organizational unit. Has an owner, assigned users with roles (`view`/`edit`/`full`), and its own configuration for payments, VAT, email, and Discord.
  </Card>

  <Card title="Server" icon="server">
    A Minecraft server tied to a shop. Products are assigned to a server; the plugin receives real-time deliveries for that server.
  </Card>

  <Card title="Product" icon="box">
    A catalog item with a price and a list of commands to run (with placeholders `{PLAYER}`, `{QUANTITY}`, `{PRODUCT}`).
  </Card>

  <Card title="Order" icon="receipt">
    Created publicly by a customer. Generates a payment session; once paid, it goes to the plugin for fulfillment.
  </Card>
</Columns>

## Order lifecycle

<Steps>
  <Step title="Creation">
    The customer sends `POST /orders` with a product, nickname, and payment method. The API creates the order and a payment session, then returns a payment link.
  </Step>

  <Step title="Payment">
    The customer pays at the provider. The provider sends a webhook to `POST /payments/webhooks/...`. After signature verification, the order moves to status `paid`.
  </Step>

  <Step title="Fulfillment">
    The Minecraft plugin receives a Socket.IO push, wins an atomic claim, journals and runs the formatted commands, then acknowledges fulfilment (`status` → `completed`).
  </Step>
</Steps>

## Next steps

<Columns cols={2}>
  <Card title="Quickstart" icon="rocket" href="/en/quickstart">
    First requests: registration, shop, product, order.
  </Card>

  <Card title="Architecture" icon="sitemap" href="/en/guides/architecture">
    Module structure, layers, integrations (Redis, queues, WebSocket).
  </Card>

  <Card title="Authentication" icon="key" href="/en/guides/authentication">
    API keys, permissions, and roles.
  </Card>

  <Card title="API Reference" icon="code" href="/en/api-reference/overview">
    Full endpoint list generated from OpenAPI.
  </Card>
</Columns>