پیش‌بینی سه واریز آینده

GET

/v1/finance/payout-forecast

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.seller360.ir/v1/finance/payout-forecast"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.seller360.ir/v1/finance/payout-forecast';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

هر ردیف پرداخت‌نشده به روزی که باید «قابل تسویه» شود و به اولین واریز پس از آن روز نسبت داده می‌شود. مبلغ هر واریز از پنج بخش ساخته می‌شود که منشا هر عدد را نشان می‌دهند: certain (ردیف‌های قابل تسویه)، cash و credit (فروش‌های ثبت‌شده‌ی نقدی و اعتباری)، costs_est (میانگین روزانه‌ی هزینه‌هایی مثل ماندگاری و جریمه) و future_est (فروش‌هایی که هنوز انجام نشده‌اند). low بخش فروش‌های آینده را ندارد و high دارد. واریزی که دیجی‌کالا ثبت کرده است با fixed برابر true و مبلغ قطعی می‌آید. تسویه‌ی زودهنگام پیش‌بینی نمی‌شود؛ آنچه پیش‌تر برداشته شده است در early آمده است.

Authorizations

apiKey

Responses

200

پیش‌بینی واریزها.

application/json

object

status

required

Allowed value: ok

data

required

data

required

object

payouts

required

سه واریز پیش رو، به ترتیب تاریخ.

Array<object>

یک واریز آینده و منشا هر بخش مبلغ آن، همه به ریال و با علامت.

object

date

required

string format: date

certain

required

ردیف‌هایی که هم‌اکنون «قابل تسویه»اند، یا مبلغ قطعی واریزی که دیجی‌کالا ثبت کرده است.

integer

cash

required

فروش‌های نقدی ثبت‌شده و هزینه‌هایشان که تا آن روز آزاد می‌شوند.

integer

credit

required

فروش‌های اعتباری ثبت‌شده که تا آن روز آزاد می‌شوند.

integer

costs_est

required

هزینه‌های روزانه‌ی تخمینی (ماندگاری، جریمه، حمل) بر پایه‌ی میانگین ۱۴ روز.

integer

future_est

required

فروش‌هایی که هنوز انجام نشده‌اند، بر پایه‌ی میانگین ۱۴ روز.

integer

late

required

بخشی از مبلغ که روز آزاد شدنش گذشته و هنوز منتظر است (درون cash و credit هم شمرده شده است).

integer

early

required

تسویه‌ی زودهنگامی که پیش‌تر برداشته شده و از این واریز کم می‌شود (درون certain).

integer

low

required

certain + cash + credit + costs_est.

integer

high

required

low + future_est.

integer

expected

required

عدد پیش‌بینی؛ برابر high.

integer

fixed

required

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

boolean

estimated

required

عکس fixed: مبلغ تخمینی است.

boolean

payout_id

فقط وقتی fixed است.

integer | null

status

فقط وقتی fixed است.

One of:

string
null

in_queue در صف تسویه، send_to_bank ارسال به بانک، paid تسویه‌شده، rejected رد شده (برگشت از بانک).

string

Allowed values: in_queue send_to_bank paid rejected

cash_release_days

required

چند روز پس از فروش، فروش نقدی آزاد می‌شود.

integer

credit_release_days

required

integer

cash_day

required

همان، با شمردن روز فروش به‌عنوان روز اول.

integer

credit_day

required

integer

daily_costs

required

میانگین هزینه‌های روزانه‌ی ۱۴ روز اخیر، ریال.

integer

daily_sales

required

میانگین فروش روزانه‌ی ۱۴ روز اخیر، ریال.

integer

terms

required

object

calc_days

required

دوره‌ی تسویه؛ هر چند روز یک واریز («بازه محاسبه صورت‌حساب»).

integer

calc_source

required

منشا عدد: seller (شما ثبت کرده‌اید)، digikala (از API دیجی‌کالا)، default (عدد پیش‌فرض، چون هیچ‌کدام در دسترس نیست).

string

Allowed values: seller digikala default

api_calc_days

دوره‌ی تسویه به روایت API دیجی‌کالا.

integer | null

pay_days

required

بازه‌ی پرداخت به روز («بازه پرداخت»)؛ در API دیجی‌کالا نیست.

integer

pay_source

required

seller یا default.

string

Allowed values: seller digikala default

credit_days

required

روزی که فروش اعتباری آزاد می‌شود، با شمردن روز فروش به‌عنوان روز اول؛ پیش‌فرض دو برابر pay_days.

integer

credit_source

required

seller یا default.

string

Allowed values: seller digikala default

cash_day

required

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

integer

credit_day

required

integer

next_settlement

تاریخ واریز بعدی به روایت دیجی‌کالا.

string | null format: date

summary_at

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

string | null format: date-time

set_at

زمان آخرین ثبت شرایط توسط شما.

string | null format: date-time

money_path

required

نمونه‌ی کاربردی شرایط تسویه برای فروشی که امروز انجام شود.

object

sale

string format: date

cash_release

string format: date

cash_payout

string | null format: date

credit_release

string format: date

credit_payout

string | null format: date

cost_payout

واریزی که هزینه‌های امروز در آن کم می‌شود.

string | null format: date

synced_at

string | null format: date-time

Example

{
  "status": "ok",
  "data": {
    "payouts": [
      {
        "date": "2026-11-15",
        "certain": 1120000000,
        "cash": 1460000000,
        "credit": 210000000,
        "costs_est": -18000000,
        "future_est": 0,
        "late": 0,
        "early": 0,
        "low": 2772000000,
        "high": 2772000000,
        "expected": 2772000000,
        "status": "in_queue"
      }
    ],
    "cash_release_days": 9,
    "credit_release_days": 19,
    "cash_day": 10,
    "credit_day": 20,
    "daily_costs": -9000000,
    "daily_sales": 412000000,
    "terms": {
      "calc_days": 5,
      "calc_source": "seller",
      "api_calc_days": 5,
      "pay_days": 10,
      "pay_source": "seller",
      "credit_days": 20,
      "credit_source": "seller",
      "cash_day": 10,
      "credit_day": 20
    }
  }
}

Headers

X-Request-Id

string

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

X-RateLimit-Limit

integer

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

X-RateLimit-Remaining

integer

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

X-RateLimit-Reset

integer

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

401

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

application/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

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

application/json

object

status

required

Allowed value: error

error

required

object

code

required

string

message

required

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

string

detail

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

string

doc_url

required

string format: uri

request_id

required

string

Example

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

429

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

application/json

object

status

required

Allowed value: error

error

required

object

code

required

string

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