SelSup Developers

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

Рэкламныя кампаніі

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

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

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

/api/campaign

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

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

01

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

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

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

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

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

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

CampaignFilter17 палёў
limitinteger · int32

Межа.

pageinteger · int32

Праз старонку.

countboolean

Граф.

sortBystring

Пасля.

ascendingboolean

Падыходзіць.

statusstring

Status.

campaignStatusstring

Статус кампаніі.

typeinteger · int32

Type.

offsetinteger · int32

Згаршэнне.

servicestring

Паслуга.

dateTostring · date-time

Дата да.

dateFromstring · date-time

Дата ад.

isStatCampaignboolean

Гэта кампанія Stat.

dateStartstring · date-time

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

querystring

Запытваючы.

productExternalIdinteger · int64

Падчас выканання пастановы, выкананы пастаноўкі.

organizationIdsinteger[]

Ідэнтыфікаты арганізацыі.

CampaignStatExportRequest4 палёў
servicestring

Паслуга.

organizationIdinteger · int64

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

organizationIdsinteger[]

Ідэнтыфікаты арганізацыі.

filterCampaignFilter

Фільтр.

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.

Campaign22 палёў
idinteger · int64

Id.

externalIdinteger · int64

Па-залежнае пазначэнне.

namestring

Назва.

campaignNamestring

Назва кампаніі.

typestring

Type.

statusTypestring

Тып статусу.

productIdinteger · int64

Ід прадукту.

externalProductIdinteger · int64

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

createDatestring · date-time

Стварэнне Даты.

endDatestring · date-time

Завяршальная дата.

startDatestring · date-time

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

suminteger · int64

Падробна.

writeOffTypestring

Адпішыце ад тыпу.

onPauseboolean

На Паузе.

clientIdinteger · int64

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

servicestring

Паслуга.

categoryIdinteger · int64

Ід катэгорыі.

categoryNamestring

Назва катэгорыі.

campaignTypestring

Тып кампаніі.

dateStatImportstring · date-time

Дата ўвозу Stat.

nmsstring

НМС.

paymentTypestring

Тып аплаты.

WildberriesType32 палёў
idinteger · int64

Id.

namestring

Назва.

publishedboolean

Выдадзены.

hasSizeboolean

У яго ёсць памер.

monoBoxMinQuantityinteger · int32

Моно-каробка міні-квантычнасць.

monoTypestring

Монатыпа.

monoMinPriceinteger · int32

Моно-Мін Прайс.

hasParentboolean

У яго ёсць бацька.

parentIdinteger · int64

Падпісанне бацькоў.

wildberriesIdinteger · int64

Ід Wildberries.

lastSyncDatestring · date-time

Апошняя дата сінхрынізацыі.

notChangedDaysinteger · int32

Не змяніліся дні.

commissionnumber · double

Камісія.

fbsCommissionnumber · double

ФБС камісія.

fbwCommissionnumber · double

ФБУ камісія.

dbsCommissionnumber · double

Камісія ДБС.

edbsCommissionnumber · double

Камісія Эдбс.

cAndCCommissionnumber · double

C і CКамісія.

bookingCommissionnumber · double

Кабільная камісія.

logisticPriceinteger · int32

Логістычны кошт.

storagePricenumber · double

Пакупка кошту.

acceptancePricenumber · double

Прыняцце Прэміі.

needDimensionsboolean

Патрэбныя вымярэнні.

purchasePercentAvgnumber · double

Купля Перацэнт Avg.

purchasePercentMinnumber · double

Купля Перацэнт міні.

photoAvginteger · int32

Фота АВГ.

photoMininteger · int32

Фота Мін.

drrAvgnumber · double

Д-р Авг.

drrMinnumber · double

Д-р Мін.

marginAvgnumber · double

Маржы АВГ.

marginMinnumber · double

Маргін Мін.

candCCommissionnumber · double

Кандыдат ЦК.

CampaignStat4 палёў
campaignstring

Кампанія.

valuenumber · double

Значэнне.

organizationIdinteger · int64

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

organizationNamestring

Назва арганізацыі.

CampaignTotalStats4 палёў
clicksCampaignStat[]

