Заказы поставщику

Что магазин заказал у поставщика: строки с заказанным, подтверждённым и принятым количеством, ценой и обещанной датой поставки.

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

Заказы поставщику

Объекты

PurchaseOrder

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

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

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

    Версия записи: растёт с каждым изменением. Чтобы изменить запись, передайте её как ETag в If-Match.

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

    Номер заказа; null у заказа, заведённого до нумерации.

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

    draft — черновик: поставщику не отправлен; sent — размещён, ждём поставку; partial — принят частично; received — принят полностью; closed — закрыт магазином: принят целиком или с недопоставкой (closed_short); cancelled — отменён.

    Значения:
    draftsentpartialreceivedclosedcancelled
  • supplier_idintegerобязательно

    ID поставщика (/v1/suppliers).

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

    ID точки, куда ждём поставку (/v1/locations).

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

    ID юрлица магазина-покупателя (/v1/legal-entities); null у заказа, заведённого до юрлиц магазина.

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

    Валюта заказа, ISO 4217: в ней цены строк и итоги.

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

    true — цены строк с налогом; false — без налога.

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

    Стоимость заказанного в силе; по закрытой строке — принятого.

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

    Стоимость принятого по заказу.

  • expected_onstring (date) или nullобязательно

    Когда магазин ждёт поставку, YYYY-MM-DD; null, если дата не задана.

  • next_delivery_onstring (date) или nullобязательно

    Ближайшая ожидаемая поставка с учётом дат, обещанных поставщиком, YYYY-MM-DD; null, если ждать нечего.

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

    Когда заказ впервые отправлен поставщику; null у черновика и у отменённого до отправки.

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

    true — заказ закрыт с недопоставкой: остаток больше не ждём.

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

    Ответ поставщика: awaiting — ждём; confirmed — подтвердил как есть; changed — подтвердил с изменениями (confirmed_quantity и promised_on строк); declined — отказал; null — ответ не отслеживается.

    Значения:
    awaitingconfirmedchangeddeclinednull
  • revisionintegerобязательно

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

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

    Заметка сотрудника; null, если её нет.

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

    Строки заказа по порядку.

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

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

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

      ID варианта товара (/v1/variants).

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

      Базовая единица количеств строки: pcs — штуки, g — граммы, ml — миллилитры.

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

      Заказано, десятичной строкой в базовой единице.

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

      Подтвердил поставщик; null — ответа по строке нет.

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

      Принято приёмками по строке.

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

      Цена в валюте заказа за cost_per_quantity; null — цена не указана.

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

      За какое количество в базовой единице указана цена: "1000" у весового товара — за килограмм.

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

      Стоимость заказанного в силе по строке; null без цены. Сумма по строкам — ordered_total.

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

      Стоимость принятого по строке; null без цены. Сумма по строкам — received_total.

    • promised_onstring (date) или nullобязательно

      Дата поставки, обещанная поставщиком, YYYY-MM-DD; null — не обещана, ждём к expected_on.

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

      Когда строку закрыли и перестали ждать остаток; null у открытой строки.

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

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

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

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

Методы

Заказы поставщику: заказано, подтверждено поставщиком и принято по строкам

get/purchase-orders

Scope: procurement:read

Параметры

Строка запроса

  • limitinteger

    Размер страницы: до 250 записей; по умолчанию 50.

    Минимум:
    1
    Максимум:
    250
  • cursorstring

    Непрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.

    Макс. длина:
    4096
  • updated_sincestring (date-time)

    Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.

    Шаблон:
    ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
  • include_deletedboolean

    true — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.

  • supplier_idinteger

    Только документы этого поставщика.

    Минимум:
    1

Ответы

200Успешно

application/json

  • dataмассив PurchaseOrderобязательно

    Записи страницы.

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

    Записи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.

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

      ID стёртой записи.

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

      Когда запись стёрта.

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

    Курсор следующей страницы; null на последней.

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

    true, если есть следующая страница.

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

    На последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.

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

