Get Settlement Transaction Report

Get detailed breakdown of transactions during a given settlement period.

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 30 requests per min per client

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: SettlementTransactionReportRequest
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>SettlementTransactionReportRequest</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": "SettlementTransactionReportRequest",
    "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: GetSettlementTransactionInfoResponse
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
TransactionDate String Date of transaction
TransactionType String Type of transaction
OrderID Integer Order number
InvoiceID Integer Invoice ID
SellerPartNumber String The item’s seller part number
NeweggItemNumber String Newegg assigned number to item
ItemDescription String The item’s title
ItemCondition String Item condition:

New
Refurbished
Used – Like New
Used – Very Good
Used – Good
Used – Acceptable

Amount String Amount of order

  • 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 String Shipping charge of order

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
CommissionFee String Commission fee of order

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
SettlementID String Settlement ID
Memo String Other information
ResponseDate String Response date (Pacific Standard Time)

Schema: SettlementTransactionResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <SellerID>A09D</SellerID>
    <OperationType>GetSettlementTransactionInfoResponse</OperationType>
    <ResponseBody>
        <PageInfo>
            <TotalCount>21</TotalCount>
            <TotalPageCount>21</TotalPageCount>
            <PageSize>10</PageSize>
            <PageIndex>1</PageIndex>
        </PageInfo>
        <RequestID>2PQDKCAQFHL3M</RequestID>
        <RequestDate>2/23/2012 11:39:00</RequestDate>
        <SettlementTransactionInfoList>
            <SettlementTransactionInfo>
                <TransactionDate>8/9/2011 12:00:00</TransactionDate>
                <TransactionType>Order</TransactionType>
                <OrderID>87123017</OrderID>
                <InvoiceID>75994476</InvoiceID>
                <SellerPartNumber>A09D77897686</SellerPartNumber>
                <NeweggItemNumber>9SIA00X0002HJ5</NeweggItemNumber>
                <ItemDescription>dfdfgsdfg</ItemDescription>
                <ItemCondition>New</ItemCondition>
                <Amount>10.00</Amount>
                <Shipping>2.00</Shipping>
                <CommissionFee>-0.75</CommissionFee>
                <SettlementID />
            </SettlementTransactionInfo>
        </SettlementTransactionInfoList>
    </ResponseBody>
    <Memo />
</NeweggAPIResponse>

Example: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "SellerID": "A09D",
        "OperationType": "GetSettlementTransactionInfoResponse",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "21",
                "TotalPageCount": "21",
                "PageSize": "10",
                "PageIndex": "1"
            },
            "RequestID": "2PQDKCAQFHL3M",
            "RequestDate": "2/23/2012 11:39:00",
            "SettlementTransactionInfoList": {
                "SettlementTransactionInfo": {
                    "TransactionDate": "8/9/2011 12:00:00",
                    "TransactionType": "Order",
                    "OrderID": "87123017 ",
                    "InvoiceID": "75994476 ",
                    "SellerPartNumber": "A09D77897686",
                    "NeweggItemNumber": "9SIA00X0002HJ5",
                    "ItemDescription": "dfdfgsdfg",
                    "ItemCondition": "New",
                    "Amount": "10.00",
                    "Shipping": "2.00",
                    "CommissionFee": "-0.75",
                    "SettlementID": null
                }
            }
        },
        "Memo": null
    }
}

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