Клікнуў.

viewsCampaignStat[]

Глядыні.

expensesCampaignStat[]

Выдаткі.

averageCostCampaignStat[]

Сярэдні кошт.

FindResponseStatCampaign1 палёў
rowsStatCampaign[]

Рыжкі.

StatCampaign46 палёў
limitinteger · int32

Межа.

pageinteger · int32

Праз старонку.

countboolean

Граф.

sortBystring

Пасля.

ascendingboolean

Падыходзіць.

statCampaignIdinteger · int64

Stat кампаніі ID.

viewsinteger · int32

Глядыні.

clicksinteger · int32

Клікнуў.

ratioClicksViewsnumber · double

Пагадненне клікаў праглядаў.

averageCostnumber · double

Сярэдні кошт.

expensesnumber · double

Выдаткі.

quantityAddCartinteger · int32

Колькасць дадаць кошык.

quantityOrdersinteger · int32

Колькасць заказы.

ratioOrdersOfVisitsnumber · double

Колькасць парадкаў наведванняў.

quantityProductOrdersinteger · int32

Колькасць заказаў прадукту.

ordersAmountnumber · double

Колькасць замоў.

campaignIdinteger · int64

Ід кампаніі.

campaignNamestring

Назва кампаніі.

createDatestring · date-time

Стварэнне Даты.

servicestring

Паслуга.

campaignTypestring

Тып кампаніі.

categoryNamestring

Назва катэгорыі.

externalIdinteger · int64

Па-залежнае пазначэнне.

productIdinteger · int64

Ід прадукту.

productViewIdinteger · int64

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

datestring · date-time

Дата.

startDatestring · date-time

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

endDatestring · date-time

Завяршальная дата.

importDatestring · date-time

Дата імпарту.

uniqueIdstring

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

clientIdinteger · int64

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

organizationIdinteger · int64

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

organizationNamestring

Назва арганізацыі.

rowTypestring

Рыжкі тыпу.

quantityBuyoutsnumber · double

Купля колькасці.

revenuenumber · double

Паступленне.

profitFactnumber · double

Праўда прыбытку.

marginFactnumber · double

Маржы факт.

drrnumber · double

Доктар.

cpsnumber · double

Спіс.

quantityBuyoutsForecastnumber · double

Прагноз аб колькасці выкупаў.

profitForecastnumber · double

Прагноз прыбытку.

marginForecastnumber · double

Прагноз маржы.

allowableExpensesnumber · double

Дапушчальныя выдаткі.

currencystring

Валюта.

unavailableReasonsobject

Недаступныя прычыны.

FindResponseCampaign1 палёў
rowsCampaign[]

Рыжкі.

WbBalance3 палёў
balanceinteger · int32

Раўнавагу.

netinteger · int32

Сетка.

bonusinteger · int32

Бонус.

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

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

Код 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/campaign/updateStatusCampaign
Знак з пісьмовым доступам

Абноўленне кампаніі аб стане з дапамогай POST /api/campaign/updateStatusCampaign.

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

ПолеТыпАбавязковаАпісанне
campaignId integer · int64 Так Ід кампаніі.
status stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Так Status.
organizationId integer · int64 Так Ід арганізацыі.
curl --request POST 'https://api.selsup.ru/api/campaign/updateStatusCampaign?campaignId=1001&status=DELETED&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі9

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

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

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

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

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

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

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

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

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

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

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

400error_prepared_integration_not_found
падрыхтаваная інтэграцыя не знойдзена

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

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

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

400error_token_expired_or_revoked
Токен API адкліканы або ўведзены некарэктна. Праверце, што ключ API мае поўны функцыянал. Згенеруйце новы ключ і заменіце ў SELSUP, бо ключы маюць тэрмін жыцця.

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

400error_wildberries_api
{message}

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

POST

Статысты экспартных кампаній

/api/campaign/stats/xlsx
Знак з пісьмовым доступам

Статысты кампаніі па экспарце з дапамогай POST /api/campaign/stats/xlsx.

Запытвальны орган

