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

وضعیت بای‌باکس تنوع‌ها

GET
/v1/buybox
curl --request GET \
  --url 'https://api.seller360.ir/v1/buybox?page=1&size=50&status=winner&floor_blocks=0' \
  --header 'Authorization: Bearer <token>'

وضعیت بای‌باکس هر تنوع که ربات آن را خوانده است: برنده بودن، رتبه، قیمت تخمینی لازم برای بردن، قیمت رقیب صاحب بای‌باکس و فاصله‌ی حداقل قیمت شما از قیمت بردن. خواندن ربات تا ۶ ساعت «زنده» شمرده می‌شود؛ پس از آن live: false است و برنده بودن از همگام‌سازی روزانه‌ی پنل خوانده می‌شود.

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
status
  • winner: بای‌باکس در اختیار شماست.
  • winnable: قیمت تخمینی بردن بالاتر یا برابر حداقل قیمت شماست؛ ربات تا آن پایین می‌آید.
  • structural: حتی قیمت تخمینی بردن زیر حداقل قیمت شماست و ربات بدون کاهش حداقل نمی‌تواند ببرد.
string
Allowed values: winner winnable structural

فقط تنوع‌هایی با این وضعیت.

floor_blocks
string
Allowed values: 0 1

فقط تنوع‌هایی که تنها حداقل قیمت شما مانع بردن بای‌باکس است (1).

variant_ids
string

فهرست شناسه‌ی تنوع‌ها با ویرگول (حداکثر ۱۰۰ شناسه).

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
variant_id
required
integer
sku
string | null
status
required
  • winner: بای‌باکس در اختیار شماست.
  • winnable: قیمت تخمینی بردن بالاتر یا برابر حداقل قیمت شماست؛ ربات تا آن پایین می‌آید.
  • structural: حتی قیمت تخمینی بردن زیر حداقل قیمت شماست و ربات بدون کاهش حداقل نمی‌تواند ببرد.
string
Allowed values: winner winnable structural
winner
required

بای‌باکس در اختیار شماست.

boolean
box_scope

برای برنده‌ها، بای‌باکس کل کالا (product) یا فقط همین تنوع و رنگ (variant).

string | null
Allowed values: product variant
live
required

خواندن ربات تازه است (حداکثر ۶ ساعت)؛ در غیر این صورت برنده بودن از همگام‌سازی روزانه‌ی پنل است.

boolean
reading_age_hours

سن خواندن ربات به ساعت، با یک رقم اعشار.

number | null
position

جایگاه شما در فهرست فروشندگان (۱ یعنی برنده).

integer | null
rival_count

تعداد رقبا در این بای‌باکس.

integer | null
our_price

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

integer | null
rival_price

قیمت واقعی صاحب فعلی بای‌باکس به ریال.

integer | null
rival_is_fbd

کالای صاحب بای‌باکس در انبار دیجی‌کالاست.

boolean
holder

صاحب بای‌باکس در آخرین مشاهده.

object
name
string
seller_id
integer | null
is_you
boolean
is_own_panel

یکی از پنل‌های دیگر حساب شماست، نه رقیب.

boolean
win_price

قیمت تخمینی لازم برای بردن (بالای دامنه‌ی کاهش ربات، نه قول قطعی).

One of:

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

object
value
required

ریال.

integer
estimated
required
boolean
drop_to_win

کاهش لازم از قیمت فعلی تا قیمت بردن به ریال (فقط برای غیربرنده با خواندن تازه).

integer | null
headroom

فضای افزایش قیمت بدون از دست دادن بای‌باکس به ریال (فقط برای برنده با خواندن تازه).

integer | null
floor

حداقل قیمتی که ربات رعایت می‌کند.

integer | null
floor_source
One of:

حداقلی که ربات اکنون رعایت می‌کند از کجا آمده است:

  • manual: حداقل قیمت دستی.
  • cost_plus: بهای خرید به‌علاوه‌ی سود هدف.
  • strategy: حداقل قیمتی که استراتژی (مثلا بر پایه‌ی حاشیه‌ی سود یا قیمت مرجع) می‌سازد.
string
Allowed values: manual cost_plus strategy
floor_gap

فاصله‌ی حداقل قیمت تا قیمت بردن به ریال، وقتی حداقل بالاتر است.

integer | null
floor_gap_pct

همان فاصله به درصد حداقل قیمت.

number | null
floor_blocks

تنها حداقل قیمت شما مانع بردن است و بردن با قیمت بردن هنوز زیان‌ده نیست.

boolean
breakeven

کمترین قیمت با سود خالص صفر.

One of:

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

object
value
required

ریال.

integer
estimated
required
boolean
profit_pct

سود خالص فعلی به درصد قیمت، با یک رقم اعشار.

number | null
win_profit_pct

سود خالص در قیمت بردن به درصد.

number | null
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": [
    {
      "variant_id": 84780448,
      "status": "winner",
      "box_scope": "product",
      "reading_age_hours": 0.2,
      "position": 2,
      "rival_count": 4,
      "our_price": 302000000,
      "rival_price": 298500000,
      "holder": {
        "name": "فروشگاه نمونه",
        "seller_id": 1083422
      },
      "win_price": {
        "value": 268000000,
        "estimated": true
      },
      "floor": 280000000,
      "floor_source": "manual",
      "breakeven": {
        "value": 268000000,
        "estimated": true
      },
      "profit_pct": 8.4
    }
  ]
}

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).