Submit Order List Report

Request available orders from seller’s account.

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: OrderListReportRequest
RequestType Yes String Fixed value: ORDER_LIST_REPORT
KeywordsType Yes Integer Available values:

0:All (Default)
1: OrderNumber
2: InvoiceNumber
3: CustomerName
4: SellerPartNumber
5: NeweggItemNumber
6: CustomerPhoneNumber
7: TitleDescription
8: Manufacturer
9: SellerOrderNumber

Note: “9: SellerOrderNumber” is designed for sellers using SBN (Shipped by Newegg) for multichannel orders fulfillment.

KeywordsValue No String The keywords value of the specified KeywordsType

If the Keywordstype is 0, system will ignore this field

Status Yes Integer Available values:

0: Unshipped
1: Partially Shipped
2: Shipped
3: Invoiced
4: Voided

Type No Integer Available values:

0: All (Default)
1: SBN
2: SBS
3: Multi-Channel

OrderDateFrom No String Search by Order Date Range (Pacific Standard Time)

Please refer to the Acceptable Date Format

OrderDateTo No String Search by Order Date Range (Pacific Standard Time)

Please refer to the Acceptable Date Format

VoidSoon No Integer Order will be auto void after 24 or 48 hours

Available values:
24
48

OrderDownloaded No String Available values:

false: Include downloaded orders (default)
true: Don’t include downloaded orders

CountryCode No String The country for your orders. Only the ISO standard 3-digit codes are accepted.
To review the complete list of available values, please download the following:

Not applicable for Neweggbusiness.com and Newegg.ca

PremierOrder No String Available values:

0: All (Default)
1: Premier Order Only
2: No Premier Order

Not applicable for Neweggbusiness.com and Newegg.ca

Schema: OrderListRequest.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>OrderListReportRequest</OperationType>
    <RequestBody>
        <OrderReportCriteria>
            <RequestType>ORDER_LIST_REPORT</RequestType>
            <KeywordsType>0</KeywordsType>
            <KeywordsValue/>
            <Status>4</Status>
            <Type>0</Type>
            <OrderDateFrom>2011-12-07</OrderDateFrom>
            <OrderDateTo>2012-12-30</OrderDateTo>
            <OrderDownloaded>false</OrderDownloaded>
            <CountryCode>USA</CountryCode>
            <PremierOrder>1</PremierOrder>
        </OrderReportCriteria>
    </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": "OrderListReportRequest",
    "RequestBody": {
        "OrderReportCriteria": {
            "RequestType": "ORDER_LIST_REPORT",
            "KeywordsType": "0",
            "Status": "4",
            "Type": "0",
            "OrderDateFrom": "2011-12-07",
            "OrderDateTo": "2012-12-30",
            "OrderDownloaded": "false",
            "CountryCode": "USA",
            "PremierOrder": "1"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: OrderListReportResponse
SellerID String Your seller ID
RequestId String Newegg’s assigned ID for submitted request
RequestType String Fixed value: ORDER_LIST_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>OrderListReportResponse</OperationType>
    <SellerID>a001</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>270Z8Y3SYIGQV</RequestId>
                <RequestType>ORDER_LIST_REPORT</RequestType>
                <RequestDate>07/12/2014 11:02:35</RequestDate>
                <RequestStatus>SUBMITTED</RequestStatus>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "OperationType": "OrderListReportResponse",
    "SellerID": "a001",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestId": "270Z8Y3SYIGQV",
                "RequestType": "ORDER_LIST_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