application/json
Палі аб'ектаўCampaignStatExportRequest
ПолеТыпАбавязковаАпісанне
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 Не Паслуга.
organizationId integer · int64 Не Ід арганізацыі.
organizationIds integer[] Не Ідэнтыфікаты арганізацыі.
filter CampaignFilter Не Фільтр.
Палі аб'ектаў CampaignFilter
ПолеТыпАбавязковаАпісанне
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringEXTERNALID, SERVICE, CAMPAIGNNAME, CAMPAIGNTYPE, CATEGORYNAME, VIEWS, CLICKS, RATIOCLICKSVIEWS, AVERAGECOST, EXPENSES, QUANTITYADDCART, QUANTITYORDERS, RATIOORDERSOFVISITS, QUANTITYPRODUCTORDERS, ORDERSAMOUNT, CREATEDATE, STATUS Не Пасля.
ascending boolean Не Падыходзіць.
status string Не Status.
campaignStatus stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Статус кампаніі.
type integer · int32 Не Type.
offset integer · int32 Не Згаршэнне.
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 Не Паслуга.
dateTo string · date-time Не Дата да.
dateFrom string · date-time Не Дата ад.
isStatCampaign boolean Не Гэта кампанія Stat.
dateStart string · date-time Не Пачатак дата.
query string Не Запытваючы.
productExternalId integer · int64 Не Падчас выканання пастановы, выкананы пастаноўкі.
organizationIds integer[] Не Ідэнтыфікаты арганізацыі.
curl --request POST 'https://api.selsup.ru/api/campaign/stats/xlsx' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "organizationId": 1001,
  "organizationIds": "string",
  "filter": "string"
}'

Удалы адказ

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
}
Памылкі9

Памылкі прыкладання звычайна вяртаюцца ў выглядзе 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_marketplace
Не пазначаны маркетплейс

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

400error_no_organization
Не пазначана арганізацыя

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

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

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

400error_unsupported_service
Сэрвіс не падтрымліваецца

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

400error_user_does_not_have_this_organization
У карыстальніка няма доступу да дадзенай арганізацыі

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

POST

Стварэнне кампаніі

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

Стварэнне кампаніі з дапамогай POST /api/campaign/createCampaign.

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

ПолеТыпАбавязковаАпісанне
organizationId integer · int64 Так Ід арганізацыі.

Запытвальны орган

application/json
Палі аб'ектаўCampaign
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
externalId integer · int64 Не Па-залежнае пазначэнне.
name string Не Назва.
campaignName string Не Назва кампаніі.
type stringIN_CATALOG, IN_CARD, IN_SEARCH, IN_MAIN, AUTO, IN_SEARCH_AND_CATALOG, BRAND_SHELF, UNKNOWN Не Type.
statusType stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Тып статусу.
productId integer · int64 Не Ід прадукту.
externalProductId integer · int64 Не Па-за межамі ID прадукту.
createDate string · date-time Не Стварэнне Даты.
endDate string · date-time Не Завяршальная дата.
startDate string · date-time Не Пачатак дата.
sum integer · int64 Не Падробна.
writeOffType stringBALANCE, NET, BONUS Не Адпішыце ад тыпу.
onPause boolean Не На Паузе.
clientId integer · int64 Не Ідэнтыфікатар кліента.
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 Не Паслуга.
categoryId integer · int64 Не Ід катэгорыі.
categoryName string Не Назва катэгорыі.
campaignType string Не Тып кампаніі.
dateStatImport string · date-time Не Дата ўвозу Stat.
nms string Не НМС.
paymentType string Не Тып аплаты.
curl --request POST 'https://api.selsup.ru/api/campaign/createCampaign?organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "externalId": 1001,
  "name": "Example",
  "campaignName": "Example",
  "type": "IN_CATALOG",
  "statusType": "DELETED"
}'

Удалы адказ

