Submit Settlement Transaction Report

Request detailed breakdown of transactions during a given settlement period.

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

Resource Information

Request Body

Schema: SettlementTransactionRequest.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>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>

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": "SettlementTransactionReportRequest",
    "RequestBody": {
        "SettlementTransactionReportCriteria": {
            "RequestType": "SETTLEMENT_TRANSACTION_REPORT",
            "TransactionType": "1",
            "SettlementDateFrom": "2011-02-21",
            "SettlementDateTo": "2012-02-22",
            "SettlementDate": "2/23/2012"
        }
    }
}

Response Body

Schema: SubmitReportResponse.xsd

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

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

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>RP018</Code>
        <Message>Invalid Settlement Date</Message>
    </Error>
</Errors>

Example: Json, Response

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

Last updated: December 1, 2020