提交結算交易報表
請求獲取指定結算期間交易明細報表。
相關URL
Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/submitrequest?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/submitrequest?sellerid={sellerid}
註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。
參數
| 名稱 | 是否必填? | 描述 |
| sellerid | 是 | 您在新蛋商城的商家編號 |
相關請求資訊
| HTTP方式 | 是否需要認證? | 請求格式 | 回覆格式 | 頻率限制 |
| POST | 需要 | XML,Json | XML,Json | 100 請求/小時 |
請求文件主體
| 屬性 | 是否必填? | 格式 | 描述 |
| IssueUser | 否 | String | 請求發送者在Seller Portal上註冊過的郵箱位址 。 系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號 |
| OperationType | 是 | String | 固定值:SettlementTransactionReportRequest |
| RequestType | 是 | String | 固定值:SETTLEMENT_TRANSACTION_REPORT |
| OrderNumber | 否 | Integer | 新蛋制訂給訂單的編號 |
| TransactionType | 否 | Integer | 有效值: 0: All (Default) 所有(默認) 1: Order 訂單 2: Refund 退款 3: CreditRequest 僅退款 4: Chargeback 信用卡拒付 5: MonthlyFee 月費 6: FulfillByNeweggFee 新蛋配送費 7: Multi-ChannelFee 多管道運費 8: RMAProcessingFee 退換貨處理費 9: Tax & Duty 稅費 10: StorageFee 倉儲費 11: RMABuyoutFee 12: AdjustmentFee 其他 13: MonthlyFeeByCC 月費 14: SBNInboundFee 新蛋入倉費 15: MerchandisingFee 廣告費 16: NeweggPremierFee 新蛋Premier費 17: NeweggShippingLabelFee 新蛋貨運標籤費 18: ReturnAndDisposalFee 庫存移除/銷毀費 19: NeweggRelabelingFee 重新貼標費 20: Recycling Fee / EHF 回收費 21: Return Shipping Label Fee 退貨標籤費 22: Newegg Service Fee Tax (Newegg.ca only) 23: Print Shipping Label Service打印貨運標籤費 24: Reserved Balance 預留金 25: Previous Reserved Balance 上期預留金 |
| SettlementDateFrom | 否 | String | 根據結算時間範圍查詢(太平洋標準時間)。請參考可接受時間格式 |
| SettlementDateTo | 否 | String | 根據結算時間範圍查詢(太平洋標準時間)。請參考可接受時間格式 |
| SettlementDate | 否 | String | 根據結算時間範圍查詢(太平洋標準時間)。請參考可接受時間格式 |
| SettlementID | 否 | Integer | 結算交易編號 |
Schema: SettlementTransactionRequest.xsd
示例:XML, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest>
<OperationType>SettlementTransactionReportRequest</OperationType>
<RequestBody>
<SettlementTransactionReportCriteria>
<RequestType>SETTLEMENT_TRANSACTION_REPORT</RequestType>
<TransactionType>1</TransactionType>
<SettlementDateFrom>2011-02-21</SettlementDateFrom>
<SettlementDateTo>2012-02-22</SettlementDateTo>
<SettlementDate>2/23/2012</SettlementDate>
</SettlementTransactionReportCriteria>
</RequestBody>
</NeweggAPIRequest>
示例:Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "SettlementTransactionReportRequest",
"RequestBody": {
"SettlementTransactionReportCriteria": {
"RequestType": "SETTLEMENT_TRANSACTION_REPORT",
"TransactionType": "1",
"SettlementDateFrom": "2011-02-21",
"SettlementDateTo": "2012-02-22",
"SettlementDate": "2/23/2012"
}
}
}
回覆文件主體
| 屬性 | 格式 | 描述 |
| IsSuccess | String | 獲取資料狀態操作: True:成功 False:失敗 |
| OperationType | String | 固定值:SettlementTransactionReportResponse |
| SellerID | String | 您的商家編號 |
| RequestId | String | 新蛋為已提交的請求分配的編號 |
| RequestType | String | 固定值:SETTLEMENT_TRANSACTION_REPORT |
| RequestDate | String | 資料提交的時間(太平洋標準時間) |
| RequestSatus | String | 提交狀態: SUBMITTED 已提交(默認) |
| Memo | String | 附加資訊 |
Schema: SubmitReportResponse.xsd
示例: XML, Response
<NeweggAPIResponse>
<IsSuccess>true</IsSuccess>
<OperationType>SettlementTransactionReportResponse</OperationType>
<SellerID>a001</SellerID>
<ResponseBody>
<ResponseList>
<ResponseInfo>
<RequestId>270Z8Y3SYIGQV</RequestId>
<RequestType>SETTLEMENT_TRANSACTION_REPORT</RequestType>
<RequestDate>07/12/2014 11:02:35</RequestDate>
<RequestStatus>SUBMITTED</RequestStatus>
</ResponseInfo>
</ResponseList>
</ResponseBody>
</NeweggAPIResponse>
示例: Json, Response
{
"IsSuccess": true,
"OperationType": "SettlementTransactionReportResponse",
"SellerID": "a001",
"ResponseBody": {
"ResponseList": [
{
"RequestId": "270Z8Y3SYIGQV",
"RequestType": "SETTLEMENT_TRANSACTION_REPORT",
"RequestDate": "07/12/2014 11:34:57",
"RequestStatus": "SUBMITTED"
}
]
}
}
請求失敗錯誤資訊
常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單。
| 錯誤代碼 | 描述 |
| RP010 | Invalid Order Number. 無效的 Order Number |
| RP018 | Invalid Settlement Date. 無效的 Settlement Date(結算時間) |
| RP019 | The requestID cannot be null or empty. 請求編號(requestID)不能為空 |
| RP020 | We are unable to process your request because one of the following search criteria is required: SettlementID, SettlementDate, or SettlementDateFrom and SettlementDateTo. 我們無法處理你的請求,因為你必須提供下列搜索條件中的一個:SettlementID, SettlementDate, 或 SettlementDateFrom 和 SettlementDateTo |
| RP021 | Maximum item lookup cannot exceed 1000 for each request. 每個請求的商品檢索數量最多不超過1000個 |
| RP022 | Daily Inventory Report does not support multiple warehouse locations. For multiple warehouse locations, please use International Program – Daily Inventory Report. 每日庫存報表不支持多個倉庫所在地。若有多個倉庫所在地,請使用新蛋全球化- 每日庫存報表章節內容. |
示例: XML, Response
<?xml version="1.0" encoding="utf-8"?>
<Errors>
<Error>
<Code>RP018</Code>
<Message>Invalid Settlement Date</Message>
</Error>
</Errors>
示例: Json, Response
[
{
"Code": "RP018",
"Message": "Invalid Settlement Date"
}
]
更新日期:12/01/2020