200
Палі аб'ектаў Campaign
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
externalId integer · int64 Не Па-залежнае пазначэнне.
name string Не Назва.
campaignName string Не Назва кампаніі.
type stringIN_CATALOG, IN_CARD, IN_SEARCH, IN_MAIN, AUTO, IN_SEARCH_AND_CATALOG, BRAND_SHELF, UNKNOWN Не Type.
statusType stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Тып статусу.
productId integer · int64 Не Ід прадукту.
externalProductId integer · int64 Не Па-за межамі ID прадукту.
createDate string · date-time Не Стварэнне Даты.
endDate string · date-time Не Завяршальная дата.
startDate string · date-time Не Пачатак дата.
sum integer · int64 Не Падробна.
writeOffType stringBALANCE, NET, BONUS Не Адпішыце ад тыпу.
onPause boolean Не На Паузе.
clientId integer · int64 Не Ідэнтыфікатар кліента.
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 Не Паслуга.
categoryId integer · int64 Не Ід катэгорыі.
categoryName string Не Назва катэгорыі.
campaignType string Не Тып кампаніі.
dateStatImport string · date-time Не Дата ўвозу Stat.
nms string Не НМС.
paymentType string Не Тып аплаты.
{
  "id": 1001,
  "externalId": 1001,
  "name": "Example",
  "campaignName": "Example",
  "type": "IN_CATALOG",
  "statusType": "DELETED"
}
Памылкі10

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

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

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

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

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

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

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

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

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

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

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

400error_prepared_integration_not_found
падрыхтаваная інтэграцыя не знойдзена

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

400error_service_not_supported
Сэрвіс не падтрымліваецца

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

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

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

400error_token_expired_or_revoked
Токен API адкліканы або ўведзены некарэктна. Праверце, што ключ API мае поўны функцыянал. Згенеруйце новы ключ і заменіце ў SELSUP, бо ключы маюць тэрмін жыцця.

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

400error_wildberries_api
{message}

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

GET

Кампаніі па імпарце

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

Імпартныя кампаніі з дапамогай GET /api/campaign/updateCampaigns.

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

ПолеТыпАбавязковаАпісанне
organizationId integer · int64 Так Ід арганізацыі.
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 Так Паслуга.
curl --request GET 'https://api.selsup.ru/api/campaign/updateCampaigns?organizationId=1001&service=NONE' \
  --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_unsupported_service
Сэрвіс не падтрымліваецца

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

GET

Падгрузка ацэнкі кампаніі

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

Перагрузка статыстыкі кампаніі з дапамогай GET /api/campaign/reloadCampaignStats.

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

ПолеТыпАбавязковаАпісанне
dateFrom string · date Так Дата ад.
dateTo string · date Так Дата да.
organizationId integer · int64 Так Ід арганізацыі.
isExpensesOnly 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 Так Паслуга.
curl --request GET 'https://api.selsup.ru/api/campaign/reloadCampaignStats?dateFrom=2026-01-15&dateTo=2026-01-15&organizationId=1001&service=NONE' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі3

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

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

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

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

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

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

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

GET

Атрымаць дзікія яблыкі прадметы

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

Атрымаць Wildberries суб'екты з дапамогай GET /api/campaign/getWildberriesSubjects.

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

ПолеТыпАбавязковаАпісанне
query string Так Запытваючы.
limit integer · int32 Так Межа.
organizationId integer · int64 Так Ід арганізацыі.
curl --request GET 'https://api.selsup.ru/api/campaign/getWildberriesSubjects?query=string&limit=50&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Структура элементаў масіва WildberriesType[]
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Не Назва.
published boolean Не Выдадзены.
hasSize boolean Не У яго ёсць памер.
monoBoxMinQuantity integer · int32 Не Моно-каробка міні-квантычнасць.
monoType stringALWAYS, NEVER, MONO_IF_MIN_PRICE Не Монатыпа.
monoMinPrice integer · int32 Не Моно-Мін Прайс.
hasParent boolean Не У яго ёсць бацька.
parentId integer · int64 Не Падпісанне бацькоў.
wildberriesId integer · int64 Не Ід Wildberries.
lastSyncDate string · date-time Не Апошняя дата сінхрынізацыі.
notChangedDays integer · int32 Не Не змяніліся дні.
commission number · double Не Камісія.
fbsCommission number · double Не ФБС камісія.
fbwCommission number · double Не ФБУ камісія.
dbsCommission number · double Не Камісія ДБС.
edbsCommission number · double Не Камісія Эдбс.
cAndCCommission number · double Не C і CКамісія.
bookingCommission number · double Не Кабільная камісія.
logisticPrice integer · int32 Не Логістычны кошт.
storagePrice number · double Не Пакупка кошту.
acceptancePrice number · double Не Прыняцце Прэміі.
needDimensions boolean Не Патрэбныя вымярэнні.
purchasePercentAvg number · double Не Купля Перацэнт Avg.
purchasePercentMin number · double Не Купля Перацэнт міні.
photoAvg integer · int32 Не Фота АВГ.
photoMin integer · int32 Не Фота Мін.
drrAvg number · double Не Д-р Авг.
drrMin number · double Не Д-р Мін.
marginAvg number · double Не Маржы АВГ.
marginMin number · double Не Маргін Мін.
candCCommission number · double Не Кандыдат ЦК.
[
  "string"
]
Памылкі7

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

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

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

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

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

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

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

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

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

