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

消息帕拉姆.

createdDatestring · date-time

创造日期.

startDatestring · date-time

开始日期.

finishDatestring · date-time

终结日期.

urlstring

查看一个URL.

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

订购产品身份证.

returnDatestring · date-time

返回日期.

returnReasonNamestring

返回理由名字.

statusstring

Status.

modifyDatestring · date-time

修改日期.

createdDatestring · date-time

创造日期.

uniqueIdstring

唯一的身份证.

servicestring

服务.

productIdinteger · int64

产品身份证

productViewIdinteger · int64

产品查看ID.

productModelIdinteger · int64

产品模型身份证

clientIdinteger · int64

客户身份证.

organizationIdinteger · int64

组织身份证.

错误合同

如何返回应用错误

编程的代码在每个地方都相同,而用户面向的消息由服务器翻译. 建立在error周围的应用逻辑,仅用于显示.

鱼类

稳定机器可读的代码用于集成逻辑.

鱼类

在API代币用户语言中显示准备的消息.

鱼类

服务器在本地化消息模板中插入的值.

文

localMessage使用了 API代币的用户的lang字段.文档语言和 Accept-Language标题不会改变它;当用户没有语言配置时,使用俄语.

RU用户位置是 ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
CN中文 (cn)
{
  "error": "error_brand_already_exists",
  "localMessage": "品牌 Base 已经存在",
  "params": {
    "name": "Base"
  }
}

终点

终点

POST

下载

/api/return/download
具有写入的标志

使用POSTX/api/return/download.下载

查询参数

字段类型必填描述
productAnalyticField stringBARCODE, COLOR, ARTICLE, BRAND, CATEGORY 是 产品分析领域
query string 否 问问.
withDuplicate boolean 否 通过复制.
withBonus boolean 否 带着士.
distributeUnallocatedExpenses boolean 否 分配未分配的费用.
byOrgAndService boolean 否 通过组织和服务.
byCategory 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 否 根据命令计算.
ordersByCreatedDate 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, PRODUCT_EXPENSE, OZON_BUYOUT, OZON_BUYOUT_RETURNS_FILE 否 来源报告
skipDayWithoutStocks boolean 否 没有股票的节日.
replaceSetsByComponents boolean 否 取代组件以组件.
distributeFbsByWarehouse boolean 否 根据仓库分发FBS.
distributeFbsStock boolean 否 发行联邦调查局股票.
ignoreDumping boolean 否 忽略.
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, REVERSED 否 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, EXPORT_PURCHASE_PLAN_FILE_TASK, RETAIL_ORDER_PRODUCTS_FILE_TASK, FULFILLMENT_BILLING_REGISTRY_FILE_TASK, SUPPLY_PLANNING_REPORT_FILE_TASK, REBUILD_TAX_BASE_HOURLY_AGGREGATE_TASK, PACK_ORDERS_TASK, IMPORT_ORDER_MARKING_CODES_TASK, PRODUCTION_ANALYTICS_FILE_TASK, CARD_REQUIREMENT_AI_TASK, CARD_REQUIREMENT_SCAN_TASK, SUPPLY_LABELS_FILE_TASK, TRANSFER_PRODUCTS_BETWEEN_SERVICES_TASK, RETIRE_SOLD_OUT_CARDS_TASK, WILDBERRIES_CARDS_JOIN_TASK 否 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 否 消息帕拉姆.
createdDate string · date-time 否 创造日期.
startDate string · date-time 否 开始日期.
finishDate string · date-time 否 终结日期.
url string 否 查看一个URL.
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, TEKSHER, KONTUR_LOGISTICS, KONTUR_EDI, VSE_INSTRUMENTI, ELECTRONIC_SIGN 否 服务.
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_analytics_access_denied代码;localMessage包含上述翻译.

400error_organization_not_found
没有发现任何组织

应用逻辑中使用稳定的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 否 订购产品身份证.
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 否 订购产品身份证.
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, TEKSHER, KONTUR_LOGISTICS, KONTUR_EDI, VSE_INSTRUMENTI, ELECTRONIC_SIGN 否 服务.
productId integer · int64 否 产品身份证
productViewId integer · int64 否 产品查看ID.
productModelId integer · int64 否 产品模型身份证
clientId integer · int64 否 客户身份证.
organizationId integer · int64 否 组织身份证.
{
  "rows": "string"
}
错误6

应用错误通常以 JSON, error,localMessage和 params为回归. 如何返回应用错误 ↑

401auth_required
需要进行认证

Authorization 缺失,空,或包含无效的代币.

400error_access_denied
拒绝访问

代币存在,但它的作用不能执行这个操作.

500error_unknown
发生了一个未知的错误。如果该问题再次发生,请联系支持

节省请求时间和联系支持;不要盲目重新尝试突变.

400error_analytics_access_denied
分析数据对 SUPPORT 角色为保密。

应用逻辑中使用稳定的error_analytics_access_denied代码;localMessage包含上述翻译.

400error_cant_extract_tariffs
无法获取费率。请联系支持团队

应用逻辑中使用稳定的error_cant_extract_tariffs代码;localMessage包含上述翻译.

400error_no_client
没有找到该客户或已被删除。写信给支持部门

应用逻辑中使用稳定的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 否 订购产品身份证.
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, EXPORT_PURCHASE_PLAN_FILE_TASK, RETAIL_ORDER_PRODUCTS_FILE_TASK, FULFILLMENT_BILLING_REGISTRY_FILE_TASK, SUPPLY_PLANNING_REPORT_FILE_TASK, REBUILD_TAX_BASE_HOURLY_AGGREGATE_TASK, PACK_ORDERS_TASK, IMPORT_ORDER_MARKING_CODES_TASK, PRODUCTION_ANALYTICS_FILE_TASK, CARD_REQUIREMENT_AI_TASK, CARD_REQUIREMENT_SCAN_TASK, SUPPLY_LABELS_FILE_TASK, TRANSFER_PRODUCTS_BETWEEN_SERVICES_TASK, RETIRE_SOLD_OUT_CARDS_TASK, WILDBERRIES_CARDS_JOIN_TASK 否 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 否 消息帕拉姆.
createdDate string · date-time 否 创造日期.
startDate string · date-time 否 开始日期.
finishDate string · date-time 否 终结日期.
url string 否 查看一个URL.
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, TEKSHER, KONTUR_LOGISTICS, KONTUR_EDI, VSE_INSTRUMENTI, ELECTRONIC_SIGN 否 服务.
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

测试请求的标志

获取 API 令牌

代币存储在本浏览器的本地存储库中,只会在要求的Authorization头上发送到 api.selsup.ru.

试一试

实际请求参数

现场API响应

发送请求查看SelSup的响应.