Черновики заказов

Заказ, который готовит приложение: черновик считается живьём по каталогу, скидкам и доставке, показывает помехи оформлению и становится заказом.

Загружаем поисковый индекс…

Черновики заказов

Объекты

DraftOrder

  • idintegerобязательно

    ID записи, уникальный среди записей своего вида в магазине.

  • versionintegerобязательно

    Ревизия черновика: её сдвигает любая правка, в том числе сотрудником в панели. Под ней черновик правится, удаляется и оформляется.

  • statusstringобязательно

    open — правится и оформляется; completed — оформлен, заказ в order_id; cancelled — отменён без заказа.

    Значения:
    opencompletedcancelled
  • customer_idinteger или nullобязательно

    Покупатель черновика (/v1/customers); null, пока не выбран.

  • order_idinteger или nullобязательно

    Заказ, оформленный из черновика; null до оформления.

  • linesмассив objectобязательно

    Позиции черновика. Открытый черновик считается живьём по каталогу, скидкам и доставке; закрытый хранит позиции без цен.

    Поля · 12
    • idintegerобязательно

      ID строки в черновике.

    • variant_idinteger или nullобязательно

      Вариант строки; null у свободной строки.

    • product_idinteger или nullобязательно

      Товар строки; null у свободной строки.

    • product_nameсловарь stringобязательно

      Название товара на момент продажи, по языкам.

    • variant_nameсловарь stringобязательно

      Название варианта на момент продажи, по языкам; пустой объект, если у варианта не было названия.

    • custom_namestring или nullобязательно

      Название свободной строки, которую сотрудник завёл без товара; null у строки с вариантом.

    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки у штучной позиции, мера у весовой или объёмной ("480" граммов).

    • unitstring или nullобязательно

      Единица quantity: pcs, g или ml; null, если вариант больше не знает единицу своей меры.

      Значения:
      pcsgmlnull
    • unit_priceinteger или nullобязательно

      Цена единицы с добавками; null у закрытого черновика.

    • discountinteger или nullобязательно

      Уценка строки; null у закрытого черновика.

    • totalinteger или nullобязательно

      Сумма строки до уценки; null у закрытого черновика.

    • modifiersмассив objectобязательно

      Добавки строки, например топпинги блюда.

      Поля · 2
      • option_idintegerобязательно

        ID варианта добавки.

      • quantityintegerобязательно

        Сколько раз добавка добавлена.

  • delivery_method_idinteger или nullобязательно

    Способ доставки (/v1/delivery-methods); null, пока не выбран.

  • address_idinteger или nullобязательно

    Адрес из адресной книги покупателя — для способа с доставкой; null, пока не выбран.

  • pickup_location_idinteger или nullобязательно

    Пункт самовывоза для способа самовывоза. Единственный пункт способ берёт сам; из нескольких черновик должен назвать один.

  • delivery_slotsмассив objectобязательно

    Окна доставки, выбранные для способа, который работает с окнами.

    Поля · 2
    • fromstringобязательно

      Начало окна.

    • tostringобязательно

      Конец окна.

  • delivery_cost_overrideinteger или nullобязательно

    Цена доставки, названная вручную, вместо расчёта способа; null — по правилам способа.

  • payment_methodstring или nullобязательно

    Способ оплаты, которым черновик оформится: от него зависят скидки за способ и совместимость с доставкой.

    Значения:
    cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
  • manual_payment_method_idinteger или nullобязательно

    Ручной способ оплаты магазина, когда payment_method — manual; иначе null.

  • promocodestring или nullобязательно

    Промокод черновика; null, если нет.

  • customer_commentstring или null

    Комментарий покупателя к заказу. Только со scope customers:read.

  • notestring или nullобязательно

    Внутренняя заметка магазина: уходит в заказ, покупатель её не видит.

  • currencystringобязательно

    Валюта сумм, код ISO 4217: валюта магазина.

  • items_totalintegerобязательно

    Сумма строк до скидки заказа.

  • discountintegerобязательно

    Скидка заказа.

  • delivery_costinteger или nullобязательно

    Доставка к оплате; null, если её ещё нельзя посчитать.

  • totalintegerобязательно

    Сумма к оплате.

  • issuesмассив objectобязательно

    Что мешает оформлению; пусто, если ничего, и у закрытого черновика.

    Поля · 2
    • codestringобязательно

      customer_required — нет покупателя; phone_required — у покупателя нет телефона; items_empty — нет строк; import_lines_pending, import_parse_running — импортированные строки ещё не готовы; items_unavailable — товар не продаётся; modifier_invalid — добавка не подходит к позиции; price_missing — у товара нет цены; measure_required — весовой или объёмной позиции нужна мера; insufficient_stock — не хватает остатка; presale_not_ready, presale_plan_short — товар предзаказа не готов или его осталось меньше заказанного; gift_card_sales_disabled — магазин не продаёт подарочные карты; delivery_method_required — нет способа доставки; address_required — доставке нужен адрес; branch_required — способу нужен пункт выдачи перевозчика; pickup_location_required — у способа несколько пунктов самовывоза, назовите один; pickup_location_none — у способа нет доступного пункта; pickup_location_mismatch — пункт не обслуживается способом; slot_required — способу нужно окно доставки; slot_invalid — окно недоступно; delivery_not_applicable — способ не доставляет этот заказ; delivery_cost_required — способу нужна цена доставки вручную; promocode_invalid — промокод не применяется; payment_delivery_incompatible — способ оплаты не работает с этим способом доставки.

      Значения:
      customer_requiredphone_requireditems_emptyimport_lines_pendingimport_parse_runningitems_unavailablemodifier_invalidprice_missingmeasure_requiredinsufficient_stockpresale_not_readypresale_plan_shortgift_card_sales_disableddelivery_method_requiredaddress_requiredbranch_requiredpickup_location_requiredpickup_location_nonepickup_location_mismatchslot_requiredslot_invaliddelivery_not_applicabledelivery_cost_requiredpromocode_invalidpayment_delivery_incompatible
    • line_idinteger или nullобязательно

      Строка, о которой проблема; null у проблемы черновика целиком.

  • created_atstring (date-time)обязательно

    Когда запись создана.

  • updated_atstring (date-time)обязательно

    Когда запись менялась последний раз.