400error_prepared_integration_not_found
падрыхтаваная інтэграцыя не знойдзена

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

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

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

400error_token_expired_or_revoked
Токен API адкліканы або ўведзены некарэктна. Праверце, што ключ API мае поўны функцыянал. Згенеруйце новы ключ і заменіце ў SELSUP, бо ключы маюць тэрмін жыцця.

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

GET

Атрымаць агульную статыстычную кампанію

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

Атрымаць агульную статыстыку кампаній з дапамогай GET /api/campaign/getTotalStatCampaigns.

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

ПолеТыпАбавязковаАпісанне
organizationId integer · int64 Не Ід арганізацыі.
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 Так Паслуга.
status string Не Status.
campaignStatus stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Статус кампаніі.
type integer · int32 Не Type.
offset integer · int32 Не Згаршэнне.
dateTo string · date-time Не Дата да.
dateFrom string · date-time Не Дата ад.
isStatCampaign boolean Не Гэта кампанія Stat.
dateStart string · date-time Не Пачатак дата.
query string Не Запытваючы.
productExternalId integer · int64 Не Падчас выканання пастановы, выкананы пастаноўкі.
organizationIds integer[] Не Ідэнтыфікаты арганізацыі.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringEXTERNALID, SERVICE, CAMPAIGNNAME, CAMPAIGNTYPE, CATEGORYNAME, VIEWS, CLICKS, RATIOCLICKSVIEWS, AVERAGECOST, EXPENSES, QUANTITYADDCART, QUANTITYORDERS, RATIOORDERSOFVISITS, QUANTITYPRODUCTORDERS, ORDERSAMOUNT, CREATEDATE, STATUS Не Пасля.
ascending boolean Не Падыходзіць.
topN integer · int32 Так Верхняя N.
curl --request GET 'https://api.selsup.ru/api/campaign/getTotalStatCampaigns?service=NONE&limit=50&page=1&topN=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў CampaignTotalStats
ПолеТыпАбавязковаАпісанне
clicks CampaignStat[] Не Клікнуў.
Структура элементаў масіва CampaignStat
ПолеТыпАбавязковаАпісанне
campaign string Не Кампанія.
value number · double Не Значэнне.
organizationId integer · int64 Не Ід арганізацыі.
organizationName string Не Назва арганізацыі.
views CampaignStat[] Не Глядыні.
Структура элементаў масіва CampaignStat
ПолеТыпАбавязковаАпісанне
campaign string Не Кампанія.
value number · double Не Значэнне.
organizationId integer · int64 Не Ід арганізацыі.
organizationName string Не Назва арганізацыі.
expenses CampaignStat[] Не Выдаткі.
Структура элементаў масіва CampaignStat
ПолеТыпАбавязковаАпісанне
campaign string Не Кампанія.
value number · double Не Значэнне.
organizationId integer · int64 Не Ід арганізацыі.
organizationName string Не Назва арганізацыі.
averageCost CampaignStat[] Не Сярэдні кошт.
Структура элементаў масіва CampaignStat
ПолеТыпАбавязковаАпісанне
campaign string Не Кампанія.
value number · double Не Значэнне.
organizationId integer · int64 Не Ід арганізацыі.
organizationName string Не Назва арганізацыі.
{
  "clicks": "string",
  "views": "string",
  "expenses": "string",
  "averageCost": "string"
}
Памылкі3

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

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

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

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

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

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

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

