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={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/result?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/result?sellerid={sellerid}

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

Name Required? Description
sellerid Yes Your seller ID on Newegg Marketplace

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
PUT Required XML, Json XML, Json 500 request per hour

Request Body

Attribute Required? Format Description
IssueUser No String Issuer’s registered Seller Portal email address. System will only accept Seller’s
registered Seller Portal email addresses.If left blank, default value will be Seller ID.
OperationType Yes String Fixed values: SettlementSummaryReportRequest
RequestID Yes String Newegg’s assigned ID for submitted request
PageIndex Yes Integer Current page index
PageSize Yes Integer Return records count in one page

Max is 100 per page

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

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

SellerID String Your seller ID
OperationType String Fixed value: GetSettlementSummaryInfoResponse
RequestID String Newegg’s assigned ID for submitted request
RequestDate String Your request date time (Pacific Standard Time)
TotalCount Integer Total number of records
TotalPageCount Integer Total page count
PageIndex Integer Current page index
PageSize Integer How many records in a page
SettlementDateFrom String Settlement Date From (Pacific Standard Time)
SettlementDateTo String Settlement Date To (Pacific Standard Time)
SettlementID String Newegg’s assigned ID for settlement
CheckNumber String Check number
ItemPrice Decimal ItemPrice

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
Shipping Decimal Shipping

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
Other Decimal Other

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
TotalOrderAmount Decimal TotalOrderAmount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
Refunds Decimal Refunds

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
ChargeBack Decimal ChargeBack

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
MiscellaneousAdjustment Decimal MiscellaneousAdjustment

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
TotalRefunds Decimal TotalRefunds

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggCommissionFee Decimal NeweggCommissionFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggTransactionFee Decimal NeweggTransactionFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggRefundCommissionFee Decimal NeweggRefundCommissionFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggMonthlyFee Decimal NeweggMonthlyFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggStorageFee Decimal NeweggStorageFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggRMABuyoutFee Decimal NeweggRMABuyoutFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
NeweggPremierFee Decimal NeweggPremierFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)

Not available for Neweggbusiness.com and Newegg.ca

NeweggShippingLabelFee Decimal NeweggShippingLabelFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)

Not available for Neweggbusiness.com and Newegg.ca

TotalNeweggFee Decimal TotalNeweggFee

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
TotalSettlement Decimal TotalSettlement

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
Memo String Additional information
ResponseDate String The response date of report

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>
            </SettlementSummary>
        </SettlementSummaryList>
    </ResponseBody>
    <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": {
                "SettlementSummary": {
                    "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"
                }
            }
        }
    }
}

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: October 15, 2018