獲取結算匯總報表

每個結算日獲取結算/退款/傭金匯總報表。

相關URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/result?{sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/result?{sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/result?sellerid={sellerid}={version}

註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。

參數

名稱 是否必填? 描述
sellerid 您在新蛋商城的商家編號
version 有效版本:

版本 適用平台 結果
306 Neweggbusiness.com,Newegg.ca 回覆包含

  • RecyclingFeeTotal
307 所有 回覆包含:

  • NeweggShippingLabelFee
  • NeweggPremierFee
308 Newegg.com 回覆移除:

  • Other
  • MiscellaneousAdjustment
  • NeweggTransactionFee
  • NeweggRMABuyoutFee

回覆包含:

  • TaxDuty
  • CourtesyRefund
  • CreditCardPayment
  • FulfillmentByNeweggFee
  • MultiChannelFee
  • AdjustmentFee
  • MerchandisingFee
308 Neweggbusiness.com 回覆移除:

  • Other
  • MiscellaneousAdjustment
  • NeweggTransactionFee
  • NeweggRMABuyoutFee

回覆包含:

  • CourtesyRefund
  • CreditCardPayment
  • FulfillmentByNeweggFee
  • MultiChannelFee
  • AdjustmentFee
  • MerchandisingFee
308 Newegg.ca 回覆移除:

  • GSTTotal
  • HSTTotal
  • PSTTotal
  • Other
  • MiscellaneousAdjustment
  • NeweggTransactionFee
  • NeweggRMABuyoutFee

回覆包含:

  • GSTAndHST
  • PSTAndQST
  • CourtesyRefund
  • CreditCardPayment
  • FulfillmentByNeweggFee
  • MultiChannelFee
  • AdjustmentFee
  • MerchandisingFee
309 Newegg.com 回覆包:

  • RecyclingFeeTotal
310 所有 回覆包含:

  • ReservedBalance
  • PreviousReservedBalance

相關請求資訊

HTTP方式 是否需要認證? 請求格式 回覆格式 頻率限制
PUT 需要 XML,Json XML,Json 500 請求/小時

請求文件主體

屬性 是否必填? 格式 描述
IssueUser String 請求發送者在Seller Portal上註冊過的郵箱位址 。
系統只接受商家註冊過的Seller Portal郵箱位址。如果為空,預設值為商家編號
OperationType String 固定值:SettlementSummaryReportRequest
RequestID String 新蛋分配的已提交的請求的編號
PageIndex Integer 當前頁索引
PageSize Integer 單頁返回的記錄總數
每頁最多100條。

Schema: GetReportRequest.xsd

示例:XML, Request

PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest >
    <OperationType>SettlementSummaryReportRequest</OperationType>
    <RequestBody>
        <RequestID>2PQBYWH4V68ZP</RequestID>
        <PageInfo>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
    </RequestBody>
</NeweggAPIRequest>

示例:Json, Request

PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "SettlementSummaryReportRequest",
    "RequestBody": {
        "RequestID": "2PQBYWH4V68ZP",
        "PageInfo": {
            "PageSize": "10",
            "PageIndex": "1"
        }
    }
}

回覆文件主體

屬性 格式 描述
IsSuccess String 用於獲取資料狀態的操作
True:成功
False:失敗
SellerID String 你的商家編號
OperationType String 固定值: GetSettlementSummaryInfoResponse
RequestID String 你的請求編號
RequestDate String 請求時間(太平洋標準時間)
TotalCount Integer 總記錄數
TotalPageCount Integer 總頁數
PageIndex Integer 當前頁索引
PageSize Integer 單頁的記錄個數
SettlementDateFrom String 結算起始時間(太平洋標準時間)
SettlementDateTo String 結算結束時間(太平洋標準時間)
SettlementID String 結算編號
CheckNumber String 核查編號
ItemPrice Decimal 商品價格

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
Shipping Decimal 運費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
TaxDuty Decimal 關稅

  • Newegg.com所有金額都設置使用美元(USD)
  • 可用版本:308

不適用於Newggbusiness.com 和 Newegg.ca平台

GSTTotal Decimal 增值稅總額

  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本:308

不適用於Newgg.com 和 Neweggbusiness.com平台

HSTTotal Decimal 消費稅總額

  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本:308

不適用於Newgg.com 和 Neweggbusiness.com平台

GSTAndHST Decimal 消費稅和增值稅

  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本:308

不適用於Newgg.com 和 Neweggbusiness.com平台

PSTTotal Decimal 省銷售稅

  • Newegg.ca所有金額都設置使用加幣(CAD)

不適用於Newgg.com 和 Neweggbusiness.com平台

PSTAndQST Decimal 省銷售稅(PST, QST)

  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本:308

不適用於Newgg.com 和 Neweggbusiness.com平台

EHFTotal Decimal 環境處理費

  • Newegg.ca所有金額都設置使用加幣(CAD)

不適用於Newgg.com 和 Neweggbusiness.com平台

Other Decimal 其他

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本:308
RecyclingFeeTotal Decimal 回收費是政府對新購買的電子產品、電池、新輪胎等徵收的費用。這些費用用於支付這些產品的未來回收,因為其中許多產品含有有害物質。以下回收費用將添加到回收費用總額中:電子廢物回收費、電池回收費、輪胎回收費、環保費。

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.com可用版本:309
  • Neweggbusiness 可用版本:306
TotalOrderAmount Decimal 訂單總金額

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
Refunds Decimal 退款額

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
ChargeBack Decimal 信用卡扣款

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
MiscellaneousAdjustment Decimal 雜項調整

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本:308
CourtesyRefund Decimal 補償性退款

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本:308
TotalRefunds Decimal 退款總金額

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  •  Newegg.ca所有金額都設置使用加幣(CAD)
NeweggCommissionFee Decimal 新蛋傭金

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
NeweggTransactionFee Decimal 新蛋交易費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本:308
NeweggRefundCommissionFee Decimal 新蛋退款傭金

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
NeweggMonthlyFee Decimal 新蛋月費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
NeweggStorageFee Decimal 新蛋保管費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
NeweggRMABuyoutFee Decimal 新蛋RMA Buyout費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 不適用版本: 308
NeweggServiceFeeTax Decimal 新蛋Service稅費

  • Newegg.ca所有金額都設置使用加幣(CAD)

不適用於Newgg.com 和 Neweggbusiness.com平台

NeweggPremierFee Decimal 新蛋Premier費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • 可用版本:307
NeweggShippingLabelFee Decimal 新蛋發貨標籤費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • 可用版本:307
CreditCardPayment Decimal 信用卡支付

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本: 308
FulfillmentByNeweggFee Decimal 新蛋配送費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本:308
MultiChannelFee Decimal 多管道運費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本:308
AdjustmentFee Decimal 其他

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本:308
MerchandisingFee Decimal 廣告費

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
  • 可用版本:308
TotalNeweggFee Decimal 新蛋費用總計

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
TotalSettlement Decimal 結算總計

  • Newegg.com 和 Newggbusiness.com所有金額都設置使用美元(USD)
  • Newegg.ca所有金額都設置使用加幣(CAD)
ReservedBalance Decimal 預留金額
新蛋暫時扣留的金額,用於支付您帳戶上潛在的索賠,退貨和退單
PreviousReservedBalance Decimal 前次預留金額:上一次匯款時暫時扣留的金額
Memo String 附加資訊

Schema: settlementSummaryResponse.xsd

示例: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <SellerID>A09D</SellerID>
    <OperationType>GetSettlementSummaryInfoResponse</OperationType>
    <ResponseBody>
        <PageInfo>
            <TotalCount>1</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageSize>10</PageSize>
            <PageIndex>1</PageIndex>
        </PageInfo>
        <RequestID>2PQBZMZTL3DYF</RequestID>
        <RequestDate>2/21/2012 15:12:55</RequestDate>
        <SettlementSummaryList>
            <SettlementSummary>
                <SettlementDate>2/21/2012 12:00:00</SettlementDate>
                <SettlementDateFrom>8/5/2011 12:00:00</SettlementDateFrom>
                <SettlementDateTo>2/21/2012 12:00:00</SettlementDateTo>
                <SettlementID>0</SettlementID>
                <CheckNumber />
                <ItemPrice>71.00</ItemPrice>
                <Shipping>31.95</Shipping>
                <Other>0.00</Other>
                <TotalOrderAmount>102.95</TotalOrderAmount>
                <Refunds>-1.98</Refunds>
                <ChargeBack>0.00</ChargeBack>
                <MiscellaneousAdjustment>-182.53</MiscellaneousAdjustment>
                <TotalRefunds>-184.51</TotalRefunds>
                <NeweggCommissionFee>-7.71</NeweggCommissionFee>
                <NeweggTransactionFee>0.00</NeweggTransactionFee>
                <NeweggRefundCommissionFee>0.15</NeweggRefundCommissionFee>
                <NeweggMonthlyFee>0.00</NeweggMonthlyFee>
                <NeweggStorageFee>-59.05</NeweggStorageFee>
                <NeweggRMABuyoutFee>-0.72</NeweggRMABuyoutFee>
                <NeweggPremierFee>0.00</NeweggPremierFee>
                <NeweggShippingLabelFee>0.00</NeweggShippingLabelFee>
                <TotalNeweggFee>-638.63</TotalNeweggFee>
                <TotalSettlement>-720.19</TotalSettlement>
                <ReservedBalance>12.22</ReservedBalance>
                <PreviousReservedBalance>1.22</PreviousReservedBalance>
            </SettlementSummary>
        </SettlementSummaryList>
    </ResponseBody>
    <Memo />
</NeweggAPIResponse>
<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <SellerID>BFUS</SellerID>
    <OperationType>GetSettlementSummaryInfoResponse</OperationType>
    <ResponseBody>
        <PageInfo>
            <TotalCount>2</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
        <RequestID>24L8PVM11WG8S</RequestID>
        <RequestDate>04/27/2020 02:49:09</RequestDate>
        <SettlementSummaryList>
            <SettlementSummary>
                <SettlementDate>10/16/2019 00:00:00</SettlementDate>
                <SettlementDateFrom>05/14/2012 00:00:00</SettlementDateFrom>
                <SettlementDateTo>10/16/2019 00:00:00</SettlementDateTo>
                <SettlementID>0</SettlementID>
                <CheckNumber></CheckNumber>
                <ItemPrice>1256.46</ItemPrice>
                <Shipping>611.90</Shipping>
                <GSTTotal>41.00</GSTTotal>
                <HSTTotal>0.00</HSTTotal>
                <PSTTotal>0.00</PSTTotal>
                <EHFTotal>0.00</EHFTotal>
                <Other>0.00</Other>
                <TotalOrderAmount>1909.36</TotalOrderAmount>
                <Refunds>-36.50</Refunds>
                <ChargeBack>0.00</ChargeBack>
                <MiscellaneousAdjustment>-75.67</MiscellaneousAdjustment>
                <TotalRefunds>-112.17</TotalRefunds>
                <NeweggCommissionFee>-186.85</NeweggCommissionFee>
                <NeweggTransactionFee>0.00</NeweggTransactionFee>
                <NeweggRefundCommissionFee>3.65</NeweggRefundCommissionFee>
                <NeweggMonthlyFee>-19.99</NeweggMonthlyFee>
                <NeweggStorageFee>-6.98</NeweggStorageFee>
                <NeweggRMABuyoutFee>0.00</NeweggRMABuyoutFee>
                <NeweggServiceFeeTax>0.00</NeweggServiceFeeTax>
                <TotalNeweggFee>-263.29</TotalNeweggFee>
                <TotalSettlement>1533.90</TotalSettlement>
        <ReservedBalance>12.22</ReservedBalance>
        <PreviousReservedBalance>1.22</PreviousReservedBalance>
            </SettlementSummary>
            <SettlementSummary>
                <SettlementDate>04/22/2020 00:00:00</SettlementDate>
                <SettlementDateFrom>11/19/2013 00:00:00</SettlementDateFrom>
                <SettlementDateTo>04/22/2020 00:00:00</SettlementDateTo>
                <SettlementID>0</SettlementID>
                <CheckNumber></CheckNumber>
                <ItemPrice>1256.46</ItemPrice>
                <Shipping>611.90</Shipping>
                <GSTTotal>41.00</GSTTotal>
                <HSTTotal>0.00</HSTTotal>
                <PSTTotal>0.00</PSTTotal>
                <EHFTotal>0.00</EHFTotal>
                <Other>0.00</Other>
                <TotalOrderAmount>1930.36</TotalOrderAmount>
                <Refunds>-36.50</Refunds>
                <ChargeBack>0.00</ChargeBack>
                <MiscellaneousAdjustment>-75.67</MiscellaneousAdjustment>
                <TotalRefunds>-112.17</TotalRefunds>
                <NeweggCommissionFee>-186.85</NeweggCommissionFee>
                <NeweggTransactionFee>0.00</NeweggTransactionFee>
                <NeweggRefundCommissionFee>3.65</NeweggRefundCommissionFee>
                <NeweggMonthlyFee>0.00</NeweggMonthlyFee>
                <NeweggStorageFee>0.00</NeweggStorageFee>
                <NeweggRMABuyoutFee>0.00</NeweggRMABuyoutFee>
                <NeweggServiceFeeTax>-2.52</NeweggServiceFeeTax>
                <TotalNeweggFee>-200.79</TotalNeweggFee>
                <TotalSettlement>1617.40</TotalSettlement>
                <ReservedBalance>12.22</ReservedBalance>
                <PreviousReservedBalance>1.22</PreviousReservedBalance>
            </SettlementSummary>
        </SettlementSummaryList>
    </ResponseBody>
    <Memo></Memo>
</NeweggAPIResponse>

示例: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "SellerID": "A09D",
        "OperationType": "GetSettlementSummaryInfoResponse",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "1",
                "TotalPageCount": "1",
                "PageSize": "10",
                "PageIndex": "1"
            },
            "RequestID": "2PQBZMZTL3DYF",
            "RequestDate": "2/21/2012 15:12:55",
            "SettlementSummaryList": [
                {
                    "SettlementDate": "2/21/2012 12:00:00",
                    "SettlementDateFrom": "8/5/2011 12:00:00",
                    "SettlementDateTo": "2/21/2012 12:00:00",
                    "SettlementID": "0",
                    "ItemPrice": "71.00",
                    "Shipping": "31.95",
                    "Other": "0.00",
                    "TotalOrderAmount": "102.95",
                    "Refunds": "-1.98",
                    "ChargeBack": "0.00",
                    "MiscellaneousAdjustment": "-182.53",
                    "TotalRefunds": "-184.51",
                    "NeweggCommissionFee": "-7.71",
                    "NeweggTransactionFee": "0.00",
                    "NeweggRefundCommissionFee": "0.15",
                    "NeweggMonthlyFee": "0.00",
                    "NeweggStorageFee": "-59.05",
                    "NeweggRMABuyoutFee": "-0.72",
                    "NeweggPremierFee": "0.00",
                    "NeweggShippingLabelFee": "0.00",
                    "TotalNeweggFee": "-638.63",
                    "TotalSettlement": "-720.19",
                    "ReservedBalance": "12.22",
                    "PreviousReservedBalance": "1.22"
                }
            ]
        }
    }
}
{ 
   "IsSuccess": "true",
   "SellerID": "BFUS",
   "OperationType": "GetSettlementSummaryInfoResponse",
   "ResponseBody": { 
      "PageInfo": { 
         "TotalCount": "2",
         "TotalPageCount": "1",
         "PageIndex": "1",
         "PageSize": "10"
      },
      "RequestID": "24L8PVM11WG8S",
      "RequestDate": "04/27/2020 02:49:09",
      "SettlementSummaryList": [ 
         { 
            "SettlementDate": "10/16/2019 00:00:00",
            "SettlementDateFrom": "05/14/2012 00:00:00",
            "SettlementDateTo": "10/16/2019 00:00:00",
            "SettlementID": "0",
            "CheckNumber": [],
            "ItemPrice": "1256.46",
            "Shipping": "611.90",
            "GSTTotal": "41.00",
            "HSTTotal": "0.00",
            "PSTTotal": "0.00",
            "EHFTotal": "0.00",
            "Other": "0.00",
            "TotalOrderAmount": "1909.36",
            "Refunds": "-36.50",
            "ChargeBack": "0.00",
            "MiscellaneousAdjustment": "-75.67",
            "TotalRefunds": "-112.17",
            "NeweggCommissionFee": "-186.85",
            "NeweggTransactionFee": "0.00",
            "NeweggRefundCommissionFee": "3.65",
            "NeweggMonthlyFee": "-19.99",
            "NeweggStorageFee": "-6.98",
            "NeweggRMABuyoutFee": "0.00",
            "NeweggServiceFeeTax": "0.00",
            "TotalNeweggFee": "-263.29",
            "TotalSettlement": "1533.90",
            "ReservedBalance": "12.22",
            "PreviousReservedBalance": "1.22"
         },
         { 
            "SettlementDate": "04/22/2020 00:00:00",
            "SettlementDateFrom": "11/19/2013 00:00:00",
            "SettlementDateTo": "04/22/2020 00:00:00",
            "SettlementID": "0",
            "CheckNumber": [],
            "ItemPrice": "1256.46",
            "Shipping": "611.90",
            "GSTTotal": "41.00",
            "HSTTotal": "0.00",
            "PSTTotal": "0.00",
            "EHFTotal": "0.00",
            "Other": "0.00",
            "TotalOrderAmount": "1930.36",
            "Refunds": "-36.50",
            "ChargeBack": "0.00",
            "MiscellaneousAdjustment": "-75.67",
            "TotalRefunds": "-112.17",
            "NeweggCommissionFee": "-186.85",
            "NeweggTransactionFee": "0.00",
            "NeweggRefundCommissionFee": "3.65",
            "NeweggMonthlyFee": "0.00",
            "NeweggStorageFee": "0.00",
            "NeweggRMABuyoutFee": "0.00",
            "NeweggServiceFeeTax": "-2.52",
            "TotalNeweggFee": "-200.79",
            "TotalSettlement": "1617.40",
            "ReservedBalance": "12.22",
            "PreviousReservedBalance": "1.22"
         }
      ]
   },
   "Memo": []
}

請求失敗錯誤資訊

常規HTTP錯誤回應,請參考回覆失敗錯誤代碼清單

示例: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>CE001</Code>
        <Message>SellerID cannot be null or empty</Message>
    </Error>
</Errors>

示例: Json, Response

[
    {
        "Code": "CE001",
        "Message": "SellerID cannot be null or empty"
    }
]

更新日期:09/23/2021