مرجوعی‌ها

GET

/v1/returns

curl --request GET \
  --url 'https://api.seller360.ir/v1/returns?page=1&size=50&variant_id=84780448' \
  --header 'Authorization: Bearer <token>'

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

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

Authorizations

• apiKey

Parameters

Query Parameters

page

integer

default: 1 >= 1

size

integer

default: 50 >= 1 <= 500

returned_from

string format: date-time

فقط برگشت‌هایی که از این زمان به بعد به انبار رسیده‌اند.

returned_to

string format: date-time

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

variant_id

integer

Example

84780448

فقط مرجوعی‌های این تنوع.

Responses

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

order_id

required

integer

variant_id

required

integer

product_id

integer | null

supplier_code

string

sku

string | null

title

required

string

sold_at

string | null format: date-time

quantity

required

واحدهای فروخته‌شده‌ی قلم.

integer

returned_quantity

required

integer

returned_at

required

زمان رسیدن اولین واحد مرجوعی به انبار.

string format: date-time

unit_price

required

ریال.

integer

returned_amount

required

واحدهای مرجوعی ضرب در قیمت هر واحد، به ریال.

integer

source

required

منبع این ردیف. فعلا فقط سریال‌های اقلام سفارش.

string

Allowed values: order_items

synced_at

string | null format: date-time

Example

{
  "status": "ok",
  "pager": {
    "page": 1,
    "item_per_page": 50,
    "total_pages": 12,
    "total_rows": 587
  },
  "data": [
    {
      "order_id": 385760690,
      "variant_id": 84780448,
      "product_id": 22961150,
      "supplier_code": "5144",
      "sku": "NK-1024-G",
      "title": "محافظ ولتاژ پارت الکتریک مدل PE5144",
      "quantity": 2,
      "returned_quantity": 1,
      "unit_price": 300000000,
      "returned_amount": 300000000,
      "source": "order_items"
    }
  ]
}

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

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