SelSup Developers

Public API · API Reference

Returns

Endpoints for Returns, including exact routes, parameters, request bodies, and expandable response schemas.

3 endpoints/api/returnStableMachine-readable description ↗
{ }

This page is backed by an editable standalone contract. Validate write operations with test data before production use.

/api/return

Ready-to-use workflows

Ready-to-use workflows

01

Start using Returns

Use a dedicated API token and validate read operations with test data first.

  1. Keep the token server-side and send it in the Authorization header.
  2. Check required parameters and expand the request or response schema.
  3. Handle the HTTP status and the stable error field in application errors.

Data model

Data structures

Models are listed once here and can also be expanded directly from the endpoints that use them.

FileExportColumn5 fields
idinteger · int64

Id.

fileExportIdinteger · int64

File Export Id.

columnNamestring

Column Name.

columnOrderinteger · int32

Column Order.

isEnabledboolean

Is Enabled.

TmsTask25 fields
idinteger · int64

Id.

read-only
statusstring

Status.

read-only
typestring

Type.

read-only
namestring

Name.

clientIdinteger · int64

Client Id.

entityIdinteger · int64

Entity Id.

progressinteger · int32

Progress.

processedQuantityinteger · int32

Processed Quantity.

organizationIdinteger · int64

Organization Id.

priorityinteger · int32

Priority.

propertiesstring

Properties.

messagestring

Message.

messageParamsstring

Message Params.

createdDatestring · date-time

Created Date.

startDatestring · date-time

Start Date.

finishDatestring · date-time

Finish Date.

urlstring

Url.

inputFileUrlstring

Input File Url.

retryNumberinteger · int32

Retry Number.

userIdinteger · int32

User Id.

retryDatestring · date-time

Retry Date.

debugboolean

Debug.

forcedStartboolean

Forced Start.

servicestring

Service.

langstring

Lang.

FindResponseReturnReport1 fields
rowsReturnReport[]

Rows.

ReturnReport28 fields
idinteger · int64

Id.

orderTypestring

Order Type.

orderBarcodestring

Order Barcode.

barcodestring

Barcode.

productBarcodestring

Product Barcode.

articlestring

Article.

externalOrderIdstring

External Order Id.

returnOrderIdstring

Return Order Id.

externalProductIdinteger · int64

External Product Id.

quantityinteger · int32

Quantity.

officeIdinteger · int64

Office Id.

officeAddressstring

Office Address.

orderIdinteger · int64

Order Id.

pricenumber · double

Price.

currencyCodestring

Currency Code.

orderProductIdinteger · int64

Order Product Id.

returnDatestring · date-time

Return Date.

returnReasonNamestring

Return Reason Name.

statusstring

Status.

modifyDatestring · date-time

Modify Date.

createdDatestring · date-time

Created Date.

uniqueIdstring

Unique Id.

servicestring

Service.

productIdinteger · int64

Product Id.

productViewIdinteger · int64

Product View Id.

productModelIdinteger · int64

Product Model Id.

clientIdinteger · int64

Client Id.

organizationIdinteger · int64

Organization Id.

Error contract

How application errors are returned

The error code is identical in every locale, while the user-facing message is translated by the server. Build application logic around error and use localMessage for display only.

error

Stable machine-readable code for integration logic.

localMessage

Display-ready message in the API token user's language.

params

Values interpolated by the server into the localized message template.

localMessage uses the lang field of the user who owns the API token. The documentation language and Accept-Language header do not change it; Russian is used when the user has no language configured.

RUUser locale is ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
ENUser locale is en
{
  "error": "error_brand_already_exists",
  "localMessage": "Brand Base already exists",
  "params": {
    "name": "Base"
  }
}

Endpoints

Endpoints

POST

Download

/api/return/download
Token with write access

Download using POST /api/return/download.

Query parameters

