Get Settlement Summary Report

Get summary of payments/refund/fees from seller’s account per settlement date.

Resource 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}

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.

Parameters

Resource Information

Request Body

Schema: GetReportRequest.xsd

Example: 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>

Example: 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"
        }
    }
}

Response Body

Schema: settlementSummaryResponse.xsd

Example: 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>

Example: 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": []
}

Request Failure Errors

For common HTTP error responses, please refer to Failed Response Error Code List.

Example: XML, Response

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

Example: Json, Response

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

Last updated: September 23, 2021