SelSup Developers

Грамадскае API · API Падпісанне

Вяртанне

Завяршальныя пункты для вяртання, уключаючы дакладныя маршруты, параметры, органы запыту і схемы адказу, якія могуць быць пашыраны.

3 канчатковыя пункты/api/returnСтабільныМашыначытна чытае апісанне ↗
{ }

Гэты старонка падтрымліваецца рэдагаваць самастойны кантракт.

/api/return

Готовыя да выкарыстання працоўныя патокі

Готовыя да выкарыстання працоўныя патокі

01

Пачніце выкарыстоўваць вяртанне

Выкарыстоўвайце адмысловы токен API і пацвердзіце аперацыі чытання з дадзенымі тэсту спачатку.

  1. Захоўвайце знак з боку сервера і адправіце яго ў заголоўку Authorization.
  2. Праверце патрабаваныя параметры і пашырыць схему запыту або адказу.
  3. Выкарыстоўвайце стан HTTP і стабільнае поле error ў памылках прыкладання.

Мадэль дадзеных

Структуры дадзеных

Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.

FileExportColumn5 палёў
idinteger · int64

Id.

fileExportIdinteger · int64

Файл экстраднай пазнакі.

columnNamestring

Назва колонкі.

columnOrderinteger · int32

Колонна ордэн.

isEnabledboolean

Здаецца.

TmsTask25 палёў
idinteger · int64

Id.

read-only
statusstring

Status.

read-only
typestring

Type.

read-only
namestring

Назва.

clientIdinteger · int64

Ідэнтыфікатар кліента.

entityIdinteger · int64

Ід суб'екта.

progressinteger · int32

Прагрэс.

processedQuantityinteger · int32

Працаванае колькасць.

organizationIdinteger · int64

Ід арганізацыі.

priorityinteger · int32

Пераважнасць.

propertiesstring

Маёмасці.

messagestring

Паведамленне.

messageParamsstring

Паведамленне Params.

createdDatestring · date-time

Стварыўся Дата.

startDatestring · date-time

Пачатак дата.

finishDatestring · date-time

Дата заканчэння.

urlstring

Ураль.

inputFileUrlstring

Уклад файла URL.

retryNumberinteger · int32

Перапрабаваць нумар.

userIdinteger · int32

Пазнак карыстальніка.

retryDatestring · date-time

Перапрабаваць дату.

debugboolean

Адладкаванне.

forcedStartboolean

Насілле пачатак.

servicestring

Паслуга.

langstring

Lang.

FindResponseReturnReport1 палёў
rowsReturnReport[]

Рыжкі.

ReturnReport28 палёў
idinteger · int64

Id.

orderTypestring

Тып парадку.

orderBarcodestring

Замовіць Баркод.

barcodestring

Бар-код.

productBarcodestring

Баркод прадукту.

articlestring

Артыкул.

externalOrderIdstring

Ід знешняга парадку.

returnOrderIdstring

Вярнуць пазнаку ордэна.

externalProductIdinteger · int64

Па-за межамі ID прадукту.

quantityinteger · int32

Колькасць.

officeIdinteger · int64

Пазнак офіса.

officeAddressstring

Адрас офіса.

orderIdinteger · int64

Падпісанне па заказ.

pricenumber · double

Прэс.

currencyCodestring

Код валюты.

orderProductIdinteger · int64

Заказ ID прадукту.

returnDatestring · date-time

Дата вяртання.

returnReasonNamestring

Верніце імя прычыны.

statusstring

Status.

modifyDatestring · date-time

Падправіць дату.

createdDatestring · date-time

Стварыўся Дата.

uniqueIdstring

Унікальная пазнака.

servicestring

Паслуга.

productIdinteger · int64

Ід прадукту.

productViewIdinteger · int64

Паказальнік прадукту.

productModelIdinteger · int64

Ід мадэля прадукту.

clientIdinteger · int64

Ідэнтыфікатар кліента.

organizationIdinteger · int64

Ід арганізацыі.

Памылка дагавор

Як вяртаюць памылкі прыкладання

Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.

error

Стабільны машыначытай код для інтэграцыйнай логікі.

localMessage

Паведамленне гатовае да адлюстравання на мове карыстальніка токены API.

params

Значэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.

localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак Accept-Language не змяняюць яго; руская выкарыстоўваецца, калі карыстацкая мова не канфігуруецца.

RUМясцовасць карыстальніка ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
BEБеларуская (be)
{
  "error": "error_brand_already_exists",
  "localMessage": "Брэнд Base ужо існуе",
  "params": {
    "name": "Base"
  }
}

Канчатковыя пункты

Канчатковыя пункты

POST

Скачаем

/api/return/download
Знак з пісьмовым доступам

Скарыстайцеся з дапамогай POST /api/return/download.

Параметры запытаў

