رفتن به محتوا
مستندات API سلر ۳۶۰

فهرست رقبا

GET
/v1/competitors
curl --request GET \
  --url 'https://api.seller360.ir/v1/competitors?page=1&size=50&label=unknown&watched=0' \
  --header 'Authorization: Bearer <token>'

هر فروشنده‌ای که روی تنوع‌های شما دیده شده است، به ترتیب احتمال ربات بودن. احتمال ربات بودن از تاریخچه‌ی ۳۰ روز اخیر تغییرات قیمت رقیب محاسبه می‌شود؛ با کمتر از ۶ تغییر، برچسب unknown می‌ماند. نمایه‌ها حداکثر هر یک ساعت دوباره محاسبه می‌شوند (synced_at).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1
size
integer
default: 50 >= 1 <= 500
label
  • unknown: نامشخص؛ داده‌ی کافی نیست (کمتر از ۶ تغییر).
  • human: به‌احتمال زیاد انسان (امتیاز کمتر از ۳۰).
  • suspect: مشکوک (امتیاز ۳۰ تا کمتر از ۶۰).
  • bot: به‌احتمال زیاد ربات (امتیاز ۶۰ و بیشتر).
string
Allowed values: unknown human suspect bot

فقط رقبایی با این برچسب.

watched
string
Allowed values: 0 1

فقط رقبای تحت‌نظر (1) یا غیر آن (0).

Responses

Section titled “Responses”

200

Section titled “200”

یک صفحه از رقبا.

Media typeapplication/json
object
status
required
Allowed value: ok
data
required
pager
required

همان نام فیلدهای صفحه‌بندی دیجی‌کالا.

object
page
required
integer
item_per_page
required
integer
total_pages
required
integer
total_rows
required
integer
data
Array<object>
object
rival_seller_id
required
integer
name
required
string
bot_score
required

احتمال ربات بودن، از ۰ تا ۱۰۰ (تخمینی).

integer
<= 100
label
required
  • unknown: نامشخص؛ داده‌ی کافی نیست (کمتر از ۶ تغییر).
  • human: به‌احتمال زیاد انسان (امتیاز کمتر از ۳۰).
  • suspect: مشکوک (امتیاز ۳۰ تا کمتر از ۶۰).
  • bot: به‌احتمال زیاد ربات (امتیاز ۶۰ و بیشتر).
string
Allowed values: unknown human suspect bot
signals

نشانه‌هایی که امتیاز از آن‌ها ساخته شده است.

Array<object>
object
key
required
  • reaction: سرعت واکنش به تغییر قیمت شما.
  • frequency: تعداد تغییر قیمت در روز.
  • regularity: نظم زمانی تغییرها.
  • undercut: فاصله‌ی ثابت زیر قیمت شما.
  • nonround: قیمت‌های غیرگرد.
string
Allowed values: reaction frequency regularity undercut nonround
value
required

شدت نشانه از ۰ تا ۱۰۰.

number | null
weight_pct
required

وزن نشانه در امتیاز به درصد.

number
variants_overlap

روی چند تنوع شما رقابت دارد.

integer
overlap_pct

درصد تنوع‌های فعال شما که این رقیب می‌فروشد.

number | null
win_rate

درصد مشاهده‌هایی که این رقیب صاحب بای‌باکس بود، با یک رقم اعشار.

number | null
est_floor

حداقل قیمت تخمینی رقیب (کمترین قیمت دیده‌شده).

One of:

مبلغی که سلر ۳۶۰ تخمین زده است، نه عددی که دیجی‌کالا اعلام کرده باشد.

object
value
required

ریال.

integer
estimated
required
boolean
sample_changes

تعداد تغییرهای پشت این امتیاز.

integer
watch_mode
required
  • auto: خودکار؛ اگر رقیب دست‌کم overlap_pct درصد از تنوع‌های فعال شما را بفروشد تحت‌نظر است.
  • on: همیشه تحت‌نظر.
  • off: هرگز تحت‌نظر نیست.
string
Allowed values: auto on off
is_watched
required

اکنون تحت‌نظر است.

boolean
strategy_note

یادداشت استراتژی شما برای این رقیب.

string
strategy_updated_at
string | null format: date-time
synced_at
required

زمان آخرین محاسبه‌ی نمایه.

string | null format: date-time

Example 

{
  "status": "ok",
  "pager": {
    "page": 1,
    "item_per_page": 50,
    "total_pages": 12,
    "total_rows": 587
  },
  "data": [
    {
      "rival_seller_id": 1083422,
      "name": "فروشگاه نمونه",
      "bot_score": 72,
      "label": "unknown",
      "signals": [
        {
          "key": "reaction",
          "value": 94,
          "weight_pct": 35
        }
      ],
      "variants_overlap": 23,
      "overlap_pct": 14.6,
      "win_rate": 41,
      "est_floor": {
        "value": 268000000,
        "estimated": true
      },
      "sample_changes": 312,
      "watch_mode": "auto"
    }
  ]
}

Headers

Section titled “Headers”
X-Request-Id
string

کد پیگیری این درخواست.

X-RateLimit-Limit
integer

سقف درخواست این نوع (خواندن یا نوشتن) در هر دقیقه برای این کلید.

X-RateLimit-Remaining
integer

درخواست‌های باقی‌مانده تا پایان دقیقه‌ی جاری.

X-RateLimit-Reset
integer

زمان شروع دقیقه‌ی بعد، به ثانیه از ۱۹۷۰ (Unix).

400

Section titled “400”

پارامتر یا بدنه‌ی نامعتبر.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

کد پیگیری این درخواست.

X-RateLimit-Limit
integer

سقف درخواست این نوع (خواندن یا نوشتن) در هر دقیقه برای این کلید.

X-RateLimit-Remaining
integer

درخواست‌های باقی‌مانده تا پایان دقیقه‌ی جاری.

X-RateLimit-Reset
integer

زمان شروع دقیقه‌ی بعد، به ثانیه از ۱۹۷۰ (Unix).

401

Section titled “401”

کلید ارسال نشده یا نامعتبر است.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

403

Section titled “403”

کلید دسترسی لازم را ندارد، یا ماژول یا پنل فعال نیست.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

429

Section titled “429”

سقف درخواست گذشته است.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

Headers

Section titled “Headers”
Retry-After
integer

چند ثانیه صبر کنید و دوباره تلاش کنید.

X-RateLimit-Limit
integer

سقف درخواست این نوع (خواندن یا نوشتن) در هر دقیقه برای این کلید.

X-RateLimit-Remaining
integer

درخواست‌های باقی‌مانده تا پایان دقیقه‌ی جاری.

X-RateLimit-Reset
integer

زمان شروع دقیقه‌ی بعد، به ثانیه از ۱۹۷۰ (Unix).