Методы

Черновик заказа: позиции, итоги и что мешает оформлению

get/draft-orders/{draft}

Scope: orders:read

Параметры

Путь

  • draftintegerобязательно

    ID черновика заказа.

Ответы

200Успешно

Заголовки

  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает DraftOrder

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl "https://api.saleya.app/v1/draft-orders/{draft}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "status": "open",
  "customer_id": 0,
  "order_id": 0,
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "product_id": 0,
      "product_name": {
        "key": "string"
      },
      "variant_name": {
        "key": "string"
      },
      "custom_name": "string",
      "quantity": "string",
      "unit": "pcs",
      "unit_price": 0,
      "discount": 0,
      "total": 0,
      "modifiers": [
        {
          "option_id": 0,
          "quantity": 0
        }
      ]
    }
  ],
  "delivery_method_id": 0,
  "address_id": 0,
  "pickup_location_id": 0,
  "delivery_slots": [
    {
      "from": "string",
      "to": "string"
    }
  ],
  "delivery_cost_override": 0,
  "payment_method": "cash",
  "manual_payment_method_id": 0,
  "promocode": "string",
  "customer_comment": "string",
  "note": "string",
  "currency": "string",
  "items_total": 0,
  "discount": 0,
  "delivery_cost": 0,
  "total": 0,
  "issues": [
    {
      "code": "customer_required",
      "line_id": 0
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Изменить черновик заказа: покупателя, доставку, способ оплаты и позиции

patch/draft-orders/{draft}

Scope: orders:write

Параметры

Путь

  • draftintegerобязательно

    ID черновика заказа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • customer_idinteger или null

    Покупатель черновика (/v1/customers); null, пока не выбран.

  • delivery_method_idinteger или null

    Способ доставки (/v1/delivery-methods); null, пока не выбран.

  • address_idinteger или null

    Адрес из адресной книги покупателя — для способа с доставкой; null, пока не выбран.

  • pickup_location_idinteger или null

    Пункт самовывоза для способа самовывоза. Единственный пункт способ берёт сам; из нескольких черновик должен назвать один.

  • delivery_slotsмассив object или null

    Окна доставки, выбранные для способа, который работает с окнами.

    Макс. элементов:
    50
    Поля · 2
    • fromstringобязательно

      Начало окна.

    • tostringобязательно

      Конец окна.

  • delivery_cost_overrideinteger или null

    Цена доставки, названная вручную, вместо расчёта способа; null — по правилам способа.

    Минимум:
    0
    Максимум:
    10000000000
  • payment_methodstring или null

    Способ оплаты, которым черновик оформится: от него зависят скидки за способ и совместимость с доставкой.

    Значения:
    cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
  • manual_payment_method_idinteger или null

    Ручной способ оплаты магазина, когда payment_method — manual; иначе null.

    Минимум:
    1
  • promocodestring или null

    Промокод черновика; null, если нет.

    Макс. длина:
    64
  • customer_commentstring или null

    Комментарий покупателя к заказу. Только со scope customers:read.

    Макс. длина:
    1000
  • notestring или null

    Внутренняя заметка магазина: уходит в заказ, покупатель её не видит.

    Макс. длина:
    1000
  • linesмассив object

    Позиции черновика. Открытый черновик считается живьём по каталогу, скидкам и доставке; закрытый хранит позиции без цен.

    Макс. элементов:
    200
    Без повторов
    Поля · 4
    • idinteger

      ID строки в черновике.

    • variant_idintegerобязательно

      Вариант строки; null у свободной строки.

    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки у штучной позиции, мера у весовой или объёмной ("480" граммов).

      Макс. длина:
      32
    • modifiersмассив object

      Добавки строки, например топпинги блюда.

      Макс. элементов:
      50
      Поля · 2
      • option_idintegerобязательно

        ID варианта добавки.

      • quantityinteger

        Сколько раз добавка добавлена.

        Минимум:
        1
        Максимум:
        99

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"

application/json

Возвращает DraftOrder

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X PATCH "https://api.saleya.app/v1/draft-orders/{draft}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "customer_id": 0,
  "delivery_method_id": 0,
  "address_id": 0,
  "pickup_location_id": 0,
  "delivery_slots": [
    {
      "from": "string",
      "to": "string"
    }
  ],
  "delivery_cost_override": 0,
  "payment_method": "cash",
  "manual_payment_method_id": 1,
  "promocode": "string",
  "customer_comment": "string",
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "quantity": "string",
      "modifiers": [
        {
          "option_id": 0,
          "quantity": 1
        }
      ]
    }
  ]
}
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "status": "open",
  "customer_id": 0,
  "order_id": 0,
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "product_id": 0,
      "product_name": {
        "key": "string"
      },
      "variant_name": {
        "key": "string"
      },
      "custom_name": "string",
      "quantity": "string",
      "unit": "pcs",
      "unit_price": 0,
      "discount": 0,
      "total": 0,
      "modifiers": [
        {
          "option_id": 0,
          "quantity": 0
        }
      ]
    }
  ],
  "delivery_method_id": 0,
  "address_id": 0,
  "pickup_location_id": 0,
  "delivery_slots": [
    {
      "from": "string",
      "to": "string"
    }
  ],
  "delivery_cost_override": 0,
  "payment_method": "cash",
  "manual_payment_method_id": 0,
  "promocode": "string",
  "customer_comment": "string",
  "note": "string",
  "currency": "string",
  "items_total": 0,
  "discount": 0,
  "delivery_cost": 0,
  "total": 0,
  "issues": [
    {
      "code": "customer_required",
      "line_id": 0
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Удалить черновик заказа

delete/draft-orders/{draft}

Scope: orders:write

Параметры

Путь

  • draftintegerобязательно

    ID черновика заказа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Ответы

204Успешно

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

Без тела

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X DELETE "https://api.saleya.app/v1/draft-orders/{draft}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'

Создать черновик заказа для покупателя

post/draft-orders

Scope: orders:write

Параметры

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324

Тело запроса application/json

  • customer_idinteger или null

    Покупатель черновика (/v1/customers); null, пока не выбран.

  • delivery_method_idinteger или null

    Способ доставки (/v1/delivery-methods); null, пока не выбран.

  • address_idinteger или null

    Адрес из адресной книги покупателя — для способа с доставкой; null, пока не выбран.

  • pickup_location_idinteger или null

    Пункт самовывоза для способа самовывоза. Единственный пункт способ берёт сам; из нескольких черновик должен назвать один.

  • delivery_slotsмассив object или null

    Окна доставки, выбранные для способа, который работает с окнами.

    Макс. элементов:
    50
    Поля · 2
    • fromstringобязательно

      Начало окна.

    • tostringобязательно

      Конец окна.

  • delivery_cost_overrideinteger или null

    Цена доставки, названная вручную, вместо расчёта способа; null — по правилам способа.

    Минимум:
    0
    Максимум:
    10000000000
  • payment_methodstring или null

    Способ оплаты, которым черновик оформится: от него зависят скидки за способ и совместимость с доставкой.

    Значения:
    cashmercadopagocryptobybittrc20balancemodopaywaymercadopago_qrmercadopago_pointmercadopago_transfergift_cardsubscriptiondepositexternalmanualoffseton_accountexchange_creditbonpuntoservice_packagenull
  • manual_payment_method_idinteger или null

    Ручной способ оплаты магазина, когда payment_method — manual; иначе null.

    Минимум:
    1
  • promocodestring или null

    Промокод черновика; null, если нет.

    Макс. длина:
    64
  • customer_commentstring или null

    Комментарий покупателя к заказу. Только со scope customers:read.

    Макс. длина:
    1000
  • notestring или null

    Внутренняя заметка магазина: уходит в заказ, покупатель её не видит.

    Макс. длина:
    1000
  • linesмассив object

    Позиции черновика. Открытый черновик считается живьём по каталогу, скидкам и доставке; закрытый хранит позиции без цен.

    Макс. элементов:
    200
    Без повторов
    Поля · 4
    • idinteger

      ID строки в черновике.

    • variant_idintegerобязательно

      Вариант строки; null у свободной строки.

    • quantitystringобязательно

      Количество десятичной строкой в unit: штуки у штучной позиции, мера у весовой или объёмной ("480" граммов).

      Макс. длина:
      32
    • modifiersмассив object

      Добавки строки, например топпинги блюда.

      Макс. элементов:
      50
      Поля · 2
      • option_idintegerобязательно

        ID варианта добавки.

      • quantityinteger

        Сколько раз добавка добавлена.

        Минимум:
        1
        Максимум:
        99

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true
  • ETagstringобязательно

    Версия записи. Передайте её в If-Match, чтобы изменить запись.

    Пример:
    "7"
  • Locationstring (uri)обязательно

    Адрес созданной записи, а у принятого к исполнению (202) — адрес, где следить за исходом.

application/json

Возвращает DraftOrder

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/draft-orders" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "customer_id": 0,
  "delivery_method_id": 0,
  "address_id": 0,
  "pickup_location_id": 0,
  "delivery_slots": [
    {
      "from": "string",
      "to": "string"
    }
  ],
  "delivery_cost_override": 0,
  "payment_method": "cash",
  "manual_payment_method_id": 1,
  "promocode": "string",
  "customer_comment": "string",
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "quantity": "string",
      "modifiers": [
        {
          "option_id": 0,
          "quantity": 1
        }
      ]
    }
  ]
}
Пример ответа · 201
{
  "id": 0,
  "version": 0,
  "status": "open",
  "customer_id": 0,
  "order_id": 0,
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "product_id": 0,
      "product_name": {
        "key": "string"
      },
      "variant_name": {
        "key": "string"
      },
      "custom_name": "string",
      "quantity": "string",
      "unit": "pcs",
      "unit_price": 0,
      "discount": 0,
      "total": 0,
      "modifiers": [
        {
          "option_id": 0,
          "quantity": 0
        }
      ]
    }
  ],
  "delivery_method_id": 0,
  "address_id": 0,
  "pickup_location_id": 0,
  "delivery_slots": [
    {
      "from": "string",
      "to": "string"
    }
  ],
  "delivery_cost_override": 0,
  "payment_method": "cash",
  "manual_payment_method_id": 0,
  "promocode": "string",
  "customer_comment": "string",
  "note": "string",
  "currency": "string",
  "items_total": 0,
  "discount": 0,
  "delivery_cost": 0,
  "total": 0,
  "issues": [
    {
      "code": "customer_required",
      "line_id": 0
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Оформить заказ из черновика: выставить счёт покупателю или записать оплату полученной

post/draft-orders/{draft}/complete

Scope: orders:write

Параметры

Путь

  • draftintegerобязательно

    ID черновика заказа.

Заголовок

  • Idempotency-Keystring

    Уникальный ключ попытки, например UUID. Повтор с тем же ключом и телом получает сохранённый ответ вместо второй записи. Ключ живёт 24 часа.

    Мин. длина:
    1
    Макс. длина:
    255
    Пример:
    8e03978e-40d5-43e8-bc93-6894a57f9324
  • If-Matchstringобязательно

    ETag записи из последнего чтения, например "7". Правка применится, только если запись с тех пор никто не менял, иначе 412. Без заголовка — 428.

    Пример:
    "7"

Тело запроса application/json

  • modestringобязательно

    invoice — заказ ждёт оплаты, реквизиты уходят покупателю каналами магазина, страница оплаты — в payment_url платежа; after_picking — покупатель получает счёт на точный итог после сборки, для весового товара; mark_paid — деньги уже получены ручным способом, нужен scope payments:write.

    Значения:
    invoiceafter_pickingmark_paid
  • expected_totalintegerобязательно

    Итог, который вы прочитали в черновике: цены, скидки или доставка могли смениться после чтения. Если он другой, запрос получит 422, и заказ не создастся.

    Минимум:
    0
    Максимум:
    100000000000000
  • currencystring

    Валюта, в которой вы прочитали итог: поле currency черновика. Магазин без заказов может сменить валюту, а числа цен смена не трогает; если валюта другая, запрос получит 422, и заказ не создастся. Без поля валюта не сверяется.

    Мин. длина:
    3
    Макс. длина:
    3

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

    true, когда это сохранённый ответ более раннего запроса с тем же Idempotency-Key.

    Значения:
    true

application/json

Возвращает Order

401Токена нет, он неверен, истёк или отозван

Заголовки

  • WWW-Authenticatestringобязательно

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer

application/problem+json

Возвращает Problem

403Запрос не разрешают тариф, IP-адрес или scopes токена

Заголовки

  • WWW-Authenticatestring

    Схема аутентификации (RFC 6750).

    Пример:
    Bearer error="insufficient_scope", scope="locations:read"

application/problem+json

Возвращает ForbiddenProblem

404Объекта нет или он недоступен приложению

application/problem+json

Возвращает Problem

409Запрос с тем же ключом идемпотентности ещё исполняется, данные изменились после чтения, внешний id у другой записи, исчерпан лимит тарифа или адресов вебхуков, или правке нужно согласие на последствия

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает ConflictProblem

412Запись изменилась после чтения: версия в If-Match не текущая

application/problem+json

Возвращает Problem

422Параметр неверен или неизвестен

application/problem+json

Возвращает ValidationProblem

428Запросу нужен If-Match с ETag записи

application/problem+json

Возвращает Problem

429Лимит запросов исчерпан

Заголовки

  • Retry-Afterintegerобязательно

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает RateLimitProblem

503Магазин временно недоступен

Заголовки

  • Retry-Afterinteger

    Сколько секунд подождать перед повтором.

    Минимум:
    0

application/problem+json

Возвращает Problem

Отказы метода

Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки

Пример запроса
curl -X POST "https://api.saleya.app/v1/draft-orders/{draft}/complete" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"' \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "mode": "invoice",
  "expected_total": 0,
  "currency": "string"
}
Пример ответа · 201
{
  "id": 0,
  "number": "string",
  "channel": "web",
  "app_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "status": "string",
  "status_group": "pos_open",
  "payment_status": "unpaid",
  "sale_type": "retail",
  "currency": "string",
  "items_total": 0,
  "discount": 0,
  "applied_discounts": [
    {
      "id": 0,
      "source": "promocode",
      "kind": "promo",
      "name": {},
      "code": "string",
      "reason": "string",
      "order_item_id": 0,
      "amount": 0
    }
  ],
  "delivery_cost": 0,
  "delivery_discount": 0,
  "delivery_discounts": [
    {
      "id": 0,
      "source": "promocode",
      "kind": "promo",
      "name": {},
      "code": "string",
      "amount": 0
    }
  ],
  "delivery_tax_lines": [
    {
      "regime": "vat",
      "kind": "taxed",
      "rate_bps": 0,
      "base": 0,
      "amount": 0,
      "jurisdiction": "string"
    }
  ],
  "platform_discount": 0,
  "platform_service_fee": 0,
  "platform_delivery_fee": 0,
  "total": 0,
  "tax_lines": [
    {
      "regime": "vat",
      "kind": "taxed",
      "rate_bps": 0,
      "base": 0,
      "amount": 0,
      "jurisdiction": "string"
    }
  ],
  "gift_card_issue_amount": 0,
  "reservation_deposit_amount": 0,
  "account_payment_amount": 0,
  "service_package_issue_amount": 0,
  "payment_method": "cash",
  "manual_payment_method_id": 0,
  "delivery_method_id": 0,
  "fulfilment_type": "self_pickup",
  "delivery_slots": [
    {
      "from": "string",
      "to": "string"
    }
  ],
  "shipment": {
    "carrier": "andreani",
    "carrier_name": "string",
    "tracking_number": "string",
    "tracking_url": "string",
    "status": "accepted",
    "status_at": "2026-01-15T12:00:00Z",
    "events": [
      {
        "status": "accepted",
        "description": "string",
        "occurred_at": "2026-01-15T12:00:00Z"
      }
    ],
    "label_available": true
  },
  "previous_shipments": [
    {
      "carrier": "andreani",
      "carrier_name": "string",
      "tracking_number": "string",
      "tracking_url": "string",
      "status": "accepted",
      "status_at": "2026-01-15T12:00:00Z",
      "events": [
        {
          "status": "accepted",
          "description": "string",
          "occurred_at": "2026-01-15T12:00:00Z"
        }
      ]
    }
  ],
  "shipment_attempt": {
    "state": "queued",
    "started_at": "2026-01-15T12:00:00Z",
    "error": {
      "code": "no_carrier",
      "message": "string"
    }
  },
  "merged_into_order_id": 0,
  "cancel_reason": "payment_init_failed",
  "items": [
    {
      "id": 0,
      "variant_id": 0,
      "product_id": 0,
      "product_name": {
        "key": "string"
      },
      "variant_name": {
        "key": "string"
      },
      "quantity": "string",
      "unit": "pcs",
      "unit_price": 0,
      "total": 0,
      "discount": 0,
      "discount_allocations": [
        {
          "applied_discount_id": 0,
          "amount": 0
        }
      ],
      "is_gift": true,
      "tax_lines": [
        {
          "regime": "vat",
          "kind": "taxed",
          "rate_bps": 0,
          "base": 0,
          "amount": 0,
          "jurisdiction": "string"
        }
      ],
      "cost_amount": 0,
      "cost_basis": "variant"
    }
  ],
  "customer": {
    "id": 0,
    "name": "string",
    "phone": "string",
    "email": "string"
  },
  "delivery_address": {
    "kind": "address",
    "recipient": "string",
    "phone": "string",
    "street": "string",
    "house": "string",
    "apartment": "string",
    "floor": "string",
    "entrance": "string",
    "district": "string",
    "city": "string",
    "province": "string",
    "postal_code": "string",
    "address_line": "string",
    "comment": "string",
    "location": {
      "lat": 0,
      "lng": 0
    },
    "branch": {
      "external_id": "string",
      "name": "string"
    }
  },
  "customer_comment": "string",
  "fiscal_receptor": {
    "id_type": "tax_id",
    "id_number": "string",
    "name": "string",
    "tax_status": "registered",
    "address": "string"
  },
  "external_fiscal_document": {
    "issuer": "string",
    "status": "pending",
    "number": "string"
  },
  "placed_at": "2026-01-15T12:00:00Z",
  "confirmed_at": "2026-01-15T12:00:00Z",
  "completed_at": "2026-01-15T12:00:00Z",
  "cancelled_at": "2026-01-15T12:00:00Z",
  "refunded_at": "2026-01-15T12:00:00Z",
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}