ПолеТыпАбавязковаАпісанне
productAnalyticField stringBARCODE, COLOR, ARTICLE, BRAND, CATEGORY Так Аналітычная паліца прадукту.
query string Не Запытваючы.
withDuplicate boolean Не З Дублікат.
withBonus boolean Не З Бонусам.
byOrgAndService boolean Не У арганізацыі і службе.
byOrderType boolean Не Па тыпу парадку.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
sortBy string Не Пасля.
ascending boolean Не Падыходзіць.
id integer · int64 Не Id.
isMarketPlaceStructure boolean Не Гэта структура рынку.
isDashboard boolean Не Гэта Дашборд.
analyticsField stringPRODUCT, MODEL, GROUP, ORGANIZATION, CLIENT, CATEGORY, PRODUCT_VIEW, BRAND, REGION, WAREHOUSE Не Аналітычнае поле.
planDayCount integer · int32 Не План дзень лічыць.
daysToSupply integer · int32 Не Дні для пастаўкі.
plannedSupplyDate string · date-time Не Плануецца дата пастаўкі.
groupByView boolean Не Група па пункту гледжання.
warehouses integer[] Не Аховы.
salesModels string[] Не Мадэлі продажаў.
aggregation stringWAREHOUSE, WAREHOUSE_PRODUCT Не Агрэгацыя.
columns FileExportColumn[] Не Коланы.
Структура элементаў масіва FileExportColumn
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
fileExportId integer · int64 Не Файл экстраднай пазнакі.
columnName string Не Назва колонкі.
columnOrder integer · int32 Не Колонна ордэн.
isEnabled boolean Не Здаецца.
regions string[] Не Рэгіёны.
group boolean Не Група.
calculationByOrders boolean Не Вылічэнне па загадках.
sourceReport stringDEFAULT, ORDER, SALES, PROFIT, OZON, YANDEX_MARKET, WB_REALIZATION_FILE, WB_DETAILED_REPORT_FILE, OZON_REALIZATION_FILE, OZON_REALIZATION_FILE_NEW, OZON_COMPENSATIONS_FILE, OZON_SERVICES_FILE, OZON_CASH_FLOW_STATEMENT, WB_CAMPAIGN, SBER_MEGA_MARKET_FILES, YANDEX_MARKET_FILE_DETAILS, WB_RETURNS_REPORT, OWN_DELIVERY, OZON_CAMPAIGN_SKU_REPORT, WB_PAID_STORAGE, YANDEX_MARKET_NETTING, OZON_CPO_SKU_REPORT, UZUM, UZUM_EXPENSES, DEFECT_WRITE_OFF, LOCAL_ORDER, EXTERNAL_CAMPAIGN Не Паведамленне крыніцы.
skipDayWithoutStocks boolean Не Перапусціце дзень без акцый.
replaceSetsByComponents boolean Не Замяніць наборы з кампанентамі.
distributeFbsByWarehouse boolean Не Распаўсюджваць ФБС па складзе.
distributeFbsStock boolean Не Распрацоўваць ФБС акцыі.
ignoreDumping boolean Не Ігнаруйце Dumping.
isSaleStructure boolean Не Гэта структура продажу.
isAveragePerOneUnit boolean Не Гэта сярэдняя частка на адзінку.
updateDate boolean Не Дата абнаўлення.
useWeightedGroup boolean Не Выкарыстоўвайце групу вага.
isFindirRequest boolean Не Гэта Findir Запыту.
brandIds integer[] Не Ідэнтыфікацыя брэнда.
categoryIds integer[] Не Пазнакі катэгорыі.
articles string[] Не Артыкулы.
colors string[] Не Колер.
sizes string[] Не Памераў.
barcodes string[] Не Баркоды.
tagIds integer[] Не Пазначыць пазнакі.
penaltyFrom number · double Не Пакаранне ад.
penaltyTo number · double Не Пакаранне да.
logisticsFrom number · double Не Логістычная ад.
logisticsTo number · double Не Логістыка да.
marginFrom number · double Не Маржы ад.
marginTo number · double Не Маржы на.
salesAmountFrom number · double Не Пакупкі ад.
salesAmountTo number · double Не Колькасць продажаў да.
totalSalesAmountFrom number · double Не Агульная колькасць продажаў ад.
totalSalesAmountTo number · double Не Агульная колькасць продажаў да.
grossProfitFrom number · double Не Усяго прыбытак ад.
grossProfitTo number · double Не Усяго прыбытак.
taxNds integer · int32 Не Падатковыя НД.
useOsno boolean Не Выкарыстоўвайце Осно.
period stringDAY, WEEK, MONTH, QUARTER, YEAR, MONTH_3, MONTH_6, END_OF_TARIFF, MONTH_7, MONTH_14, YEAR_2 Не Перыяд.
dateFrom string · date-time Так Дата ад.
dateTo string · date-time Так Дата да.
services string[] Не Паслугі.
categories integer[] Не Катэгорыі.
brands integer[] Не Брандз.
clientOrganizationId integer · int64 Не Ід арганізацыі кліента.
organizations integer[] Не Арганізацыі.
ids integer[] Не Пазнакі.
type stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION Не Type.
types string[] Не Тыпы.
status stringCREATED, REVOKING, REVOKED, ORDER_CREATED, CARDS_CREATED, BOX_BARCODES, IMAGES_UPLOADED, INVOICE_UPLOADED, READY_TO_SUPPLY, SUPPLIED, FINISHED, COLLECTED, SEND, DELIVERY, REFUND, COLLECTING, PACKING, PAYMENT_REQUIRED, CANCELED, CONTROVERSIAL, OVERDUE, READY_FOR_PICKUP, WAITING_SUPPLY, PICK_UP_REFUND, REFUND_RECEIVED, DELETED, RESTORE, PRODUCTION_CONFIRMED Не Status.
timeZone integer · int32 Не Часная зона.
previousDateFrom string · date-time Не Папярэдняя дата ад.
clientOrganizationIds integer[] Не Пазнакі арганізацыі кліентаў.
ignoreCredit boolean Не Ігнаруйце Крэдыт.
curl --request POST 'https://api.selsup.ru/api/return/download?productAnalyticField=BARCODE&limit=50&page=1&dateFrom=2026-01-15T12%3A00%3A00Z&dateTo=2026-01-15T12%3A00%3A00Z' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў TmsTask
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
status stringCREATED, RUNNING, FINISHED, ERROR, RESTARTING, INTERRUPTING, INTERRUPTED, STOPPED, EXCEPTION Не Status.
type stringWILDBERRIES_CREATE_CARD, NATIONAL_CATALOG_CREATE_CARD, OZON_CREATE_CARD, OZON_CARDS_IMPORT, IMPORT_FBS_ORDERS, UPLOAD_PHOTOGRAPHY, WILDBERRIES_UPDATE_PRICE, WILDBERRIES_CARD_IMPORT, WILDBERRIES_CARD_UPDATE, SELSUP_STOCKS, REFRESH_PHOTOGRAPHY, SUPPLYING_QUANTITY_TASK, EXPORT_PRICE, OZON_UPDATE_PRICE, WILDBERRIES_FILE_TASK, YANDEX_MARKET_CARD_CREATE, OZON_CARD_UPDATE_TASK, OZON_IMPORT_STAT_TASK, WILDBERRIES_PROFIT_STAT_TASK, ALIEXPRESS_CREATE_CARD_TASK, ALIEXPRESS_UPDATE_CARD_TASK, PRICES_IMPORT_TASK, WILDBERRIES_PRICES_TASK, YANDEX_MARKET_CARD_IMPORT, STOCKS_UPDATE, WILDBERRIES_STOCKS_IMPORT_TASK, WILDBERRIES_ORDERS_AND_SALES_TASK, WILDBERRIES_INCOMES_IMPORT_TASK, OZON_STOCKS_IMPORT_TASK, TURNOVER_DOCUMENTS_TASK, INTRODUCE_WMS_ITEMS_TASK, PRODUCTS_FILE_TASK, MODELS_FILE_TASK, UPDATE_PRODUCT_CODES_TASK, INTRODUCE_CODES_TASK, PRODUCTS_IMPORT_TASK, PRICES_FILE_TASK, YANDEX_MARKET_UPDATE_PRICE_TASK, IMPORT_STOCKS_TASK, MOY_SKLAD_EXPORT_ORDERS, MERGE_PRODUCTS_TASK, PRODUCTS_WILDBERRIES_EXCEL_IMPORT_TASK, MOY_SKLAD_CREATE_CARD, IMPORT_FBO_STOCKS_FROM_FILE, CREATE_WMS_ITEMS, MOY_SKLAD_CARDS_IMPORT, PROMOTION_FILE, UNUSED_1, UNUSED, PRODUCT_ANALYTICS_FILE_TASK, PROMOTION_RESET_FILE, MOY_SKLAD_IMPORT_ORDERS, FINANCE_REPORT_FILE_TASK, YML_FILE_EXPORT, PRODUCT_BALANCE_REPORT_FILE_TASK, CURRENT_PRODUCT_BALANCE_FILE_TASK, IMPORT_TRANSACTIONS, MATCH_UNREGISTERED_PROFIT_REPORT_TASK, UPDATE_AVERAGE_SERVICE_EXPENSES_TASK, YANDEX_MARKET_ORDER_IMPORT_STAT_TASK, ABC_REPORT_FILE_TASK, MODEL_CONTRACTORS_IMPORT, MODEL_CONTRACTORS_EXPORT, BANK_TRANSACTION_IMPORT_FILE_TASK, YML_IMPORT_TASK, SALES_DYNAMIC_REPORT_FILE_TASK, UPDATE_FBS_ORDERS, EXPORT_TRANSACTION_IN_EXCEL_FILE_TASK, IMPORT_TRANSACTION_FROM_EXCEL_FILE_TASK, EXPORT_PROFIT_REPORT_FILE_TASK, IMPORT_PROFIT_REPORT_FROM_EXCEL_FILE_TASK, IMPORT_REALIZATION_REPORT_TASK, STOCK_RECONCILIATION, ORDER_REPORT_FILE_TASK, GET_WB_FBO_ORDER_FROM_PROFIT_REPORT_TASK, TO_QUANTITY_STORAGE_METHOD, APPLY_RECONCILIATION, OZON_IMPORT_FBO_ORDERS_TASK, UPDATE_PURCHASE_PRICE_IN_PROFIT_REPORT_TASK, FBS_LABELS, MERGE_PRODUCT_STOCKS, CREATE_ORDER_FROM_FILE, ALIEXPRESS_CARD_IMPORT, PRICE_LIST_IMPORT, WB_STOCK_REPORT_FILE, CONTRACTORS_REPORT_FILE, PRODUCTS_SBER_MEGA_MARKET_EXCEL_IMPORT_TASK, EXPORT_PROBLEMATIC_PRODUCT_REPORT, PLAN_SUPPLY_REPORT_TASK, PLAN_FACT_SALES_REPORT_FILE, IMPORT_PLAN_SALES_FROM_EXCEL_FILE_TASK, EXPORT_PLAN_SALES_EXCEL_FILE_TASK, ORDERS_TO_BUY_FILE_TASK, MERGE_PRICE_ON_OTHER_MP_TASK, MATCH_PRODUCT_LAST_OPERATION_DATE_TASK, PROBLEMATIC_PRODUCT_PRICE_FILE_TASK, CATEGORIES_IMPORT_EXCEL_TASK, AVITO_CARD_IMPORT, UPDATE_OLD_WB_ORDER_STATUSES_TASK, PRESTA_SHOP_IMPORT_TASK, PRODUCTS_AVITO_EXCEL_IMPORT_TASK, FBO_STOCK_RECONCILIATION_TASK, APPLY_FBO_RECONCILIATION_TASK, EXPORT_REPRICE_PRODUCT_CONFIG_TASK, IMPORT_REPRICE_PRODUCT_CONFIG_TASK, OZON_CASH_FLOW_STATEMENT_IMPORT_TASK, IMPORT_PROMOTION_STRATEGY_FILE_TASK, UPDATE_ORDER_DELIVERY_INFO_TASK, BILLING_OPERATION_TASK, SET_PURCHASE_PERCENT_TASK, REMOVE_PRODUCT_IMAGES_TASK, STRUCTURE_TURNOVER_TASK, OZON_NEW_UPDATE_PRICE, REPLACE_PRODUCT_IMAGE_TASK, UPDATE_OZON_PROMOTION_DATA_TASK, WILDBERRIES_IMPORT_CAMPAIGN_TASK, WILDBERRIES_STORAGE_REPORT_TASK, WEBASYST_LINK_ARTICLE_TASK, DELIVERY_SERVICE_LABELS, HAND_ON_PULSE_FILE_TASK, ITEMS_INCOME_EXCEL_TASK, UPDATE_SETS_EXCEL_TASK, DELETE_PROFIT_REPORTS_BY_FILE_HISTORY_IDS_TASK, EXPORT_PRODUCT_SETS_TASK, AMAZON_CARD_IMPORT, IMPORT_ACCEPTED_PRODUCTS_TASK, ADD_ORDER_PRODUCT_FROM_FILE_TASK, EXPORT_ITEM_HISTORY_FILE_TASK, WILDBERRIES_IMPORT_CAMPAIGN_BY_EXCEL_TASK, REMOVE_CLIENT_ORGANIZATION, EBAY_CARD_IMPORT_TASK, PRODUCTS_IMPORT_FROM_ORGANIZATION_TASK, IMPORT_FBO_ORDERS, LAMODA_CARD_IMPORT, UPDATE_WB_PROMOTION_DATA_TASK, IMPORT_RETURNS_REPORT_TASK, UPDATE_PROMOTION_DATA_TASK, RESTORE_CLIENT_ORGANIZATION, LEROY_MERLIN_CARD_IMPORT, YANDEX_MARKET_STOCKS_IMPORT_TASK, WILDBERRIES_IMPORT_NM_REPORT_TASK, ORDER_ANALYTICS_FILE_TASK, CLIENT_DATABASE_MOVE_TASK, FAST_CARD_IMPORT, EXPORT_PRODUCT_CODE, INSALES_CARD_IMPORT_TASK, REMOVE_PRODUCT_VIDEOS_TASK, UPDATE_CARDS_TASK, FIND_UNPROFITABLE_PRODUCTS_TASK, FIND_UNPURCHASED_PRODUCTS_TASK, WALMART_CARD_IMPORT, PRODUCT_GROUPS_TASK, CONTRACTOR_ARTICLE_EXPORT_TASK, CONTRACTOR_ARTICLE_IMPORT_TASK, CURRENCY_CONVERSION_TASK, UPDATE_SUPPLY_PLAN_REPORT_TASK, EXPORT_SUPPLY_PLAN_REPORT_FILE_TASK, CHECK_STOCK_ORDER, PHOTOGRAPHY_EXCEL, PREPARE_FINDIR_DATA_TASK, CARD_SPLITTING_TASK, EXPORT_IMAGE_UPDATES_TEMPLATE_TASK, IMPORT_IMAGE_UPDATES_TASK, PREPARE_PRODUCT_HAND_ON_PULSE_TASK, UPDATE_OZON_AVERAGE_DELIVERY_TIME, UPDATE_COMMISSIONS_TASK, WOOCOMMERCE_CARD_IMPORT, UPDATE_FBS_STOCKS_HISTORY, RETURNS_FILE_TASK, FAST_PRODUCTS_IMPORT_TASK, ANALYZE_PRODUCT_CARDS_TASK, DETMIR_CARD_IMPORT, MATCH_OZON_REALIZATION_REPORT_TASK, MAGNIT_IMPORT_PRODUCTS_TASK, UPDATE_PURCHASE_PRICE_FROM_STOCKS_IN_PROFIT_REPORT_TASK, MOY_SKLAD_FBO_MP_DATES_FIX, PRICE_HISTORY_FILE_TASK, FBM_ORDERS_IMPORT_TASK, UZUM_IMPORT_PRODUCTS_TASK, OPENCART_CARD_IMPORT, CARDS_IMPORT, OZON_CROSSDOCK_TRANSIT_ROUTES_TASK, UNUSED_2, OZON_IMPORT_SALES_FUNNEL_REPORT_TASK, WRITE_OFF_PRODUCTS_FILE_TASK, CLIENT_DATABASE_CREATE_TASK, UPDATE_FBS_LABELS_TASK, REBUILD_PROFIT_REPORT_HOURLY_AGGREGATE_TASK, OZON_IMPORT_CAMPAIGN_TASK, EXPORT_SUPPLY_PLAN_FILE_TASK, IMPORT_SUPPLY_PLAN_FILE_TASK, CREATE_SERVICE_CARDS, WAREHOUSE_ECONOMICS_FILE_TASK, UPDATE_WILDBERRIES_ACQUIRING_RATE_TASK, PRODUCT_SALES_FORECAST_TASK, UPDATE_PRODUCT_CODES_STATUSES_TASK, MARKETPLACE_UPDATE_PRICE_TASK, UZUM_IMPORT_STAT_TASK, CAMPAIGN_STATS_FILE_TASK, OZON_FBO_WORKFLOW_TASK, EXPORT_CERTIFICATE_TEMPLATE_TASK, IMPORT_CERTIFICATES_TASK, REBUILD_LOCAL_ORDER_PROFIT_REPORT_TASK, SHOPIFY_CARD_IMPORT Не Type.
name string Не Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
entityId integer · int64 Не Ід суб'екта.
progress integer · int32 Не Прагрэс.
processedQuantity integer · int32 Не Працаванае колькасць.
organizationId integer · int64 Не Ід арганізацыі.
priority integer · int32 Не Пераважнасць.
properties string Не Маёмасці.
message string Не Паведамленне.
messageParams string Не Паведамленне Params.
createdDate string · date-time Не Стварыўся Дата.
startDate string · date-time Не Пачатак дата.
finishDate string · date-time Не Дата заканчэння.
url string Не Ураль.
inputFileUrl string Не Уклад файла URL.
retryNumber integer · int32 Не Перапрабаваць нумар.
userId integer · int32 Не Пазнак карыстальніка.
retryDate string · date-time Не Перапрабаваць дату.
debug boolean Не Адладкаванне.
forcedStart boolean Не Насілле пачатак.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
lang string Не Lang.
{
  "id": 1001,
  "status": "CREATED",
  "type": "WILDBERRIES_CREATE_CARD",
  "name": "Example",
  "clientId": 1001,
  "entityId": 1001
}
Памылкі5

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_analytics_access_denied
Дадзеныя аналітыкі канфідэнцыйныя для ролі SUPPORT

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_analytics_access_denied ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_organization_not_found
Не знойдзена арганізацыя

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_organization_not_found ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Знайсці