FieldTypeRequiredDescription
productAnalyticField stringBARCODE, COLOR, ARTICLE, BRAND, CATEGORY Yes Product Analytic Field.
query string No Query.
withDuplicate boolean No With Duplicate.
withBonus boolean No With Bonus.
byOrgAndService boolean No By Org And Service.
byOrderType boolean No By Order Type.
limit integer · int32 No Limit.
page integer · int32 No Page.
sortBy string No Sort By.
ascending boolean No Ascending.
id integer · int64 No Id.
isMarketPlaceStructure boolean No Is Market Place Structure.
isDashboard boolean No Is Dashboard.
analyticsField stringPRODUCT, MODEL, GROUP, ORGANIZATION, CLIENT, CATEGORY, PRODUCT_VIEW, BRAND, REGION, WAREHOUSE No Analytics Field.
planDayCount integer · int32 No Plan Day Count.
daysToSupply integer · int32 No Days To Supply.
plannedSupplyDate string · date-time No Planned Supply Date.
groupByView boolean No Group By View.
warehouses integer[] No Warehouses.
salesModels string[] No Sales Models.
aggregation stringWAREHOUSE, WAREHOUSE_PRODUCT No Aggregation.
columns FileExportColumn[] No Columns.
Array item structure FileExportColumn
FieldTypeRequiredDescription
id integer · int64 No Id.
fileExportId integer · int64 No File Export Id.
columnName string No Column Name.
columnOrder integer · int32 No Column Order.
isEnabled boolean No Is Enabled.
regions string[] No Regions.
group boolean No Group.
calculationByOrders boolean No Calculation By Orders.
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 No Source Report.
skipDayWithoutStocks boolean No Skip Day Without Stocks.
replaceSetsByComponents boolean No Replace Sets By Components.
distributeFbsByWarehouse boolean No Distribute Fbs By Warehouse.
distributeFbsStock boolean No Distribute Fbs Stock.
ignoreDumping boolean No Ignore Dumping.
isSaleStructure boolean No Is Sale Structure.
isAveragePerOneUnit boolean No Is Average Per One Unit.
updateDate boolean No Update Date.
useWeightedGroup boolean No Use Weighted Group.
isFindirRequest boolean No Is Findir Request.
brandIds integer[] No Brand Ids.
categoryIds integer[] No Category Ids.
articles string[] No Articles.
colors string[] No Colors.
sizes string[] No Sizes.
barcodes string[] No Barcodes.
tagIds integer[] No Tag Ids.
penaltyFrom number · double No Penalty From.
penaltyTo number · double No Penalty To.
logisticsFrom number · double No Logistics From.
logisticsTo number · double No Logistics To.
marginFrom number · double No Margin From.
marginTo number · double No Margin To.
salesAmountFrom number · double No Sales Amount From.
salesAmountTo number · double No Sales Amount To.
totalSalesAmountFrom number · double No Total Sales Amount From.
totalSalesAmountTo number · double No Total Sales Amount To.
grossProfitFrom number · double No Gross Profit From.
grossProfitTo number · double No Gross Profit To.
taxNds integer · int32 No Tax Nds.
useOsno boolean No Use Osno.
period stringDAY, WEEK, MONTH, QUARTER, YEAR, MONTH_3, MONTH_6, END_OF_TARIFF, MONTH_7, MONTH_14, YEAR_2 No Period.
dateFrom string · date-time Yes Date From.
dateTo string · date-time Yes Date To.
services string[] No Services.
categories integer[] No Categories.
brands integer[] No Brands.
clientOrganizationId integer · int64 No Client Organization Id.
organizations integer[] No Organizations.
ids integer[] No Ids.
type stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION No Type.
types string[] No Types.
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 No Status.
timeZone integer · int32 No Time Zone.
previousDateFrom string · date-time No Previous Date From.
clientOrganizationIds integer[] No Client Organization Ids.
ignoreCredit boolean No Ignore Credit.
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'

Success response

200
Object fields TmsTask
FieldTypeRequiredDescription
id integer · int64 No Id.
status stringCREATED, RUNNING, FINISHED, ERROR, RESTARTING, INTERRUPTING, INTERRUPTED, STOPPED, EXCEPTION No 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 No Type.
name string No Name.
clientId integer · int64 No Client Id.
entityId integer · int64 No Entity Id.
progress integer · int32 No Progress.
processedQuantity integer · int32 No Processed Quantity.
organizationId integer · int64 No Organization Id.
priority integer · int32 No Priority.
properties string No Properties.
message string No Message.
messageParams string No Message Params.
createdDate string · date-time No Created Date.
startDate string · date-time No Start Date.
finishDate string · date-time No Finish Date.
url string No Url.
inputFileUrl string No Input File Url.
retryNumber integer · int32 No Retry Number.
userId integer · int32 No User Id.
retryDate string · date-time No Retry Date.
debug boolean No Debug.
forcedStart boolean No Forced Start.
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 No Service.
lang string No Lang.
{
  "id": 1001,
  "status": "CREATED",
  "type": "WILDBERRIES_CREATE_CARD",
  "name": "Example",
  "clientId": 1001,
  "entityId": 1001
}
Errors5

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required
Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied
Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown
Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_analytics_access_denied
Analytics data is confidential for the SUPPORT role

Endpoint-specific error. Use the stable error_analytics_access_denied code in application logic; localMessage contains the translation shown above.

400error_organization_not_found
Organization not found

Endpoint-specific error. Use the stable error_organization_not_found code in application logic; localMessage contains the translation shown above.

GET

Find

/api/return/find
Token with read access

Find using GET /api/return/find.

Query parameters

FieldTypeRequiredDescription
id integer · int64 No Id.
organizationId integer · int64 No Organization Id.
orderType stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION No Order Type.
orderBarcode string No Order Barcode.
services string[] No Services.
barcode string No Barcode.
productBarcode string No Product Barcode.
article string No Article.
externalOrderId string No External Order Id.
returnOrderId string No Return Order Id.
externalProductId integer · int64 No External Product Id.
officeId integer · int64 No Office Id.
officeAddress string No Office Address.
orderId integer · int64 No Order Id.
orderProductId integer · int64 No Order Product Id.
returnReasonName string No Return Reason Name.
status string No Status.
timeZone integer · int32 No Time Zone.
modifyDate string · date-time No Modify Date.
dateFrom string · date-time No Date From.
dateTo string · date-time No Date To.
modifiedDateFrom string · date-time No Modified Date From.
modifiedDateTo string · date-time No Modified Date To.
limit integer · int32 No Limit.
page integer · int32 No Page.
count boolean No Count.
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 No Sort By.
ascending boolean No Ascending.
curl --request GET 'https://api.selsup.ru/api/return/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Success response

