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

# Создание заказов и управление ими

> Создайте заказ со своего сайта, отправьте клиента на страницу оплаты и обрабатывайте оплату, отмену и возвраты.

Заказ (счет) содержит товары, клиента и цену. Клиент оплачивает его на размещенной странице `checkout_url`, где выбирает любой способ оплаты, который принимает ваш магазин.

Заказы, созданные через API, подчиняются тем же правилам, что и ваша витрина: цены берутся из каталога, остатки резервируются, применяются купоны и правила товаров, выполняются проверки на мошенничество.

## Создайте заказ

```bash cURL theme={"system"}
curl -X POST https://app.papelship.com/api/v1/invoices \
  -H "x-api-key: pk_live_your_key" \
  -H "x-store-hash: your_store_id" \
  -H "Idempotency-Key: 6f1c8a52-4f0e-4b8e-9a7c-2d1b3e5f7a90" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_email": "buyer@example.com",
    "items": [
      { "product_id": "a1B2c3D4e5F6", "quantity": 1 },
      { "product_id": "Zx9Yw8Vu7Ts6", "variant_id": 881 }
    ],
    "coupon_code": "SUMMER10",
    "customer_ip": "203.0.113.10",
    "metadata": { "order_ref": "WEB-1042" }
  }'
```

```javascript Node.js theme={"system"}
const res = await fetch("https://app.papelship.com/api/v1/invoices", {
  method: "POST",
  headers: {
    "x-api-key": process.env.PAPELSHIP_API_KEY,
    "x-store-hash": process.env.PAPELSHIP_STORE_ID,
    "Idempotency-Key": order.id,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    customer_email: order.email,
    items: [{ product_id: "a1B2c3D4e5F6", quantity: 1 }],
    customer_ip: order.ip,
    metadata: { order_ref: order.id },
  }),
});
const { invoice } = await res.json();
// Отправьте клиента на invoice.checkout_url
```

```python Python theme={"system"}
import os, requests

res = requests.post(
    "https://app.papelship.com/api/v1/invoices",
    headers={
        "x-api-key": os.environ["PAPELSHIP_API_KEY"],
        "x-store-hash": os.environ["PAPELSHIP_STORE_ID"],
        "Idempotency-Key": order_id,
    },
    json={
        "customer_email": "buyer@example.com",
        "items": [{"product_id": "a1B2c3D4e5F6", "quantity": 1}],
        "metadata": {"order_ref": order_id},
    },
)
invoice = res.json()["invoice"]
```

```json Ответ (201) theme={"system"}
{
  "success": true,
  "invoice": {
    "id": "c35ffd-19a1b2c3d4e-8c7a20",
    "object": "invoice",
    "status": "pending",
    "currency": "USD",
    "total_cents": 3499,
    "customer_email": "buyer@example.com",
    "source": "api",
    "metadata": { "order_ref": "WEB-1042" },
    "checkout_url": "https://app.papelship.com/invoice/c35ffd-19a1b2c3d4e-8c7a20",
    "expires_at": "2026-10-04T15:00:00.000Z",
    "items": [ ... ]
  }
}
```

Перенаправьте клиента на `checkout_url`. Неоплаченные заказы истекают через 3 часа.

> [accordion] Поля, которые можно передать
>
> | Поле | Примечания |
> | :- | :- |
> | `customer_email` | Обязательно. Получает письмо со счетом и доставку. |
> | `items` | Обязательно. От 1 до 50 строк с `product_id` (хеш-ID), `quantity` и `variant_id` для товаров с вариантами. |
> | `coupon_code` | Применяется, если действителен для этих товаров. |
> | `customer_ip` | IP покупателя. Включает для этого заказа ваши правила против мошенничества, VPN и черного списка. |
> | `expected_total_cents` | Необязательная проверка. Вызов завершится ошибкой `TOTAL_MISMATCH`, если цена изменилась. |
> | `shipping_address`, `shipping_rate_id` | Физические товары. См. ниже. |
> | `custom_fields` | Ответы на поля вашей формы оформления заказа. |
> | `affiliate_code` | Засчитывает заказ партнеру вашей партнерской программы. |
> | `send_email` | `false`, чтобы не отправлять письмо со счетом (по умолчанию `true`). |
> | `metadata` | До 20 собственных строковых пар ключ/значение. |