410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы

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/purchase-orders" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "data": [
    {
      "id": 0,
      "version": 0,
      "number": "string",
      "status": "draft",
      "supplier_id": 0,
      "location_id": 0,
      "legal_entity_id": 0,
      "currency": "string",
      "prices_include_tax": true,
      "ordered_total": 0,
      "received_total": 0,
      "expected_on": "2026-01-15",
      "next_delivery_on": "2026-01-15",
      "placed_at": "2026-01-15T12:00:00Z",
      "closed_short": true,
      "supplier_response": "awaiting",
      "revision": 0,
      "note": "string",
      "lines": [
        {
          "id": 0,
          "variant_id": 0,
          "unit": "string",
          "ordered_quantity": "string",
          "confirmed_quantity": "string",
          "received_quantity": "string",
          "unit_cost": 0,
          "cost_per_quantity": "string",
          "ordered_amount": 0,
          "received_amount": 0,
          "promised_on": "2026-01-15",
          "closed_at": "2026-01-15T12:00:00Z"
        }
      ],
      "created_at": "2026-01-15T12:00:00Z",
      "updated_at": "2026-01-15T12:00:00Z"
    }
  ],
  "deleted": [
    {
      "id": 0,
      "deleted_at": "2026-01-15T12:00:00Z"
    }
  ],
  "next_cursor": "string",
  "has_more": true,
  "sync_cursor": "string"
}

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

post/purchase-orders

Scope: procurement:write

Параметры

Заголовок

  • Idempotency-Keystring

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

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

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

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

    ID поставщика (/v1/suppliers).

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

    ID точки, куда ждём поставку (/v1/locations).

  • legal_entity_idinteger или null

    ID юрлица магазина-покупателя (/v1/legal-entities); null у заказа, заведённого до юрлиц магазина.

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

    Валюта заказа, ISO 4217: в ней цены строк и итоги.

    Значения:
    ARSUSDBRLCLPCOPMXNPENRUB
  • prices_include_taxboolean

    true — цены строк с налогом; false — без налога.

  • expected_onstring (date) или null

    Когда магазин ждёт поставку, YYYY-MM-DD; null, если дата не задана.

  • notestring или null

    Заметка сотрудника; null, если её нет.

    Макс. длина:
    2000
  • linesмассив objectобязательно

    Строки заказа по порядку.

    Мин. элементов:
    1
    Макс. элементов:
    500
    Без повторов
    Поля · 4
    • variant_idintegerобязательно

      ID варианта товара (/v1/variants).

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

      Заказано, десятичной строкой в базовой единице.

      Макс. длина:
      32
    • unit_costinteger или null

      Цена в валюте заказа за cost_per_quantity; null — цена не указана.

      Минимум:
      0
      Максимум:
      10000000000
    • cost_per_quantitystring

      За какое количество в базовой единице указана цена: "1000" у весового товара — за килограмм.

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

Ответы

201Создано

Заголовки

  • Idempotent-Replayedstring

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

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

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

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

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

application/json

