Get Report Status

Get the status of specified report request.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/reportmgmt/report/status?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/reportmgmt/report/status?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 value: GetReportStatusRequest
RequestID No String A list of Newegg’s assigned request ID, for each submitted request.

If provided, RequestType, MaxCount,  RequestStatus, RequestDateFrom, RequestDateTo will be ignored.
RequestType Yes String A list of feed task type, available values:

ALL (Default)
ORDER_LIST_REPORT
SETTLEMENT_SUMMARY_REPORT
SETTLEMENT_TRASACTION_ REPORT
DAILY_INVENTORY_ REPORT
RMA_LIST_REPORT
ITEM_LOOKUP
INTERNATIONAL_INVENTORY_REPORT
INTERNATIONAL_PRICE_REPORT
CAPROP65 _REPORT
ITEM_BASIC_INFO_REPORT
MaxCount No Integer The maximum return records. Default and maximum is 100. If you specified over than 100, the system still return 100 records.
RequestStatus No String The status of the feed submission, available values:

SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
ALL
RequestDateFrom No String Search by date range (Pacific Standard Time)

Please refer to the Acceptable Date Format
RequestDateTo No String Search by date range (Pacific Standard Time)

Please refer to the Acceptable Date Format

Schema: GetReportStatusRequest.xsd

Example: XML, Request

PUT https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>GetReportStatusRequest</OperationType>
    <RequestBody>
        <GetRequestStatus>
            <RequestIDList>
                <RequestID>2PQBYWH4V68ZP</RequestID>
            </RequestIDList>
            <MaxCount>10</MaxCount>
        </GetRequestStatus>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

PUT https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "GetReportStatusRequest",
    "RequestBody": {
        "GetRequestStatus": {
            "RequestIDList": {
                "RequestID": "2PQBYWH4V68ZP"
            },
            "MaxCount": "10"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful
OperationType String Fixed value: GetReportStatusResponse
RequestId String Newegg’s assigned ID for submitted request
RequestType String Available values:

ORDER_LIST_REPORT
SETTLEMENT_SUMMARY_REPORT
SETTLEMENT_TRASACTION_REPORT
DAILY_INVENTORY_ REPORT
RMA_LIST_REPORT
ITEM_LOOKUP
INTERNATIONAL_INVENTORY_REPORT
INTERNATIONAL_PRICE_REPORT
PREMIER_ITEM_REPORT
CAPROP65 _REPORT
ITEM_BASIC_INFO_REPORT
RequestDate String The date when the feed was submitted (Pacific Standard Time)
RequestSatus String Status of the submission:

SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
TotalCount Integer Total number of records
Memo String Additional information

Schema: GetReportStatusResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetReportStatusResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>2PQBYWH4V68ZP</RequestId>
                <RequestType>ORDER_LIST_REPORT</RequestType>
                <RequestDate>2/21/2012 14:38:17</RequestDate>
                <RequestStatus>FINISHED</RequestStatus>
                <TotalCount>4</TotalCount>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "OperationType": "GetReportStatusResponse",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestDate": "2/21/2012 14:38:17",
                "RequestId": "2PQBYWH4V68ZP",
                "RequestStatus": "IN_PROGRESS",
                "RequestType": "ORDER_LIST_REPORT",
                "TotalCount": 4
            }
        ]
    },
    "SellerID": "A006"
}

Request Failure Errors

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

Error Code Description
RP004 Date From is required.
RP005 Date To is required.
RP006 Invalid Date From.
RP007 Invalid Date To.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>RP004</Code>
        <Message>Date From is required</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "RP004",
        "Message": "Date From is required"
    }
]

Last updated: October 28, 2021