v2.account_health.get_metric_source_detail
GET /api/v2/account_health/get_metric_source_detail
Get the Affected Orders / Relevant Listings / Relevant Violations details of metrics.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/account_health/get_metric_source_detail
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| metric_id | int64 | True | 1 | ID of metric. 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. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | The identifier for an API request for error tracking. | |
| response | object | ||
| metric_id | int64 | 1 | ID of metric. |
| 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 | Order SN. | |
| 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 | Order SN. | |
| 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 | Order SN. | |
| 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 | Order SN. | |
| shipping_deadline | timestamp | Ship by date. | |
| actual_shipping_time | timestamp | Seller arrange shipment time. | |
| late_by_days | int64 | Late-by Days. | |
| actual_pick_up_time | timestamp | Courier actual pick up time. | |
| shipping_channel | string | Logistics Company. | |
| first_mile_type | string | First mile shipping type. Applicable values: Pickup Drop off | |
| diagnosis_scenario | string[] | Diagnosis of the issue. | |
| 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 | Order SN. | |
| parcel_id | int64 | Parcel ID. | |
| parcel_display_id | string | Display Parcel ID. | |
| confirm_time | timestamp | Confirmed Date. | |
| handover_deadline | timestamp | Handover Deadline. | |
| fast_handover_due_date | timestamp | Fast Handover Due Date. | |
| arrange_pick_up_time | timestamp | Seller arrange pick up time. | |
| handover_time | timestamp | Parcel drop off / pickup time. | |
| shipping_channel | string | Logistics Company. | |
| first_mile_type | string | First mile shipping type. Applicable values: Pickup Drop off | |
| first_mile_tracking_no | string | First Mile Tracking No. | |
| diagnosis_scenario | string[] | Diagnosis of the issue. | |
| 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 | Number of scheduled pickups. |
| failed_pickup_num | int32 | 11 | Number of failed pickups. |
| 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 | Item ID. | |
| 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 | Updated on. | |
| 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 | Number of Live Listings. |
| pre_order_listing_count | int32 | 10 | Number of pre-order Listings. |
| 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 | Item ID. | |
| current_pre_order_status | int32 | Current Pre-order Status. Applicable values: 1: Yes 2: No | |
| sdd_listing_list | object[] | Relevant Listings for % SDD Listings. Supported metric_id: 96: % SDD Listings. | |
| item_id | int64 | Item ID. | |
| current_sdd_status | int32 | Current SDD Status. Applicable values: 1: Yes 0: No | |
| ndd_listing_list | object[] | Relevant Listings for % NDD Listings. Supported metric_id: 97: % NDD Listings. | |
| item_id | int64 | Item ID. | |
| current_ndd_status | int32 | Current NDD Status. Applicable values: 1: Yes 0: No | |
| apt_order_list | object[] | Affected Parcels for Preparation Time. Supported metric_id: 4: Preparation Time | |
| order_sn | string | Order SN. | |
| order_create_time | timestamp | Order Paid Time. | |
| arrange_pick_up_time | timestamp | Seller arrange pick up time. | |
| actual_pick_up_time | timestamp | Courier actual pick up time. | |
| preparation_days | float | Preparation Days. | |
| shipping_channel | string | Logistics Company. | |
| first_mile_type | string | First mile shipping type. Applicable values: Pickup Drop off | |
| first_mile_tracking_no | string | First Mile Tracking No. | |
| 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 | Item ID. | |
| 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[] | Affected Parcels for Saturday Shipment Supported metric_id: 2032: Saturday Shipment | |
| order_sn | string | Order SN. | |
| order_create_time | timestamp | Order Paid Time. | |
| arrange_pick_up_time | timestamp | Seller arrange pick up time. | |
| actual_pick_up_time | timestamp | Courier actual pick up time. | |
| preparation_days | float | Preparation Days. | |
| shipping_channel | string | Logistics Company. | |
| first_mile_type | string | First mile shipping type. Applicable values: Pickup Drop off | |
| first_mile_tracking_no | string | First Mile Tracking No. | |
| total_count | int32 | Total number of Affected Orders or Relevant Listings. |