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

سهم هر کالا از یک واریز

GET
/v1/finance/payouts/{payout_id}/products
curl --request GET \
  --url 'https://api.seller360.ir/v1/finance/payouts/12209179/products?page=1&size=50&by=variant' \
  --header 'Authorization: Bearer <token>'

پول هر کالا در همین واریز و سود آن نسبت به قیمت خرید روز فروش. این نگاه همین واریز است، نه سود کل عمر یک واحد: ماندگاری و مرجوعی یک واریز اغلب به فروش‌های واریزهای قبلی تعلق دارد. اگر قیمت خرید حتی یک واحد از کالا معلوم نباشد، profit آن خالی (null) است.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
payout_id
required
integer

Example 

12209179

شناسه‌ی واریز در دیجی‌کالا.

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1
size
integer
default: 50 >= 1 <= 500
by
string
default: variant
Allowed values: variant dkp supplier

سطح گروه‌بندی کالاها: variant هر تنوع (DKPC)، dkp هر کالا (همه‌ی تنوع‌های یک DKP با هم)، supplier هر کد فروشنده (چند تنوع با یک کد با هم جمع می‌شوند).

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
key
required

کلید گروه (v تنوع، p کالا، s کد فروشنده).

string
variant_id

خالی وقتی گروه چند تنوع دارد.

integer | null
variants
required

تعداد تنوع‌های گروه.

integer
product_id
integer | null
supplier_code
string
title
required
string
units_sold
required
integer
units_returned
required
integer
sale

فروش بدون مالیات، ریال.

integer
damaged
integer
return

برگشت از فروش بدون مالیات (منفی).

integer
return_refund
integer
commission
integer
platform
integer
fulfilment
integer
storage
integer
penalty
integer
other
integer
vat
required

مالیات با علامت، ریال.

integer
net
required

خالص این کالا در واریز، با مالیات، ریال.

integer
cost

بهای خرید واحدها در روز فروش منهای بهای واحدهای برگشتی؛ خالی اگر قیمت حتی یک واحد معلوم نباشد.

integer | null
cost_missing_units
required
integer
profit
integer | null
margin_pct

سود نسبت به فروش، درصد.

number | null
avg_sale_price
integer | null
avg_net
integer | null
avg_cost
integer | null
avg_profit
integer | null
avg_deductions

اندازه‌ی کسورات هر واحد.

integer | null
deductions_pct

کسورات نسبت به فروش، درصد.

number | null
return_pct

برگشتی نسبت به فروخته‌شده، درصد.

number | null
ded_commission
integer
ded_platform
integer
ded_fulfilment
integer
ded_storage
integer
ded_freight
integer
ded_penalty
integer
ded_return_refund
integer
ded_other
integer
ded_tax
integer
meta
object
overhead
required

مبالغی از واریز که به هیچ کالایی تعلق ندارند (مثل حمل محموله)، بدون مالیات، و مالیات آن‌ها.

object
lines
required
Array<object>
object
category
required

دسته‌ای که هر ردیف مالی در صورت‌حساب به آن تعلق دارد، از روی شناسه‌ی نوع ردیف دیجی‌کالا (notation_id) و در نبود آن از روی عنوانش. هر ردیف ناشناخته در other می‌آید و هرگز حذف نمی‌شود. balance، prior_payout و early_settlement جابه‌جایی خود حساب‌اند، نه فروش یا هزینه.

One of:
فروش کالا
string
Allowed value: sale
title
required
string
amount
required
integer
vat
required
integer
total
required
integer
totals
required
object
net
required

جمع خالص کالاها و مبالغ بدون کالا.

integer
sale
required
integer
profit_known
required

جمع سود کالاهایی که سودشان معلوم است.

integer
products_with_profit
required
integer
products
required
integer

Example 

{
  "status": "ok",
  "pager": {
    "page": 1,
    "item_per_page": 50,
    "total_pages": 12,
    "total_rows": 587
  },
  "data": [
    {
      "key": "v84780448",
      "variant_id": 84780448,
      "variants": 1,
      "product_id": 22961150,
      "supplier_code": "5144",
      "title": "محافظ ولتاژ پارت الکتریک مدل PE5144",
      "units_sold": 12,
      "units_returned": 1,
      "sale": 440400000,
      "damaged": 0,
      "return": -36700000,
      "return_refund": 4100000,
      "commission": -52800000,
      "platform": 0,
      "fulfilment": -23400000,
      "storage": 0,
      "penalty": 0,
      "other": 0,
      "vat": -7200000,
      "net": 324400000,
      "cost": 265100000,
      "cost_missing_units": 0,
      "profit": 59300000,
      "margin_pct": 13.5,
      "avg_sale_price": 36700000,
      "avg_net": 29800000,
      "avg_cost": 24100000,
      "avg_profit": 5700000,
      "avg_deductions": 6900000,
      "deductions_pct": 18.8,
      "return_pct": 3.1,
      "ded_commission": 4160000,
      "ded_fulfilment": 1950000,
      "ded_tax": 611000
    }
  ],
  "meta": {
    "overhead": {
      "lines": [
        {
          "category": "commission"
        }
      ]
    }
  }
}

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

404

Section titled “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

Section titled “Headers”
X-Request-Id
string

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

X-RateLimit-Limit
integer

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

X-RateLimit-Remaining
integer

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

X-RateLimit-Reset
integer

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

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