GET

Атрымаць Stat кампаніі

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

Атрымаць Stat кампаніі з дапамогай GET /api/campaign/getStatCampaigns.

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

ПолеТыпАбавязковаАпісанне
organizationId integer · int64 Не Ід арганізацыі.
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 Так Паслуга.
status string Не Status.
campaignStatus stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Статус кампаніі.
type integer · int32 Не Type.
offset integer · int32 Не Згаршэнне.
dateTo string · date-time Не Дата да.
dateFrom string · date-time Не Дата ад.
isStatCampaign boolean Не Гэта кампанія Stat.
dateStart string · date-time Не Пачатак дата.
query string Не Запытваючы.
productExternalId integer · int64 Не Падчас выканання пастановы, выкананы пастаноўкі.
organizationIds integer[] Не Ідэнтыфікаты арганізацыі.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringEXTERNALID, SERVICE, CAMPAIGNNAME, CAMPAIGNTYPE, CATEGORYNAME, VIEWS, CLICKS, RATIOCLICKSVIEWS, AVERAGECOST, EXPENSES, QUANTITYADDCART, QUANTITYORDERS, RATIOORDERSOFVISITS, QUANTITYPRODUCTORDERS, ORDERSAMOUNT, CREATEDATE, STATUS Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/campaign/getStatCampaigns?service=NONE&limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseStatCampaign
ПолеТыпАбавязковаАпісанне
rows StatCampaign[] Не Рыжкі.
Структура элементаў масіва StatCampaign
ПолеТыпАбавязковаАпісанне
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy string Не Пасля.
ascending boolean Не Падыходзіць.
statCampaignId integer · int64 Не Stat кампаніі ID.
views integer · int32 Не Глядыні.
clicks integer · int32 Не Клікнуў.
ratioClicksViews number · double Не Пагадненне клікаў праглядаў.
averageCost number · double Не Сярэдні кошт.
expenses number · double Не Выдаткі.
quantityAddCart integer · int32 Не Колькасць дадаць кошык.
quantityOrders integer · int32 Не Колькасць заказы.
ratioOrdersOfVisits number · double Не Колькасць парадкаў наведванняў.
quantityProductOrders integer · int32 Не Колькасць заказаў прадукту.
ordersAmount number · double Не Колькасць замоў.
campaignId integer · int64 Не Ід кампаніі.
campaignName string Не Назва кампаніі.
createDate string · date-time Не Стварэнне Даты.
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 Не Паслуга.
campaignType stringIN_CATALOG, IN_CARD, IN_SEARCH, IN_MAIN, AUTO, IN_SEARCH_AND_CATALOG, BRAND_SHELF, UNKNOWN Не Тып кампаніі.
categoryName string Не Назва катэгорыі.
externalId integer · int64 Не Па-залежнае пазначэнне.
productId integer · int64 Не Ід прадукту.
productViewId integer · int64 Не Паказальнік прадукту.
date string · date-time Не Дата.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
importDate string · date-time Не Дата імпарту.
uniqueId string Не Унікальная пазнака.
clientId integer · int64 Не Ідэнтыфікатар кліента.
organizationId integer · int64 Не Ід арганізацыі.
organizationName string Не Назва арганізацыі.
rowType stringCAMPAIGN, UNALLOCATED Не Рыжкі тыпу.
quantityBuyouts number · double Не Купля колькасці.
revenue number · double Не Паступленне.
profitFact number · double Не Праўда прыбытку.
marginFact number · double Не Маржы факт.
drr number · double Не Доктар.
cps number · double Не Спіс.
quantityBuyoutsForecast number · double Не Прагноз аб колькасці выкупаў.
profitForecast number · double Не Прагноз прыбытку.
marginForecast number · double Не Прагноз маржы.
allowableExpenses number · double Не Дапушчальныя выдаткі.
currency string Не Валюта.
unavailableReasons object Не Недаступныя прычыны.
{
  "rows": "string"
}
Памылкі3

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

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

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

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

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

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

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

