پیوستن کالاها به کمپین (در صف)

POST

/v1/campaigns/{campaign_id}/join

curl --request POST \
  --url https://api.seller360.ir/v1/campaigns/30512/join \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "items": [ { "variant_id": 84780448, "price": 265000000, "qty": 10, "order_limit": 2 } ] }'

• سرور اصلی (کلید `s360_live_…`، و کلید `s360_test_…` روی پنل نمایشی)

تا ۵۰ تنوع در هر درخواست. حداقل قیمت شما در کمپین هم مرز قطعی است: کالای بدون حداقل قیمت نمی‌پیوندد و قیمت پیشنهادی کمتر از حداقل رد می‌شود. پس از مهلت پیوستن، خطای campaign_closed برمی‌گردد. پذیرش هر کالا با دیجی‌کالاست؛ نتیجه‌ی ثبت با GET /v1/jobs/{job_id} و تایید یا رد نهایی با GET /v1/campaigns/{campaign_id} و رویداد promotion.rejected اعلام می‌شود.

Authorizations

• apiKey

Parameters

Path Parameters

campaign_id

required

integer

Example

30512

شناسه‌ی کمپین در دیجی‌کالا.

Header Parameters

Idempotency-Key

required

string

>= 8 characters <= 255 characters

یک شناسه‌ی یکتا برای هر تغییر (مثلا UUID). اگر پاسخ را دریافت نکردید، همان درخواست را با همان کلید تکرار کنید؛ تغییر دو بار انجام نمی‌شود. پاسخ اول تا ۲۴ ساعت نگه داشته می‌شود.

Request Body^required

Media typeapplication/json

object

items

required

Array<object>

>= 1 items <= 50 items

object

variant_id

required

integer

Example

84780448

price

required

قیمت پیشنهادی در کمپین به ریال؛ حداکثر برابر cap کالا.

integer

multiple of 100

Example

265000000

qty

required

تعداد کالا در کمپین؛ دست‌کم برابر min_qty کمپین.

integer

>= 1

Example

10

order_limit

سقف تعداد در هر سفارش.

integer

>= 1

Example

2

Responses

202

کار در صف ثبت شد.

Media typeapplication/json

object

status

required

Allowed value: ok

data

required

data

required

object

id

required

string

kind

required

string

Allowed values: stock_batch price_batch stock_split_run variant_request product_draft package_build package_delete pickup_book consignment_draft_build price_undo promotion_batch campaign_join campaign_leave fx_confirm

status

required

unknown یعنی پاسخ دیجی‌کالا نرسید و نتیجه هنوز روشن نیست؛ این وضعیت هرگز به معنی «انجام نشد» نیست و سلر ۳۶۰ با بررسی دوباره آن را به completed یا failed تبدیل می‌کند.

string

Allowed values: queued running completed partial failed unknown

created_at

required

string format: date-time

finished_at

string | null format: date-time

result

نتیجه‌ی کارهایی که قلم به قلم نیستند، به شکل خاص هر نوع کار؛ مثلا شناسه‌ی محموله‌ی ساخته‌شده (package_id)، شناسه‌ی اجرای تقسیم موجودی (run_id) یا شناسه‌ی تنوع ساخته‌شده (variant_id).

object | null

items

Array<object>

object

variant_id

integer

status

string

Allowed values: pending applied refused

error

کد خطا برای قلم ردشده.

string | null

Example

{
  "status": "ok",
  "data": {
    "id": "job_8f2c1e",
    "kind": "stock_batch",
    "status": "queued",
    "items": [
      {
        "status": "pending"
      }
    ]
  }
}

Headers

X-Request-Id

string

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

X-RateLimit-Limit

integer

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

X-RateLimit-Remaining

integer

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

X-RateLimit-Reset

integer

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

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

X-Request-Id

string

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

X-RateLimit-Limit

integer

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

X-RateLimit-Remaining

integer

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

X-RateLimit-Reset

integer

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

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

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

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"
  }
}

404

مورد درخواست‌شده در این پنل وجود ندارد.

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

X-Request-Id

string

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

X-RateLimit-Limit

integer

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

X-RateLimit-Remaining

integer

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

X-RateLimit-Reset

integer

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

422

درخواست درست است اما قاعده‌ی کسب‌وکار اجازه نمی‌دهد (مثلا قیمت بیرون از بازه).

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

X-Request-Id

string

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

X-RateLimit-Limit

integer

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

X-RateLimit-Remaining

integer

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

X-RateLimit-Reset

integer

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

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

Retry-After

integer

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

X-RateLimit-Limit

integer

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

X-RateLimit-Remaining

integer

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

X-RateLimit-Reset

integer

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