v2.account_health.get_metric_source_detail
GET /api/v2/account_health/get_metric_source_detail
Lấy chi tiết về Đơn hàng Bị ảnh hưởng / Sản phẩm Liên quan / Vi phạm Liên quan của các chỉ số.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/account_health/get_metric_source_detail
Tham số chung
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| partner_id | int | 1 | ID đối tác được cấp sau khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để xác định thời điểm của yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token dùng để truy cập API, xác định quyền của bạn đối với API. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một gian hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Tên | Kiểu | Bắt buộc | Mẫu | Mô tả |
|---|---|---|---|---|
| metric_id | int64 | True | 1 | ID của chỉ số. Supported values: 1: Late Shipment Rate (All Channels) 3: Non-Fulfilment Rate (All Channels) 4: Preparation Time 12: Pre-order Listing % 15: Days of Pre-order Listing Violation 25: Fast Handover Rate 28: On-time Pickup Failure Rate Violation Value 42: Cancellation Rate (All Channels) 43: Return-refund Rate (All Channels) 52: Severe Listing Violations 53: Other Listing Violations 85: Late Shipment Rate (NDD) 88: Non-fulfilment Rate (NDD 91: Cancellation Rate (NDD) 92: Return-refund Rate (NDD) 96: % SDD Listings 97: % NDD Listings 2001: Fast Handover Rate - SLS 2002: Fast Handover Rate - FBS 2003: Fast Handover Rate - 3PF 2030: % HD Listings 2031: % HD Free Shipping Enabled 2032: Saturday Shipment 2033: Preparation Time PS |
| page_no | int32 | False | 1 | Specifies the page number of data to return in the current call. Starting from 1. if data is more than one page, the page_no can be some entry to start next call. Default is 1. |
| page_size | int32 | False | 10 | Each result set is returned as a page of entries. Use the "page_size" filters to control the maximum number of entries to retrieve per page (i.e., per call), and the "page_no" to start next call. This integer value is used to specify the maximum number of entries to return in a single "page" of data. The limit of page_size if between 1 and 100. Default is 10. |
Tham số Response
| Tên | Kiểu | Mẫu | Mô tả |
|---|---|---|---|
| error | string | Cho biết loại lỗi nếu xảy ra lỗi. Rỗng nếu không có lỗi. | |
| message | string | Cho biết chi tiết lỗi nếu xảy ra lỗi. Rỗng nếu không có lỗi. | |
| request_id | string | Mã định danh cho yêu cầu API, dùng để theo dõi lỗi. | |
| response | object | ||
| metric_id | int64 | 1 | ID của chỉ số. |
| nfr_order_list | object[] | Affected Orders for Non-fulfilment Rate. Supported metric_id: 3: Non-Fulfilment Rate (All Channels) 88: Non-fulfilment Rate (NDD) | |
| order_sn | string | Mã đơn hàng. | |
| non_fulfillment_type | int32 | Non-fulfilment type. Applicable values: 1: System Cancellation 2: Seller Cancellation 3: Return Refunds | |
| detailed_reason | int32 | Reason. Applicable values: 1001: Return Refund 1002: Parcel Split Cancellation 1003: First Mile Pick up fail 1004: Order inclusion 10005: Out of Stock 10006: Undeliverable area 10007: Cannot support COD 10008: Logistics request cancelled 10009: Logistics pickup failed 10010: Logistics not ready 10011: Inactive seller 10012: Seller did not ship order 10013: Order did not reach warehouse 10014: Seller asked to cancel 10015: Non-receipt 10016: Wrong item 10017: Damaged item 10018: Incomplete product 10019: Fake item 10020: Functional Damage 10021: Return Refund | |
| cancellation_order_list | object[] | Affected Orders for Cancellation Rate. Supported metric_id: 42: Cancellation Rate (All Channels) 91: Cancellation Rate (NDD) | |
| order_sn | string | Mã đơn hàng. | |
| cancellation_type | int32 | Cancellation Type. Applicable values: 1: System Cancellation 2: Seller Cancellation | |
| detailed_reason | int32 | Reason. Applicable values: 1001: Return Refund 1002: Parcel Split Cancellation 1003: First Mile Pick up fail 1004: Order inclusion 10005: Out of Stock 10006: Undeliverable area 10007: Cannot support COD 10008: Logistics request cancelled 10009: Logistics pickup failed 10010: Logistics not ready 10011: Inactive seller 10012: Seller did not ship order 10013: Order did not reach warehouse 10014: Seller asked to cancel 10015: Non-receipt 10016: Wrong item 10017: Damaged item 10018: Incomplete product 10019: Fake item 10020: Functional Damage 10021: Return Refund | |
| return_refund_order_list | object[] | Affected Orders for Return-refund Rate. Supported metric_id: 43: Return-refund Rate (All Channels) 92: Return-refund Rate (NDD) | |
| order_sn | string | Mã đơn hàng. | |
| detailed_reason | int32 | Reason. Applicable values: 1001: Return Refund 1002: Parcel Split Cancellation 1003: First Mile Pick up fail 1004: Order inclusion 10005: Out of Stock 10006: Undeliverable area 10007: Cannot support COD 10008: Logistics request cancelled 10009: Logistics pickup failed 10010: Logistics not ready 10011: Inactive seller 10012: Seller did not ship order 10013: Order did not reach warehouse 10014: Seller asked to cancel 10015: Non-receipt 10016: Wrong item 10017: Damaged item 10018: Incomplete product 10019: Fake item 10020: Functional Damage 10021: Return Refund | |
| lsr_order_list | object[] | Affected Orders for Late Shipment Rate. Supported metric_id: 1: Late Shipment Rate (All Channels) 85: Late Shipment Rate (NDD) | |
| order_sn | string | Mã đơn hàng. | |
| shipping_deadline | timestamp | Hạn giao hàng. | |
| actual_shipping_time | timestamp | Seller arrange shipment time. | |
| late_by_days | int64 | Số ngày trễ. | |
| actual_pick_up_time | timestamp | Thời gian thực tế đơn vị vận chuyển lấy hàng. | |
| shipping_channel | string | Công ty vận chuyển. | |
| first_mile_type | string | Loại vận chuyển đầu tiên. Các giá trị: Pickup (Lấy tại nhà) Drop off (Giao tại bưu cục) | |
| diagnosis_scenario | string[] | Chẩn đoán vấn đề. | |
| fhr_order_list | object[] | Affected Orders for Fast Handover Rate. Supported metric_id: 25: Fast Handover Rate 2001: Fast Handover Rate - SLS 2002: Fast Handover Rate - FBS 2003: Fast Handover Rate - 3PF | |
| order_sn | string | Mã đơn hàng. | |
| parcel_id | int64 | ID kiện hàng. | |
| parcel_display_id | string | ID hiển thị của kiện hàng. | |
| confirm_time | timestamp | Ngày xác nhận. | |
| handover_deadline | timestamp | Hạn chót bàn giao. | |
| fast_handover_due_date | timestamp | Hạn bàn giao nhanh. | |
| arrange_pick_up_time | timestamp | Thời gian người bán sắp xếp lấy hàng. | |
| handover_time | timestamp | Parcel drop off / pickup time. | |
| shipping_channel | string | Công ty vận chuyển. | |
| first_mile_type | string | Loại vận chuyển đầu tiên. Các giá trị: Pickup (Lấy tại nhà) Drop off (Giao tại bưu cục) | |
| first_mile_tracking_no | string | Mã theo dõi vận chuyển đầu tiên. | |
| diagnosis_scenario | string[] | Chẩn đoán vấn đề. | |
| opfr_day_detail_data_list | object[] | Relevant Violations for OPFR Violation Value. Supported metric_id: 28: On-time Pickup Failure Rate Violation Value | |
| date | string | 19/10/2024 | Date. |
| scheduled_pickup_num | int32 | 48 | Số lần lấy hàng đã lên lịch. |
| failed_pickup_num | int32 | 11 | Số lần lấy hàng thất bại. |
| opfr | int32 | OPFR. | |
| target | string | 49.90% | Target. |
| violation_listing_list | object[] | Relevant Listings for Severe Listing Violations and Other Listing Violations. Supported metric_id: 52: Severe Listing Violations 53: Other Listing Violations | |
| item_id | int64 | ID sản phẩm. | |
| detailed_reason | int32 | Reason. Applicable values: 1: Prohibited 2: Counterfeit 3: Spam 4: Inappropriate Image 5: Insufficient Info 6: Mall Listing Improvement 7: Other Listing Improvement 8: PQR Products | |
| update_time | timestamp | Cập nhật lúc. | |
| pre_order_listing_violation_data_list | object[] | Relevant Listings for Days of Pre-order Listing Violation. Supported metric_id: 15: Days of Pre-order Listing Violation | |
| date | string | 03/11/2024 | Date. |
| live_listing_count | int64 | 100 | Số sản phẩm đang hoạt động. |
| pre_order_listing_count | int32 | 10 | Số sản phẩm đặt trước. |
| pre_order_listing_rate | int32 | Pre-order Listing %. | |
| target | string | 13.00% | Target. |
| pre_order_listing_list | object[] | Relevant Listings for Pre-order Listing. Supported metric_id: 12: Pre-order Listing % | |
| item_id | int64 | ID sản phẩm. | |
| current_pre_order_status | int32 | Trạng thái đặt trước hiện tại. Các giá trị: 1: Có 2: Không | |
| sdd_listing_list | object[] | Relevant Listings for % SDD Listings. Supported metric_id: 96: % SDD Listings. | |
| item_id | int64 | ID sản phẩm. | |
| current_sdd_status | int32 | Trạng thái SDD hiện tại. Các giá trị: 1: Có 0: Không | |
| ndd_listing_list | object[] | Relevant Listings for % NDD Listings. Supported metric_id: 97: % NDD Listings. | |
| item_id | int64 | ID sản phẩm. | |
| current_ndd_status | int32 | Trạng thái NDD hiện tại. Các giá trị: 1: Có 0: Không | |
| apt_order_list | object[] | Affected Parcels for Preparation Time. Supported metric_id: 4: Preparation Time | |
| order_sn | string | Mã đơn hàng. | |
| order_create_time | timestamp | Thời gian thanh toán đơn hàng. | |
| arrange_pick_up_time | timestamp | Thời gian người bán sắp xếp lấy hàng. | |
| actual_pick_up_time | timestamp | Thời gian thực tế đơn vị vận chuyển lấy hàng. | |
| preparation_days | float | Số ngày chuẩn bị. | |
| shipping_channel | string | Công ty vận chuyển. | |
| first_mile_type | string | Loại vận chuyển đầu tiên. Các giá trị: Pickup (Lấy tại nhà) Drop off (Giao tại bưu cục) | |
| first_mile_tracking_no | string | Mã theo dõi vận chuyển đầu tiên. | |
| hd_listing_list | object | Relevant Listings for % HD Listings and % HD Free Shipping Enabled. Supported metric_id: 2030: % HD Listings 2031: % HD Free Shipping Enabled | |
| item_id | int64 | ID sản phẩm. | |
| current_status | int32 | For 2030: % HD Listings, it refer to Current HD Status. For 2031: % HD Free Shipping Enabled, it refer to Free Shipping Enabled Status. Applicable values: 1: Yes 2: No | |
| saturday_shipment_list | object[] | Kiện hàng bị ảnh hưởng bởi Giao hàng Thứ Bảy Hỗ trợ metric_id: 2032: Giao hàng Thứ Bảy | |
| order_sn | string | Mã đơn hàng. | |
| order_create_time | timestamp | Thời gian thanh toán đơn hàng. | |
| arrange_pick_up_time | timestamp | Thời gian người bán sắp xếp lấy hàng. | |
| actual_pick_up_time | timestamp | Thời gian thực tế đơn vị vận chuyển lấy hàng. | |
| preparation_days | float | Số ngày chuẩn bị. | |
| shipping_channel | string | Công ty vận chuyển. | |
| first_mile_type | string | Loại vận chuyển đầu tiên. Các giá trị: Pickup (Lấy tại nhà) Drop off (Giao tại bưu cục) | |
| first_mile_tracking_no | string | Mã theo dõi vận chuyển đầu tiên. | |
| total_count | int32 | Tổng số Đơn hàng Bị ảnh hưởng hoặc Sản phẩm Liên quan. |