獲取報表處理狀態
獲取指定報表請求的狀態。
相關URL
Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/status?sellerid={sellerid} Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/status?sellerid={sellerid}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
名稱 | 是否必填? | 描述 |
sellerid | 是 | 您在新蛋商城的商家編號 |
相關請求資訊
HTTP方式 | 是否需要認證? | 請求格式 | 回覆格式 | 頻率限制 |
PUT | 需要 | XML,Json | XML,Json | 500 請求/小時 |
請求文件主體
屬性 | 是否必填? | 格式 | 描述 |
IssueUser | 否 | String | 請求發送者在Seller Portal上註冊過的郵箱位址 。 系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號 |
OperationType | 是 | String | 固定值:GetReportStatusRequest |
RequestID | 否 | String | 一個由新蛋為每個資料請求生成請求ID的列表,如果指定請求ID,RequestType,MaxCount,RequestStatus, RequestDateFrom和RequestDateTo都可以忽略。 |
RequestType | 是 | String | 任務類型列表,可用值: ALL (Default) ORDER_LIST_REPORT SETTLEMENT_SUMMARY_REPORT SETTLEMENT_TRASACTION_ REPORT DAILY_INVENTORY_ REPORT RMA_LIST_REPORT ITEM_LOOKUP INTERNATIONAL_INVENTORY_REPORT INTERNATIONAL_PRICE_REPORT CAPROP65 _REPORT ITEM_BASIC_INFO_REPORT |
MaxCount | 否 | Integer | 返回記錄數最大值。預設值最大值均為100。如果你的值超過100,系統仍只返回100條記錄 |
RequestStatus | 否 | String | 資料提交狀態, 有效值: SUBMITTED(已提交) IN_PROGRESS(處理中) FINISHED(已完成) CANCELLED(已取消) ALL(所有) |
RequestDateFrom | 否 | String | 根據時間範圍查找(太平洋標準時間)。請參考可接受時間格式 |
RequestDateTo | 否 | String | 根據時間範圍查找(太平洋標準時間)。請參考可接受時間格式 |
Schema: GetReportStatusRequest.xsd
示例:XML, Request
PUT https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest> <OperationType>GetReportStatusRequest</OperationType> <RequestBody> <GetRequestStatus> <RequestIDList> <RequestID>2PQBYWH4V68ZP</RequestID> </RequestIDList> <MaxCount>10</MaxCount> </GetRequestStatus> </RequestBody> </NeweggAPIRequest>
示例:Json, Request
PUT https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "GetReportStatusRequest", "RequestBody": { "GetRequestStatus": { "RequestIDList": { "RequestID": "2PQBYWH4V68ZP" }, "MaxCount": "10" } } }
回覆文件主體
屬性 | 格式 | 描述 |
IsSuccess | String | 獲取資料狀態操作: True:成功 False:失敗 |
OperationType | String | 固定值:GetReportStatusResponse |
RequestId | String | 新蛋為已提交的請求分配的編號 |
RequestType | String | 有效值: ORDER_LIST_REPORT SETTLEMENT_SUMMARY_REPORT SETTLEMENT_TRASACTION_REPORT DAILY_INVENTORY_ REPORT RMA_LIST_REPORT ITEM_LOOKUP INTERNATIONAL_INVENTORY_REPORT INTERNATIONAL_PRICE_REPORT PREMIER_ITEM_REPORT CAPROP65 _REPORT ITEM_BASIC_INFO_REPORT |
RequestDate | String | 資料提交的時間(太平洋標準時間) |
RequestSatus | String | 提交狀態: SUBMITTED 已提交 IN_PROGRESS 處理中 FINISHED 已完成 CANCELLED 已取消 |
TotalCount | Integer | 記錄總數 |
Memo | String | 附加資訊 |
Schema: GetReportStatusResponse.xsd
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>GetReportStatusResponse</OperationType> <SellerID>A006</SellerID> <ResponseBody> <ResponseList> <ResponseInfo> <RequestId>2PQBYWH4V68ZP</RequestId> <RequestType>ORDER_LIST_REPORT</RequestType> <RequestDate>2/21/2012 14:38:17</RequestDate> <RequestStatus>FINISHED</RequestStatus> <TotalCount>4</TotalCount> </ResponseInfo> </ResponseList> </ResponseBody> </NeweggAPIResponse>
示例: Json, Response
{ "IsSuccess": true, "OperationType": "GetReportStatusResponse", "ResponseBody": { "ResponseList": [ { "RequestDate": "2/21/2012 14:38:17", "RequestId": "2PQBYWH4V68ZP", "RequestStatus": "IN_PROGRESS", "RequestType": "ORDER_LIST_REPORT", "TotalCount": 4 } ] }, "SellerID": "A006" }
請求失敗錯誤資訊
常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單。
錯誤代碼 | 描述 |
RP004 | Date From is required. 起始時間(Date From)必填 |
RP005 | Date To is required. 結束時間(Date To)必填 |
RP006 | Invalid Date From. 無效的起始時間(Date From) |
RP007 | Invalid Date To. 無效的結束時間(Date To) |
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>RP004</Code> <Message>Date From is required</Message> </Error> </Errors>
示例: Json, Response
[ { "Code": "RP004", "Message": "Date From is required" } ]
更新日期:10/28/2021