Submit Settlement Summary Report

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

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

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?
POST	Required	XML, Json	XML, Json	100 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 value: SettlementSummaryReportRequest
RequestType	Yes	String	Fixed value: SETTLEMENT_SUMMARY_REPORT
DateFrom	Yes	String	Search by Date Range (Pacific Standard Time) Please refer to the Acceptable Date Format
DateTo	Yes	String	Search by Date Range (Pacific Standard Time) Please refer to the Acceptable Date Format

Schema: SettlementSummaryRequest.xsd

Example: 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>SettlementSummaryReportRequest</OperationType>
    <RequestBody>
        <SettlementSummaryReportCriteria>
            <RequestType>SETTLEMENT_SUMMARY_REPORT</RequestType>
            <DateFrom>2011-12-01</DateFrom>
            <DateTo>2011-12-30</DateTo>
        </SettlementSummaryReportCriteria>
    </RequestBody>
</NeweggAPIRequest>

Example: 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": "SettlementSummaryReportRequest",
    "RequestBody": {
        "SettlementSummaryReportCriteria": {
            "RequestType": "SETTLEMENT_SUMMARY_REPORT",
            "DateFrom": "2011-12-01",
            "DateTo": "2011-12-30"
        }
    }
}

Response Body

Attribute	Format	Description
IsSuccess	String	Get feed status operation: True: Successful False: Not successful
OperationType	String	Fixed value: SettlementSummaryReportResponse
SellerID	String	Your seller ID
RequestId	String	Newegg’s assigned ID for submitted request
RequestType	String	Fixed value: SETTLEMENT_SUMMARY_REPORT
RequestDate	String	The date when the feed was submitted (Pacific Standard Time)
RequestSatus	String	Status of the submission: SUBMITTED (Default)
Memo	String	Additional information

Schema: SubmitReportResponse.xsd

Example: XML, Response

<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>SettlementSummaryReportResponse</OperationType>
    <SellerID>a001</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>270Z8Y3SYIGQV</RequestId>
                <RequestType>SETTLEMENT_SUMMARY_REPORT</RequestType>
                <RequestDate>07/12/2014 11:02:35</RequestDate>
                <RequestStatus>SUBMITTED</RequestStatus>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "OperationType": "SettlementSummaryReportResponse",
    "SellerID": "a001",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestId": "270Z8Y3SYIGQV",
                "RequestType": "SETTLEMENT_SUMMARY_REPORT",
                "RequestDate": "07/12/2014 11:34:57",
                "RequestStatus": "SUBMITTED"
            }
        ]
    }
}

Request Failure Errors

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

Error Code	Description
RP010	Invalid Order Number.
RP018	Invalid Settlement Date.
RP019	The requestID cannot be null or empty.
RP020	We are unable to process your request because one of the following search criteria is required: SettlementID, SettlementDate, or SettlementDateFrom and SettlementDateTo.
RP021	Maximum item lookup cannot exceed 1000 for each request.
RP022	Daily Inventory Report does not support multiple warehouse locations. For multiple warehouse locations, please use International Program – Daily Inventory Report.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>RP018</Code>
        <Message>Invalid Settlement Date</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "RP018",
        "Message": "Invalid Settlement Date"
    }
]

Last updated: October 15, 2018