/api/return/find
Значок з чытальным доступам

Знайсці з дапамогай GET /api/return/find.

Параметры запытаў

ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
organizationId integer · int64 Не Ід арганізацыі.
orderType stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION Не Тып парадку.
orderBarcode string Не Замовіць Баркод.
services string[] Не Паслугі.
barcode string Не Бар-код.
productBarcode string Не Баркод прадукту.
article string Не Артыкул.
externalOrderId string Не Ід знешняга парадку.
returnOrderId string Не Вярнуць пазнаку ордэна.
externalProductId integer · int64 Не Па-за межамі ID прадукту.
officeId integer · int64 Не Пазнак офіса.
officeAddress string Не Адрас офіса.
orderId integer · int64 Не Падпісанне па заказ.
orderProductId integer · int64 Не Заказ ID прадукту.
returnReasonName string Не Верніце імя прычыны.
status string Не Status.
timeZone integer · int32 Не Часная зона.
modifyDate string · date-time Не Падправіць дату.
dateFrom string · date-time Не Дата ад.
dateTo string · date-time Не Дата да.
modifiedDateFrom string · date-time Не Змена даты ад.
modifiedDateTo string · date-time Не Падведзеная дата да.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringID, ORDER_TYPE, ORDER_BARCODE, BARCODE, PRODUCT_BARCODE, ARTICLE, EXTERNAL_ORDER_ID, RETURN_ORDER_ID, EXTERNAL_PRODUCT_ID, QUANTITY, OFFICE_ID, OFFICE_ADDRESS, ORDER_ID, PRICE, CURRENCY_CODE, SERVICE_ID, ORGANIZATION_ID, CREATED_DATE, RETURN_DATE, RETURN_REASON_NAME, STATUS, MODIFY_DATE Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/return/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseReturnReport
ПолеТыпАбавязковаАпісанне
rows ReturnReport[] Не Рыжкі.
Структура элементаў масіва ReturnReport
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
orderType string Не Тып парадку.
orderBarcode string Не Замовіць Баркод.
barcode string Не Бар-код.
productBarcode string Не Баркод прадукту.
article string Не Артыкул.
externalOrderId string Не Ід знешняга парадку.
returnOrderId string Не Вярнуць пазнаку ордэна.
externalProductId integer · int64 Не Па-за межамі ID прадукту.
quantity integer · int32 Не Колькасць.
officeId integer · int64 Не Пазнак офіса.
officeAddress string Не Адрас офіса.
orderId integer · int64 Не Падпісанне па заказ.
price number · double Не Прэс.
currencyCode string Не Код валюты.
orderProductId integer · int64 Не Заказ ID прадукту.
returnDate string · date-time Не Дата вяртання.
returnReasonName string Не Верніце імя прычыны.
status string Не Status.
modifyDate string · date-time Не Падправіць дату.
createdDate string · date-time Не Стварыўся Дата.
uniqueId string Не Унікальная пазнака.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
productId integer · int64 Не Ід прадукту.
productViewId integer · int64 Не Паказальнік прадукту.
productModelId integer · int64 Не Ід мадэля прадукту.
clientId integer · int64 Не Ідэнтыфікатар кліента.
organizationId integer · int64 Не Ід арганізацыі.
{
  "rows": "string"
}
Памылкі5

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_analytics_access_denied
Дадзеныя аналітыкі канфідэнцыйныя для ролі SUPPORT

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_analytics_access_denied ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Вяртае файл

