یک کمپین و کالاهای شما در آن

GET

/v1/campaigns/{campaign_id}

curl --request GET \
  --url https://api.seller360.ir/v1/campaigns/30512 \
  --header 'Authorization: Bearer <token>'

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

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

Authorizations

• apiKey

Parameters

Path Parameters

campaign_id

required

integer

Example

30512

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

Responses

200

کمپین.

Media typeapplication/json

object

status

required

Allowed value: ok

data

required

data

required

object

campaign

required

object

id

required

integer

title

required

string

nature

required

نوع کمپین؛ مقادیر شناخته‌شده: incredible_offer (شگفت‌انگیز)، mega_promotion (مگاکمپین)، deal_of_the_day (شگفت‌انگیز روز). دیجی‌کالا ممکن است نوع تازه‌ای اضافه کند.

string

status

وضعیت کمپین در دیجی‌کالا.

string

start_at

string | null format: date-time

end_at

string | null format: date-time

join_deadline

required

مهلت پیوستن.

string | null format: date-time

deadline_passed

required

boolean

conditions

شرایط کمپین به متن دیجی‌کالا.

Array<string>

min_discount_pct

integer | null

min_qty

حداقل تعداد کالا در کمپین.

integer

potential_variants

تعداد تنوع‌های شما که می‌توانند بپیوندند.

integer | null

participants

integer | null

joined

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

boolean

commission_discount

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

boolean

link

string | null format: uri

synced_at

required

زمان خواندن از دیجی‌کالا.

string format: date-time

open

required

مهلت پیوستن نگذشته است.

boolean

mine

required

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

Array<object>

object

variant_id

required

integer

promotion_variant_id

شناسه‌ی حضور کالا در کمپین (برای خروج).

integer | null

selling_price

integer | null

promotion_price

integer | null

cap

بیشترین قیمت مجاز در کمپین به ریال.

integer | null

floor

حداقل قیمت شما به ریال.

integer | null

stock

integer | null

state

required

• ok: پیوستن ممکن است.
• blocked: سقف قیمت کمپین کمتر از حداقل قیمت شماست.
• no_floor: تنوع حداقل قیمت ندارد.

string

Allowed values: ok blocked no_floor

status

وضعیت کالا در کمپین:

• draft: ثبت‌شده، در انتظار بررسی دیجی‌کالا.
• pending و partially_approved: در انتظار تایید.
• approved: تاییدشده.
• rejected و partially_rejected: ردشده توسط دیجی‌کالا (دلیل در rejection_reason).
• active: فعال.
• ended: پایان‌یافته.

string | null

Allowed values: draft pending approved rejected active ended partially_approved partially_rejected

rejection_reason

string | null

in_other_incredible

کالا در شگفت‌انگیز دیگری هم هست.

boolean

buy_box_winner

boolean

sales_last_week

integer | null

candidates

required

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

Array<object>

object

variant_id

required

integer

promotion_variant_id

شناسه‌ی حضور کالا در کمپین (برای خروج).

integer | null

selling_price

integer | null

promotion_price

integer | null

cap

بیشترین قیمت مجاز در کمپین به ریال.

integer | null

floor

حداقل قیمت شما به ریال.

integer | null

stock

integer | null

state

required

• ok: پیوستن ممکن است.
• blocked: سقف قیمت کمپین کمتر از حداقل قیمت شماست.
• no_floor: تنوع حداقل قیمت ندارد.

string

Allowed values: ok blocked no_floor

status

وضعیت کالا در کمپین:

• draft: ثبت‌شده، در انتظار بررسی دیجی‌کالا.
• pending و partially_approved: در انتظار تایید.
• approved: تاییدشده.
• rejected و partially_rejected: ردشده توسط دیجی‌کالا (دلیل در rejection_reason).
• active: فعال.
• ended: پایان‌یافته.

string | null

Allowed values: draft pending approved rejected active ended partially_approved partially_rejected

rejection_reason

string | null

in_other_incredible

کالا در شگفت‌انگیز دیگری هم هست.

boolean

buy_box_winner

boolean

sales_last_week

integer | null

Example

{
  "status": "ok",
  "data": {
    "campaign": {
      "id": 30512,
      "title": "شگفت‌انگیز آخر هفته",
      "nature": "incredible_offer",
      "min_discount_pct": 10,
      "min_qty": 5
    },
    "mine": [
      {
        "variant_id": 84780448,
        "promotion_variant_id": 51820044,
        "selling_price": 300000000,
        "promotion_price": 265000000,
        "cap": 269900000,
        "state": "ok",
        "status": "draft"
      }
    ],
    "candidates": [
      {
        "variant_id": 84780448,
        "promotion_variant_id": 51820044,
        "selling_price": 300000000,
        "promotion_price": 265000000,
        "cap": 269900000,
        "state": "ok",
        "status": "draft"
      }
    ]
  }
}

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

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

502

دیجی‌کالا تغییر را نپذیرفت یا پاسخ نامعتبر داد؛ هیچ تغییری ثبت نشد.

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

503

دیجی‌کالا در دسترس نیست یا سقف آن پر است؛ پس از Retry-After دوباره تلاش کنید.

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

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