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

فهرست سفارش‌ها

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

هر سفارش با همه‌ی اقلام آن، تازه‌ترین اول. هر قلم یک تنوع از یک سفارش است (هر تنوع در هر سفارش فقط یک بار می‌آید). اطلاعات سفارش هر شب و پس از هر وب‌هوک سفارش دیجی‌کالا تازه می‌شود؛ برای سفارش‌هایی که هنوز ارسال نشده‌اند و خبر فوری، از GET /v1/open-orders و رویداد order.created استفاده کنید.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 >= 1
size
integer
default: 50 >= 1 <= 500
created_from
string format: date-time

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

created_to
string format: date-time

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

state

وضعیت سفارش که سلر ۳۶۰ از اقلام آن می‌سازد. sold: فروش قطعی بدون لغو و مرجوعی؛ partially_returned: بخشی از واحدها برگشته است؛ returned: همه‌ی واحدهای غیرلغوشده برگشته‌اند؛ partially_cancelled: بخشی از اقلام لغو شده است؛ cancelled: همه‌ی اقلام لغو شده‌اند.

string
Allowed values: sold partially_returned returned partially_cancelled cancelled

فقط سفارش‌هایی با این وضعیت.

variant_id
integer

Example 

84780448

فقط سفارش‌هایی که این تنوع (عدد کد DKPC) را دارند.

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>

یک سفارش دیجی‌کالا با همه‌ی اقلام آن در این پنل. بدون هیچ اطلاعاتی از خریدار.

object
order_id
required
integer
created_at
required

زمان ثبت سفارش در دیجی‌کالا.

string format: date-time
state
required

وضعیت سفارش که سلر ۳۶۰ از اقلام آن می‌سازد. sold: فروش قطعی بدون لغو و مرجوعی؛ partially_returned: بخشی از واحدها برگشته است؛ returned: همه‌ی واحدهای غیرلغوشده برگشته‌اند؛ partially_cancelled: بخشی از اقلام لغو شده است؛ cancelled: همه‌ی اقلام لغو شده‌اند.

string
Allowed values: sold partially_returned returned partially_cancelled cancelled
quantity
required

جمع واحدهای همه‌ی اقلام.

integer
total_price
required

جمع مبلغ اقلام، به ریال.

integer
net_amount
required

مبلغ فروش خالص (بدون اقلام لغوشده و واحدهای مرجوعی)، به ریال.

integer
items
required
Array<object>

یک تنوع از یک سفارش.

object
variant_id
required

عدد کد DKPC.

integer
product_id

عدد کد DKP.

integer | null
supplier_code

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

string
sku

کد کالای سایت شما، اگر جفت شده باشد.

string | null
title
required
string
category
string
image_url
string | null format: uri
product_url
string | null format: uri
shipment_id

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

integer | null
quantity
required
integer
unit_price
required

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

integer
unit_discount

تخفیف هر واحد، به ریال.

integer
total_price
required

مبلغ کل قلم، به ریال.

integer
payment_type

نوع پرداخت (نقدی یا اعتباری) همان‌گونه که دیجی‌کالا می‌گوید. فهرست کامل مقادیر دیجی‌کالا مشخص نیست.

string
sell_type

نوع فروش (مثلا b2c یا b2b) همان‌گونه که دیجی‌کالا می‌گوید.

string
shipping_type

نوع ارسال همان‌گونه که دیجی‌کالا می‌گوید.

string
digikala_status

وضعیت متنی قلم در دیجی‌کالا، بدون تغییر. فهرست کامل مقادیر دیجی‌کالا مشخص نیست.

string
state
required

وضعیت قلم که سلر ۳۶۰ می‌سازد. وضعیت متنی دیجی‌کالا جداگانه در digikala_status آمده است.

string
Allowed values: sold partially_returned returned cancelled
is_cancelled
required

کل قلم لغو شده است.

boolean
returned_quantity
required

واحدهایی که به انبار دیجی‌کالا برگشته‌اند.

integer
returned_at

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

string | null format: date-time
net_quantity
required

واحدهای فروش قطعی (صفر برای قلم لغوشده).

integer
net_amount

مبلغ فروش قطعی قلم، به ریال.

integer
serial_count
integer
synced_at
required

آخرین خواندن این سفارش از دیجی‌کالا.

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,
      "state": "sold",
      "quantity": 2,
      "total_price": 600000000,
      "net_amount": 300000000,
      "items": [
        {
          "variant_id": 84780448,
          "product_id": 22961150,
          "supplier_code": "5144",
          "sku": "NK-1024-G",
          "title": "محافظ ولتاژ پارت الکتریک مدل PE5144",
          "category": "محافظ ولتاژ",
          "shipment_id": 402118734,
          "quantity": 2,
          "unit_price": 300000000,
          "unit_discount": 0,
          "total_price": 600000000,
          "payment_type": "نقدی",
          "sell_type": "b2c",
          "digikala_status": "ارسال شده",
          "state": "sold",
          "returned_quantity": 1,
          "net_quantity": 1,
          "net_amount": 300000000,
          "serial_count": 2
        }
      ]
    }
  ]
}

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

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