Skip to main content

Orders API

API для управления заказами в маркетплейсе.

Обзор​

Orders API обеспечивает полный жизненный цикл заказов: от создания до выполнения и отслеживания.

Структура заказа​

interface Order {
  id: string;
  marketplace_id: string;
  customer_id: string;
  status: OrderStatus;
  total_amount: number;
  currency: string;
  items: OrderItem[];
  shipping_address: Address;
  payment_status: PaymentStatus;
  created_at: string;
  updated_at: string;
}

Статусы заказа​

Основные статусы​

  • pending - Ожидает подтверждения
  • confirmed - Подтвержден
  • processing - В обработке
  • shipped - Отправлен
  • delivered - Доставлен
  • cancelled - Отменен
  • returned - Возвращен

Статусы оплаты​

  • pending - Ожидает оплаты
  • paid - Оплачен
  • failed - Ошибка оплаты
  • refunded - Возвращен

Основные операции​

Создание заказа​

// POST /api/orders
{
  "marketplace_id": "uuid",
  "items": [
    {
      "product_id": "uuid",
      "quantity": 2,
      "price": 1000
    }
  ],
  "shipping_address": {
    "street": "ул. Примерная, 123",
    "city": "Москва",
    "postal_code": "123456"
  }
}

Получение заказов​

// GET /api/orders?marketplace_id=uuid&status=pending
{
  "orders": [...],
  "total": 100,
  "page": 1,
  "limit": 20
}

Обновление статуса​

// PATCH /api/orders/{id}/status
{
  "status": "confirmed",
  "note": "Заказ подтвержден"
}

Webhooks​

Система отправляет webhooks при изменении статуса заказа:

{
  "event": "order.status_changed",
  "order_id": "uuid",
  "old_status": "pending",
  "new_status": "confirmed",
  "timestamp": "2024-01-01T00:00:00Z"
}