> [accordion] Ошибки при создании
>
> | Код | Статус | Значение |
> | :- | :- | :- |
> | `PRODUCT_NOT_FOUND` | `404` | Какого-то `product_id` нет в вашем магазине. |
> | `OUT_OF_STOCK` | `409` | Недостаточно товара на складе. В `details.products` перечислено, чего не хватает. |
> | `TOTAL_MISMATCH` | `409` | `expected_total_cents` не совпадает. В `details.expected_total_cents` указана фактическая сумма. |
> | `CURRENCY_MISMATCH` | `422` | У товаров разные валюты, или `currency` не совпадает. |
> | `INVALID_VARIANT` | `422` | `variant_id` отсутствует или неверен. |
> | `ADDRESS_INVALID` | `422` | Неполный адрес доставки. В `details.fields` перечислены поля. |
> | `CUSTOMER_BLOCKED` | `403` | Email или IP находится в вашем черном списке. |
> | `FRAUD_BLOCKED` | `403` | Ваши правила против мошенничества отклонили заказ. |
> | `STORE_SUSPENDED` | `403` | Магазин сейчас не может принимать заказы. |

## Физические товары

Для товаров с доставкой добавьте адрес. Сначала получите варианты с помощью `POST /shipping/quote` или не указывайте `shipping_rate_id`, чтобы использовать самый дешевый тариф.

```json theme={"system"}
{
  "customer_email": "buyer@example.com",
  "items": [{ "product_id": "Tsh1rtM3d1um", "variant_id": 2041, "quantity": 2 }],
  "shipping_address": {
    "full_name": "Alex Morgan",
    "phone": "+44 20 7946 0958",
    "country_code": "GB",
    "city": "London",
    "line1": "221B Baker Street",
    "postal_code": "NW1 6XE"
  },
  "shipping_rate_id": 12
}
```

Стоимость доставки добавляется к `total_cents` и отображается как `shipping_cents`. Если адрес не указан, клиент вводит его на странице оплаты перед платежом. После оплаты отправьте заказ с помощью [`POST /orders/{invoiceId}/shipments`](https://developers.papelship.com/ru/user-api/fulfillment).

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

| Статус | Значение |
| :- | :- |
| `pending` | Ожидает оплаты клиентом. |
| `payment_pending`, `payment_processing` | Клиент выбрал способ оплаты; платеж в процессе. |
| `partial_payment` | Поступила часть суммы (криптовалюта). |
| `manual_review_pending` | Ручной платеж ожидает вашей проверки. |
| `completed` | Оплачен и доставлен. |
| `cancelled` | Отменен до оплаты. |
| `expired` | Не оплачен вовремя. |

Вместо опроса слушайте вебхук `order.completed`. См. [Вебхуки](https://developers.papelship.com/ru/user-api/webhooks.md).

## После создания заказа

| Действие | Эндпоинт | Когда |
| :- | :- | :- |
| Отметить как оплаченный | `POST /invoices/{id}/complete` | Вы получили деньги вне PapelShip (банковский перевод, наличные). Доставляет товары. |
| Отменить | `POST /invoices/{id}/cancel` | Заказ не оплачен. Освобождает зарезервированные остатки. |
| Зарегистрировать возврат | `POST /invoices/{id}/refund` | Вы вернули деньги клиенту. Передайте `amount_cents` для частичного возврата. |
| Посмотреть, что было доставлено | `GET /invoices/{id}/deliveries` | Лицензионные ключи, файлы и заметки, отправленные клиенту. |
| Обновить | `PATCH /invoices/{id}` | Изменить `metadata` или `delivery_email`. |

> [!TIP]
>
> Используйте ID своего заказа как `Idempotency-Key` для вызовов создания, завершения и возврата. Тогда повторные запросы никогда не создадут второй заказ или второй возврат.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.