Возвраты поставщику
Товар, отгруженный обратно поставщику: строки, ожидаемая и полученная компенсация — нота кредита, замена товаром или деньги.
Возвраты поставщику
Объекты
SupplierReturn
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
numberstringобязательноНомер возврата.
statusstringобязательноdraft — черновик: остаток не тронут, строки правятся; shipped — отгружен поставщику: остаток списан, ждём компенсацию; closed — закрыт: компенсация получена или отказ отработан; void — аннулирован: остаток возвращён.
- Значения:
draftshippedclosedvoid
reasonstringобязательноПричина возврата: defect — брак; wrong_item — не тот товар; surplus — излишек; recall — отзыв партии; expiry — истёк срок годности; other — другое.
- Значения:
defectwrong_itemsurplusrecallexpiryother
supplier_idintegerобязательноID поставщика (/v1/suppliers).
legal_entity_idinteger или nullобязательноID юрлица магазина, на которое ждём ноту кредита (/v1/legal-entities); null у старых возвратов.
location_idintegerобязательноID точки, откуда уехал товар (/v1/locations).
goods_receipt_idinteger или nullобязательноID исходной приёмки (/v1/goods-receipts); null — возврат без приёмки, цена из себестоимости.
purchase_order_idinteger или nullобязательноID заказа поставщику (/v1/purchase-orders); null без заказа.
issued_onstring (date) или nullобязательноДата документа — день в акте сверки и на бумаге, YYYY-MM-DD; null у черновика.
currencystringобязательноВалюта возврата, ISO 4217: в ней цены строк, subtotal и settled_amount.
exchange_ratestring или nullобязательноКурс валюты возврата к валюте магазина десятичной строкой, снимок на отгрузке; null до отгрузки.
subtotalintegerобязательноСтоимость строк возврата в валюте возврата.
base_subtotalintegerобязательноСтоимость строк в валюте магазина по курсу-снимку.
expected_settlementstring или nullобязательноЧего ждём от поставщика, задаётся на отгрузке: credit_note — нота кредита; replacement — замена товаром; refund — деньги; none — без компенсации; null — не задано.
- Значения:
credit_notereplacementrefundrejectednonenull
settlementstring или nullобязательноЧто получили на закрытии: credit_note — нота кредита; replacement — замена; refund — деньги; rejected — поставщик отказал; none — без компенсации; null — возврат не закрыт.
- Значения:
credit_notereplacementrefundrejectednonenull
settled_amountinteger или nullобязательноСколько признал поставщик, в валюте возврата; null — ещё не признано.
base_settled_amountinteger или nullобязательноПризнанное поставщиком в валюте магазина по курсу-снимку; null — ещё не признано.
shipped_atstring (date-time) или nullобязательноКогда товар отгружен поставщику; null у черновика.
closed_atstring (date-time) или nullобязательноКогда возврат закрыт; null у незакрытого.
voided_atstring (date-time) или nullобязательноКогда возврат аннулирован; null у действующего.
void_reasonstring или nullобязательноПочему возврат аннулировали; null у действующего и у старых документов.
notestring или nullобязательноЗаметка сотрудника; null, если её нет.
linesмассив objectобязательноСтроки возврата.
Поля · 15
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
variant_idinteger или nullобязательноID варианта товара (/v1/variants).
lot_idinteger или nullобязательноID партии строки (/v1/lots); null — товар без партий.
goods_receipt_line_idinteger или nullобязательноID строки исходной приёмки (lines[].id приёмки), откуда взята цена; null у строки без приёмки.
purchase_order_line_idinteger или nullобязательноID строки заказа поставщику (lines[].id заказа); null без заказа.
unitstring или nullобязательноБазовая единица количеств строки: pcs — штуки, g — граммы, ml — миллилитры.
quantitystring или nullобязательноСколько уехало поставщику, десятичной строкой в базовой единице.
settled_quantitystring или nullобязательноСколько из уехавшего признал поставщик.
unit_costinteger или nullобязательноЦена в валюте возврата за cost_per_quantity; null — цены нет.
cost_per_quantitystring или nullобязательноЗа какое количество в базовой единице указана цена: "1000" у весового товара — за килограмм.
store_unit_cost_microinteger или nullобязательноТа же цена в валюте магазина, в миллионных долях минорной единицы; null — цены нет.
amountintegerобязательноСтоимость уехавшего по цене строки; сумма по строкам — subtotal.
settled_amountintegerобязательноСтоимость признанного поставщиком по цене строки.
reasonstring или nullобязательноПричина строки теми же кодами, что reason документа; null — причина документа.
- Значения:
defectwrong_itemsurplusrecallexpiryothernull
notestring или nullобязательноЗаметка к строке; null, если её нет.
correctionsмассив objectобязательноКорректировки отгруженного возврата по порядку.
Поля · 7
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
numberstringобязательноНомер корректировки.
reasonstringобязательноПочему исправили; печатается на акте и видна поставщику.
subtotal_beforeintegerобязательноsubtotal до корректировки.
subtotal_afterintegerобязательноsubtotal после корректировки.
linesмассив objectобязательноИсправленные строки: было и стало.
Поля · 6
supplier_return_line_idinteger или nullобязательноID строки возврата (lines[].id); null — корректировка строку сняла.
variant_idinteger или nullобязательноID варианта товара строки (/v1/variants).
quantity_beforestring или nullобязательноКоличество до корректировки, в базовой единице.
quantity_afterstring или nullобязательноКоличество после корректировки, в базовой единице.
reason_beforestring или nullобязательноПричина строки до корректировки; null — причина документа.
- Значения:
defectwrong_itemsurplusrecallexpiryothernull
reason_afterstring или nullобязательноПричина строки после корректировки; null — причина документа.
- Значения:
defectwrong_itemsurplusrecallexpiryothernull
created_atstring (date-time)обязательноКогда корректировку провели.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Возвраты поставщику: отгруженный обратно товар и компенсация за него
get/supplier-returns
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_deletedbooleantrue — отдавать и удалённые записи: архивные с заполненным deleted_at и стёртые из базы — отметками об удалении {id, deleted_at} в продолжении по курсору синхронизации. Включайте для синхронизации.
supplier_idintegerТолько документы этого поставщика.
- Минимум:
- 1
goods_receipt_idintegerТолько возвраты из этой приёмки.
- Минимум:
- 1
Ответы
200Успешно
application/json
Записи страницы.
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/supplier-returns" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"number": "string",
"status": "draft",
"reason": "defect",
"supplier_id": 0,
"legal_entity_id": 0,
"location_id": 0,
"goods_receipt_id": 0,
"purchase_order_id": 0,
"issued_on": "2026-01-15",
"currency": "string",
"exchange_rate": "string",
"subtotal": 0,
"base_subtotal": 0,
"expected_settlement": "credit_note",
"settlement": "credit_note",
"settled_amount": 0,
"base_settled_amount": 0,
"shipped_at": "2026-01-15T12:00:00Z",
"closed_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"void_reason": "string",
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"lot_id": 0,
"goods_receipt_line_id": 0,
"purchase_order_line_id": 0,
"unit": "string",
"quantity": "string",
"settled_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"store_unit_cost_micro": 0,
"amount": 0,
"settled_amount": 0,
"reason": "defect",
"note": "string"
}
],
"corrections": [
{
"id": 0,
"number": "string",
"reason": "string",
"subtotal_before": 0,
"subtotal_after": 0,
"lines": [
{
"supplier_return_line_id": 0,
"variant_id": 0,
"quantity_before": "string",
"quantity_after": "string",
"reason_before": "defect",
"reason_after": "defect"
}
],
"created_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"
}Возврат поставщику
get/supplier-returns/{supplier_return}
Scope: procurement:read
Параметры
Путь
supplier_returnintegerобязательноID возврата поставщику.
Ответы
200Успешно
application/json
Возвращает SupplierReturn
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/supplier-returns/{supplier_return}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"number": "string",
"status": "draft",
"reason": "defect",
"supplier_id": 0,
"legal_entity_id": 0,
"location_id": 0,
"goods_receipt_id": 0,
"purchase_order_id": 0,
"issued_on": "2026-01-15",
"currency": "string",
"exchange_rate": "string",
"subtotal": 0,
"base_subtotal": 0,
"expected_settlement": "credit_note",
"settlement": "credit_note",
"settled_amount": 0,
"base_settled_amount": 0,
"shipped_at": "2026-01-15T12:00:00Z",
"closed_at": "2026-01-15T12:00:00Z",
"voided_at": "2026-01-15T12:00:00Z",
"void_reason": "string",
"note": "string",
"lines": [
{
"id": 0,
"variant_id": 0,
"lot_id": 0,
"goods_receipt_line_id": 0,
"purchase_order_line_id": 0,
"unit": "string",
"quantity": "string",
"settled_quantity": "string",
"unit_cost": 0,
"cost_per_quantity": "string",
"store_unit_cost_micro": 0,
"amount": 0,
"settled_amount": 0,
"reason": "defect",
"note": "string"
}
],
"corrections": [
{
"id": 0,
"number": "string",
"reason": "string",
"subtotal_before": 0,
"subtotal_after": 0,
"lines": [
{
"supplier_return_line_id": 0,
"variant_id": 0,
"quantity_before": "string",
"quantity_after": "string",
"reason_before": "defect",
"reason_after": "defect"
}
],
"created_at": "2026-01-15T12:00:00Z"
}
],
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}