200
Object fields FindResponseReturnReport
FieldTypeRequiredDescription
rows ReturnReport[] No Rows.
Array item structure ReturnReport
FieldTypeRequiredDescription
id integer · int64 No Id.
orderType string No Order Type.
orderBarcode string No Order Barcode.
barcode string No Barcode.
productBarcode string No Product Barcode.
article string No Article.
externalOrderId string No External Order Id.
returnOrderId string No Return Order Id.
externalProductId integer · int64 No External Product Id.
quantity integer · int32 No Quantity.
officeId integer · int64 No Office Id.
officeAddress string No Office Address.
orderId integer · int64 No Order Id.
price number · double No Price.
currencyCode string No Currency Code.
orderProductId integer · int64 No Order Product Id.
returnDate string · date-time No Return Date.
returnReasonName string No Return Reason Name.
status string No Status.
modifyDate string · date-time No Modify Date.
createdDate string · date-time No Created Date.
uniqueId string No Unique Id.
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 No Service.
productId integer · int64 No Product Id.
productViewId integer · int64 No Product View Id.
productModelId integer · int64 No Product Model Id.
clientId integer · int64 No Client Id.
organizationId integer · int64 No Organization Id.
{
  "rows": "string"
}
Errors5

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required
Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied
Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown
Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

400error_analytics_access_denied
Analytics data is confidential for the SUPPORT role

Endpoint-specific error. Use the stable error_analytics_access_denied code in application logic; localMessage contains the translation shown above.

400error_no_client
The client was not found or has been deleted. Write to support

Endpoint-specific error. Use the stable error_no_client code in application logic; localMessage contains the translation shown above.

GET

Returns File

/api/return/file
Token with read access

Returns File using GET /api/return/file.

Query parameters

FieldTypeRequiredDescription
id integer · int64 No Id.
organizationId integer · int64 No Organization Id.
orderType stringFBM, FBS, INCOME, RETAIL, WHOLESALE, FBO, MOVEMENT, WRITE_OFF, PRODUCTION No Order Type.
orderBarcode string No Order Barcode.
services string[] No Services.
barcode string No Barcode.
productBarcode string No Product Barcode.
article string No Article.
externalOrderId string No External Order Id.
returnOrderId string No Return Order Id.
externalProductId integer · int64 No External Product Id.
officeId integer · int64 No Office Id.
officeAddress string No Office Address.
orderId integer · int64 No Order Id.
orderProductId integer · int64 No Order Product Id.
returnReasonName string No Return Reason Name.
status string No Status.
timeZone integer · int32 No Time Zone.
modifyDate string · date-time No Modify Date.
dateFrom string · date-time No Date From.
dateTo string · date-time No Date To.
modifiedDateFrom string · date-time No Modified Date From.
modifiedDateTo string · date-time No Modified Date To.
limit integer · int32 No Limit.
page integer · int32 No Page.
count boolean No Count.
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 No Sort By.
ascending boolean No Ascending.
curl --request GET 'https://api.selsup.ru/api/return/file?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Success response

200
Object fields TmsTask
FieldTypeRequiredDescription
id integer · int64 No Id.
status stringCREATED, RUNNING, FINISHED, ERROR, RESTARTING, INTERRUPTING, INTERRUPTED, STOPPED, EXCEPTION No 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 No Type.
name string No Name.
clientId integer · int64 No Client Id.
entityId integer · int64 No Entity Id.
progress integer · int32 No Progress.
processedQuantity integer · int32 No Processed Quantity.
organizationId integer · int64 No Organization Id.
priority integer · int32 No Priority.
properties string No Properties.
message string No Message.
messageParams string No Message Params.
createdDate string · date-time No Created Date.
startDate string · date-time No Start Date.
finishDate string · date-time No Finish Date.
url string No Url.
inputFileUrl string No Input File Url.
retryNumber integer · int32 No Retry Number.
userId integer · int32 No User Id.
retryDate string · date-time No Retry Date.
debug boolean No Debug.
forcedStart boolean No Forced Start.
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 No Service.
lang string No Lang.
{
  "id": 1001,
  "status": "CREATED",
  "type": "WILDBERRIES_CREATE_CARD",
  "name": "Example",
  "clientId": 1001,
  "entityId": 1001
}
Errors3

Application errors are normally returned as JSON with error, localMessage, and params. Branch on error; localized text may change. How application errors are returned ↑

401auth_required
Authentication required

Authorization is missing, empty, or contains an invalid token.

400error_access_denied
Insufficient permissions

The token exists, but its role cannot perform this operation.

500error_unknown
Unexpected error

Internal failure. Save the request time and contact support; do not blindly retry a mutation.

Authorization

Token for test requests

The token stays in this browser's localStorage and is sent only in the Authorization header of requests to api.selsup.ru.

Try it

Real request parameters

Live API response

Send a request to see the SelSup response.