GET

Зрабіце кампаніі

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

Атрымаць кампаніі з дапамогай GET /api/campaign/getCampaigns.

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

ПолеТыпАбавязковаАпісанне
organizationId integer · int64 Так Ід арганізацыі.
status string Не Status.
campaignStatus stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Статус кампаніі.
type integer · int32 Не Type.
offset integer · int32 Не Згаршэнне.
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 Не Паслуга.
dateTo string · date-time Не Дата да.
dateFrom string · date-time Не Дата ад.
isStatCampaign boolean Не Гэта кампанія Stat.
dateStart string · date-time Не Пачатак дата.
query string Не Запытваючы.
productExternalId integer · int64 Не Падчас выканання пастановы, выкананы пастаноўкі.
organizationIds integer[] Не Ідэнтыфікаты арганізацыі.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringEXTERNALID, SERVICE, CAMPAIGNNAME, CAMPAIGNTYPE, CATEGORYNAME, VIEWS, CLICKS, RATIOCLICKSVIEWS, AVERAGECOST, EXPENSES, QUANTITYADDCART, QUANTITYORDERS, RATIOORDERSOFVISITS, QUANTITYPRODUCTORDERS, ORDERSAMOUNT, CREATEDATE, STATUS Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/campaign/getCampaigns?organizationId=1001&limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseCampaign
ПолеТыпАбавязковаАпісанне
rows Campaign[] Не Рыжкі.
Структура элементаў масіва Campaign
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
externalId integer · int64 Не Па-залежнае пазначэнне.
name string Не Назва.
campaignName string Не Назва кампаніі.
type stringIN_CATALOG, IN_CARD, IN_SEARCH, IN_MAIN, AUTO, IN_SEARCH_AND_CATALOG, BRAND_SHELF, UNKNOWN Не Type.
statusType stringDELETED, READY, FINISHED, CANCELLED, ACTIVE, PAUSED, UNKNOWN, ARCHIVED Не Тып статусу.
productId integer · int64 Не Ід прадукту.
externalProductId integer · int64 Не Па-за межамі ID прадукту.
createDate string · date-time Не Стварэнне Даты.
endDate string · date-time Не Завяршальная дата.
startDate string · date-time Не Пачатак дата.
sum integer · int64 Не Падробна.
writeOffType stringBALANCE, NET, BONUS Не Адпішыце ад тыпу.
onPause boolean Не На Паузе.
clientId integer · int64 Не Ідэнтыфікатар кліента.
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 Не Паслуга.
categoryId integer · int64 Не Ід катэгорыі.
categoryName string Не Назва катэгорыі.
campaignType string Не Тып кампаніі.
dateStatImport string · date-time Не Дата ўвозу Stat.
nms string Не НМС.
paymentType string Не Тып аплаты.
{
  "rows": "string"
}
Памылкі4

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

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

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

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

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

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

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

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

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

GET

Зрабіце баланс па кампаніі

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

Атрымаць баланс кампаніі з дапамогай GET /api/campaign/getCampaignBalance.

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

ПолеТыпАбавязковаАпісанне
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 Так Паслуга.
organizationId integer · int64 Так Ід арганізацыі.
curl --request GET 'https://api.selsup.ru/api/campaign/getCampaignBalance?service=NONE&organizationId=1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў WbBalance
ПолеТыпАбавязковаАпісанне
balance integer · int32 Не Раўнавагу.
net integer · int32 Не Сетка.
bonus integer · int32 Не Бонус.
{
  "balance": 1,
  "net": 1,
  "bonus": 1
}
Памылкі7

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

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

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

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

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

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

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

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

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

400error_service_not_supported
Сэрвіс не падтрымліваецца

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

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

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

400error_token_expired_or_revoked
Токен API адкліканы або ўведзены некарэктна. Праверце, што ключ API мае поўны функцыянал. Згенеруйце новы ключ і заменіце ў SELSUP, бо ключы маюць тэрмін жыцця.

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

Authorization

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

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

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

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

Жывы адказ API

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