Возвращает PurchaseOrder

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/purchase-orders" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d @body.json
Тело запроса — body.json
{
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "ARS",
  "prices_include_tax": true,
  "expected_on": "2026-01-15",
  "note": "string",
  "lines": [
    {
      "variant_id": 0,
      "ordered_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string"
    }
  ]
}
Пример ответа · 201
{
  "id": 0,
  "version": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "string",
  "prices_include_tax": true,
  "ordered_total": 0,
  "received_total": 0,
  "expected_on": "2026-01-15",
  "next_delivery_on": "2026-01-15",
  "placed_at": "2026-01-15T12:00:00Z",
  "closed_short": true,
  "supplier_response": "awaiting",
  "revision": 0,
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "unit": "string",
      "ordered_quantity": "string",
      "confirmed_quantity": "string",
      "received_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "ordered_amount": 0,
      "received_amount": 0,
      "promised_on": "2026-01-15",
      "closed_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Заказ поставщику

get/purchase-orders/{purchase_order}

Scope: procurement:read

Параметры

Путь

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

    ID заказа поставщику.

Ответы

200Успешно

Заголовки

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

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

    Пример:
    "7"

application/json

Возвращает PurchaseOrder

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/purchase-orders/{purchase_order}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "string",
  "prices_include_tax": true,
  "ordered_total": 0,
  "received_total": 0,
  "expected_on": "2026-01-15",
  "next_delivery_on": "2026-01-15",
  "placed_at": "2026-01-15T12:00:00Z",
  "closed_short": true,
  "supplier_response": "awaiting",
  "revision": 0,
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "unit": "string",
      "ordered_quantity": "string",
      "confirmed_quantity": "string",
      "received_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "ordered_amount": 0,
      "received_amount": 0,
      "promised_on": "2026-01-15",
      "closed_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Изменить заказ поставщику: черновик целиком, размещённый — строки, дату и примечание с ревизией

patch/purchase-orders/{purchase_order}

Scope: procurement:write

Параметры

Путь

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

    ID заказа поставщику.

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает PurchaseOrder

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/purchase-orders/{purchase_order}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "string",
  "prices_include_tax": true,
  "ordered_total": 0,
  "received_total": 0,
  "expected_on": "2026-01-15",
  "next_delivery_on": "2026-01-15",
  "placed_at": "2026-01-15T12:00:00Z",
  "closed_short": true,
  "supplier_response": "awaiting",
  "revision": 0,
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "unit": "string",
      "ordered_quantity": "string",
      "confirmed_quantity": "string",
      "received_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "ordered_amount": 0,
      "received_amount": 0,
      "promised_on": "2026-01-15",
      "closed_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Удалить черновик заказа поставщику

delete/purchase-orders/{purchase_order}

Scope: procurement:write

Параметры

Путь

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

    ID заказа поставщику.

Строка запроса

  • consentobject

    Согласия на последствия правки по видам: consent[<consent_kind>]=<consent_token> из ответа 409 consent_required. Уже данные согласия сохраняются, когда спрашивается следующий вид.

    Поля · 1
    • purchase_order_follow_upstring

      Черновик — дозаказ по решению «докупим у другого» в ответе поставщика другого заказа: удаление снимает это решение, и расхождение исходного заказа снова ждёт решения. source_orders — сколько исходных заказов затронет.

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

Заголовок

  • 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/purchase-orders/{purchase_order}" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'

Отметить черновик размещённым у поставщика

post/purchase-orders/{purchase_order}/place

Scope: procurement:write

Параметры

Путь

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

    ID заказа поставщику.

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает PurchaseOrder

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/purchase-orders/{purchase_order}/place" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "string",
  "prices_include_tax": true,
  "ordered_total": 0,
  "received_total": 0,
  "expected_on": "2026-01-15",
  "next_delivery_on": "2026-01-15",
  "placed_at": "2026-01-15T12:00:00Z",
  "closed_short": true,
  "supplier_response": "awaiting",
  "revision": 0,
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "unit": "string",
      "ordered_quantity": "string",
      "confirmed_quantity": "string",
      "received_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "ordered_amount": 0,
      "received_amount": 0,
      "promised_on": "2026-01-15",
      "closed_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Отменить размещённый заказ поставщику

post/purchase-orders/{purchase_order}/cancel

Scope: procurement:write

Параметры

Путь

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

    ID заказа поставщику.

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает PurchaseOrder

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/purchase-orders/{purchase_order}/cancel" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "string",
  "prices_include_tax": true,
  "ordered_total": 0,
  "received_total": 0,
  "expected_on": "2026-01-15",
  "next_delivery_on": "2026-01-15",
  "placed_at": "2026-01-15T12:00:00Z",
  "closed_short": true,
  "supplier_response": "awaiting",
  "revision": 0,
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "unit": "string",
      "ordered_quantity": "string",
      "confirmed_quantity": "string",
      "received_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "ordered_amount": 0,
      "received_amount": 0,
      "promised_on": "2026-01-15",
      "closed_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}

Закрыть принятый заказ поставщику

post/purchase-orders/{purchase_order}/close

Scope: procurement:write

Параметры

Путь

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

    ID заказа поставщику.

Заголовок

  • Idempotency-Keystring

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

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

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

    Пример:
    "7"

Ответы

200Успешно

Заголовки

  • Idempotent-Replayedstring

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

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

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

    Пример:
    "7"

application/json

Возвращает PurchaseOrder

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/purchase-orders/{purchase_order}/close" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN" \
  -H 'If-Match: "7"'
Пример ответа · 200
{
  "id": 0,
  "version": 0,
  "number": "string",
  "status": "draft",
  "supplier_id": 0,
  "location_id": 0,
  "legal_entity_id": 0,
  "currency": "string",
  "prices_include_tax": true,
  "ordered_total": 0,
  "received_total": 0,
  "expected_on": "2026-01-15",
  "next_delivery_on": "2026-01-15",
  "placed_at": "2026-01-15T12:00:00Z",
  "closed_short": true,
  "supplier_response": "awaiting",
  "revision": 0,
  "note": "string",
  "lines": [
    {
      "id": 0,
      "variant_id": 0,
      "unit": "string",
      "ordered_quantity": "string",
      "confirmed_quantity": "string",
      "received_quantity": "string",
      "unit_cost": 0,
      "cost_per_quantity": "string",
      "ordered_amount": 0,
      "received_amount": 0,
      "promised_on": "2026-01-15",
      "closed_at": "2026-01-15T12:00:00Z"
    }
  ],
  "created_at": "2026-01-15T12:00:00Z",
  "updated_at": "2026-01-15T12:00:00Z"
}