/api/return/file
Значок з чытальным доступам

Вяртае файл з дапамогай GET /api/return/file.

Параметры запытаў

ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
organizationId integer · int64 Не Ід арганізацыі.
orderType stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION Не Тып парадку.
orderBarcode string Не Замовіць Баркод.
services string[] Не Паслугі.
barcode string Не Бар-код.
productBarcode string Не Баркод прадукту.
article string Не Артыкул.
externalOrderId string Не Ід знешняга парадку.
returnOrderId string Не Вярнуць пазнаку ордэна.
externalProductId integer · int64 Не Па-за межамі ID прадукту.
officeId integer · int64 Не Пазнак офіса.
officeAddress string Не Адрас офіса.
orderId integer · int64 Не Падпісанне па заказ.
orderProductId integer · int64 Не Заказ ID прадукту.
returnReasonName string Не Верніце імя прычыны.
status string Не Status.
timeZone integer · int32 Не Часная зона.
modifyDate string · date-time Не Падправіць дату.
dateFrom string · date-time Не Дата ад.
dateTo string · date-time Не Дата да.
modifiedDateFrom string · date-time Не Змена даты ад.
modifiedDateTo string · date-time Не Падведзеная дата да.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringID, ORDER_TYPE, ORDER_BARCODE, BARCODE, PRODUCT_BARCODE, ARTICLE, EXTERNAL_ORDER_ID, RETURN_ORDER_ID, EXTERNAL_PRODUCT_ID, QUANTITY, OFFICE_ID, OFFICE_ADDRESS, ORDER_ID, PRICE, CURRENCY_CODE, SERVICE_ID, ORGANIZATION_ID, CREATED_DATE, RETURN_DATE, RETURN_REASON_NAME, STATUS, MODIFY_DATE Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/return/file?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў TmsTask
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
status stringCREATED, RUNNING, FINISHED, ERROR, RESTARTING, INTERRUPTING, INTERRUPTED, STOPPED, EXCEPTION Не Status.
type stringWILDBERRIES_CREATE_CARD, NATIONAL_CATALOG_CREATE_CARD, OZON_CREATE_CARD, OZON_CARDS_IMPORT, IMPORT_FBS_ORDERS, UPLOAD_PHOTOGRAPHY, WILDBERRIES_UPDATE_PRICE, WILDBERRIES_CARD_IMPORT, WILDBERRIES_CARD_UPDATE, SELSUP_STOCKS, REFRESH_PHOTOGRAPHY, SUPPLYING_QUANTITY_TASK, EXPORT_PRICE, OZON_UPDATE_PRICE, WILDBERRIES_FILE_TASK, YANDEX_MARKET_CARD_CREATE, OZON_CARD_UPDATE_TASK, OZON_IMPORT_STAT_TASK, WILDBERRIES_PROFIT_STAT_TASK, ALIEXPRESS_CREATE_CARD_TASK, ALIEXPRESS_UPDATE_CARD_TASK, PRICES_IMPORT_TASK, WILDBERRIES_PRICES_TASK, YANDEX_MARKET_CARD_IMPORT, STOCKS_UPDATE, WILDBERRIES_STOCKS_IMPORT_TASK, WILDBERRIES_ORDERS_AND_SALES_TASK, WILDBERRIES_INCOMES_IMPORT_TASK, OZON_STOCKS_IMPORT_TASK, TURNOVER_DOCUMENTS_TASK, INTRODUCE_WMS_ITEMS_TASK, PRODUCTS_FILE_TASK, MODELS_FILE_TASK, UPDATE_PRODUCT_CODES_TASK, INTRODUCE_CODES_TASK, PRODUCTS_IMPORT_TASK, PRICES_FILE_TASK, YANDEX_MARKET_UPDATE_PRICE_TASK, IMPORT_STOCKS_TASK, MOY_SKLAD_EXPORT_ORDERS, MERGE_PRODUCTS_TASK, PRODUCTS_WILDBERRIES_EXCEL_IMPORT_TASK, MOY_SKLAD_CREATE_CARD, IMPORT_FBO_STOCKS_FROM_FILE, CREATE_WMS_ITEMS, MOY_SKLAD_CARDS_IMPORT, PROMOTION_FILE, UNUSED_1, UNUSED, PRODUCT_ANALYTICS_FILE_TASK, PROMOTION_RESET_FILE, MOY_SKLAD_IMPORT_ORDERS, FINANCE_REPORT_FILE_TASK, YML_FILE_EXPORT, PRODUCT_BALANCE_REPORT_FILE_TASK, CURRENT_PRODUCT_BALANCE_FILE_TASK, IMPORT_TRANSACTIONS, MATCH_UNREGISTERED_PROFIT_REPORT_TASK, UPDATE_AVERAGE_SERVICE_EXPENSES_TASK, YANDEX_MARKET_ORDER_IMPORT_STAT_TASK, ABC_REPORT_FILE_TASK, MODEL_CONTRACTORS_IMPORT, MODEL_CONTRACTORS_EXPORT, BANK_TRANSACTION_IMPORT_FILE_TASK, YML_IMPORT_TASK, SALES_DYNAMIC_REPORT_FILE_TASK, UPDATE_FBS_ORDERS, EXPORT_TRANSACTION_IN_EXCEL_FILE_TASK, IMPORT_TRANSACTION_FROM_EXCEL_FILE_TASK, EXPORT_PROFIT_REPORT_FILE_TASK, IMPORT_PROFIT_REPORT_FROM_EXCEL_FILE_TASK, IMPORT_REALIZATION_REPORT_TASK, STOCK_RECONCILIATION, ORDER_REPORT_FILE_TASK, GET_WB_FBO_ORDER_FROM_PROFIT_REPORT_TASK, TO_QUANTITY_STORAGE_METHOD, APPLY_RECONCILIATION, OZON_IMPORT_FBO_ORDERS_TASK, UPDATE_PURCHASE_PRICE_IN_PROFIT_REPORT_TASK, FBS_LABELS, MERGE_PRODUCT_STOCKS, CREATE_ORDER_FROM_FILE, ALIEXPRESS_CARD_IMPORT, PRICE_LIST_IMPORT, WB_STOCK_REPORT_FILE, CONTRACTORS_REPORT_FILE, PRODUCTS_SBER_MEGA_MARKET_EXCEL_IMPORT_TASK, EXPORT_PROBLEMATIC_PRODUCT_REPORT, PLAN_SUPPLY_REPORT_TASK, PLAN_FACT_SALES_REPORT_FILE, IMPORT_PLAN_SALES_FROM_EXCEL_FILE_TASK, EXPORT_PLAN_SALES_EXCEL_FILE_TASK, ORDERS_TO_BUY_FILE_TASK, MERGE_PRICE_ON_OTHER_MP_TASK, MATCH_PRODUCT_LAST_OPERATION_DATE_TASK, PROBLEMATIC_PRODUCT_PRICE_FILE_TASK, CATEGORIES_IMPORT_EXCEL_TASK, AVITO_CARD_IMPORT, UPDATE_OLD_WB_ORDER_STATUSES_TASK, PRESTA_SHOP_IMPORT_TASK, PRODUCTS_AVITO_EXCEL_IMPORT_TASK, FBO_STOCK_RECONCILIATION_TASK, APPLY_FBO_RECONCILIATION_TASK, EXPORT_REPRICE_PRODUCT_CONFIG_TASK, IMPORT_REPRICE_PRODUCT_CONFIG_TASK, OZON_CASH_FLOW_STATEMENT_IMPORT_TASK, IMPORT_PROMOTION_STRATEGY_FILE_TASK, UPDATE_ORDER_DELIVERY_INFO_TASK, BILLING_OPERATION_TASK, SET_PURCHASE_PERCENT_TASK, REMOVE_PRODUCT_IMAGES_TASK, STRUCTURE_TURNOVER_TASK, OZON_NEW_UPDATE_PRICE, REPLACE_PRODUCT_IMAGE_TASK, UPDATE_OZON_PROMOTION_DATA_TASK, WILDBERRIES_IMPORT_CAMPAIGN_TASK, WILDBERRIES_STORAGE_REPORT_TASK, WEBASYST_LINK_ARTICLE_TASK, DELIVERY_SERVICE_LABELS, HAND_ON_PULSE_FILE_TASK, ITEMS_INCOME_EXCEL_TASK, UPDATE_SETS_EXCEL_TASK, DELETE_PROFIT_REPORTS_BY_FILE_HISTORY_IDS_TASK, EXPORT_PRODUCT_SETS_TASK, AMAZON_CARD_IMPORT, IMPORT_ACCEPTED_PRODUCTS_TASK, ADD_ORDER_PRODUCT_FROM_FILE_TASK, EXPORT_ITEM_HISTORY_FILE_TASK, WILDBERRIES_IMPORT_CAMPAIGN_BY_EXCEL_TASK, REMOVE_CLIENT_ORGANIZATION, EBAY_CARD_IMPORT_TASK, PRODUCTS_IMPORT_FROM_ORGANIZATION_TASK, IMPORT_FBO_ORDERS, LAMODA_CARD_IMPORT, UPDATE_WB_PROMOTION_DATA_TASK, IMPORT_RETURNS_REPORT_TASK, UPDATE_PROMOTION_DATA_TASK, RESTORE_CLIENT_ORGANIZATION, LEROY_MERLIN_CARD_IMPORT, YANDEX_MARKET_STOCKS_IMPORT_TASK, WILDBERRIES_IMPORT_NM_REPORT_TASK, ORDER_ANALYTICS_FILE_TASK, CLIENT_DATABASE_MOVE_TASK, FAST_CARD_IMPORT, EXPORT_PRODUCT_CODE, INSALES_CARD_IMPORT_TASK, REMOVE_PRODUCT_VIDEOS_TASK, UPDATE_CARDS_TASK, FIND_UNPROFITABLE_PRODUCTS_TASK, FIND_UNPURCHASED_PRODUCTS_TASK, WALMART_CARD_IMPORT, PRODUCT_GROUPS_TASK, CONTRACTOR_ARTICLE_EXPORT_TASK, CONTRACTOR_ARTICLE_IMPORT_TASK, CURRENCY_CONVERSION_TASK, UPDATE_SUPPLY_PLAN_REPORT_TASK, EXPORT_SUPPLY_PLAN_REPORT_FILE_TASK, CHECK_STOCK_ORDER, PHOTOGRAPHY_EXCEL, PREPARE_FINDIR_DATA_TASK, CARD_SPLITTING_TASK, EXPORT_IMAGE_UPDATES_TEMPLATE_TASK, IMPORT_IMAGE_UPDATES_TASK, PREPARE_PRODUCT_HAND_ON_PULSE_TASK, UPDATE_OZON_AVERAGE_DELIVERY_TIME, UPDATE_COMMISSIONS_TASK, WOOCOMMERCE_CARD_IMPORT, UPDATE_FBS_STOCKS_HISTORY, RETURNS_FILE_TASK, FAST_PRODUCTS_IMPORT_TASK, ANALYZE_PRODUCT_CARDS_TASK, DETMIR_CARD_IMPORT, MATCH_OZON_REALIZATION_REPORT_TASK, MAGNIT_IMPORT_PRODUCTS_TASK, UPDATE_PURCHASE_PRICE_FROM_STOCKS_IN_PROFIT_REPORT_TASK, MOY_SKLAD_FBO_MP_DATES_FIX, PRICE_HISTORY_FILE_TASK, FBM_ORDERS_IMPORT_TASK, UZUM_IMPORT_PRODUCTS_TASK, OPENCART_CARD_IMPORT, CARDS_IMPORT, OZON_CROSSDOCK_TRANSIT_ROUTES_TASK, UNUSED_2, OZON_IMPORT_SALES_FUNNEL_REPORT_TASK, WRITE_OFF_PRODUCTS_FILE_TASK, CLIENT_DATABASE_CREATE_TASK, UPDATE_FBS_LABELS_TASK, REBUILD_PROFIT_REPORT_HOURLY_AGGREGATE_TASK, OZON_IMPORT_CAMPAIGN_TASK, EXPORT_SUPPLY_PLAN_FILE_TASK, IMPORT_SUPPLY_PLAN_FILE_TASK, CREATE_SERVICE_CARDS, WAREHOUSE_ECONOMICS_FILE_TASK, UPDATE_WILDBERRIES_ACQUIRING_RATE_TASK, PRODUCT_SALES_FORECAST_TASK, UPDATE_PRODUCT_CODES_STATUSES_TASK, MARKETPLACE_UPDATE_PRICE_TASK, UZUM_IMPORT_STAT_TASK, CAMPAIGN_STATS_FILE_TASK, OZON_FBO_WORKFLOW_TASK, EXPORT_CERTIFICATE_TEMPLATE_TASK, IMPORT_CERTIFICATES_TASK, REBUILD_LOCAL_ORDER_PROFIT_REPORT_TASK, SHOPIFY_CARD_IMPORT Не Type.
name string Не Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
entityId integer · int64 Не Ід суб'екта.
progress integer · int32 Не Прагрэс.
processedQuantity integer · int32 Не Працаванае колькасць.
organizationId integer · int64 Не Ід арганізацыі.
priority integer · int32 Не Пераважнасць.
properties string Не Маёмасці.
message string Не Паведамленне.
messageParams string Не Паведамленне Params.
createdDate string · date-time Не Стварыўся Дата.
startDate string · date-time Не Пачатак дата.
finishDate string · date-time Не Дата заканчэння.
url string Не Ураль.
inputFileUrl string Не Уклад файла URL.
retryNumber integer · int32 Не Перапрабаваць нумар.
userId integer · int32 Не Пазнак карыстальніка.
retryDate string · date-time Не Перапрабаваць дату.
debug boolean Не Адладкаванне.
forcedStart boolean Не Насілле пачатак.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
lang string Не Lang.
{
  "id": 1001,
  "status": "CREATED",
  "type": "WILDBERRIES_CREATE_CARD",
  "name": "Example",
  "clientId": 1001,
  "entityId": 1001
}
Памылкі3

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

Authorization

Знак для запытаў на выпрабаванне

Токен застаецца ў лакальным сховішчы гэтага браўзэра і адпраўляецца толькі ў заголоўцы Authorization запытаў на api.selsup.ru.

Паспрабаваць

Рэальныя параметры запыту

Жывы адказ API

Пашляце запыт, каб убачыць адказ SelSup.