Get Daily Inventory Report

Get item’s price information, shipping, and activation status for targeted countries, including United States.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/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: InternationalPriceReportRequest
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>InternationalPriceReportRequest</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": "InternationalPriceReportRequest",
    "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: InternationalPriceReportResponse
RequestID String Newegg’s assigned ID for submitted request
RequestType String INTERNATIONAL_PRICE_REPORT
RequestDate String Your request date time (Pacific Standard Time)
ReportFileURL String The ftp file path, where you can get the report result file, example:

ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/InternationalInventoryReport_2PN75DT8ZICH8.txt

File report property information:

Property Name Definition
Seller Part # The seller part # is the SKU number assigned to this item by seller.
NE Item # The Newegg Item # for this item
CountryCode The target country you will be selling your items to. Only the ISO standard 3-digit codes are accepted.  To review the complete list of available values, please download the following:

Note: Submissions with incorrect values will error-out.

Currency The currency is to identify the Selling Price, MSRP, MAP for the target country you will be selling your items to. Only the ISO standard 3-digit codes are accepted.  The default value will be USD if left blank. To review the complete list of available values, please download the following:

Note: Correct currency code must be submitted based on ship-to destination country code. Submissions with incorrect combinations will error-out.

MSRP The manufacturer’s suggested retail price (MSRP) or list price for the item.
MAP This field allows you to dictate the “minimum advertised price” for the item.

If the Selling Price is below the defined MAP, the website will ask customer to add item to shopping cart to see the item’s selling price.

If you want to remove MAP, input “0.00” in this field.

Checkout MAP If Checkout MAP is marked as True, then the website will ask customer to add item to shopping cart AND go to checkout page to see the item’s price. The MAP value will not be considered.

If this field is marked as true, it doesn’t matter if the selling price is above or below MAP, the customer will always need to add item to cart and go to checkout to see item’s price.

Selling Price The actual price at which the item is offered for sale.
Shipping What kind of Shipping setting for the item, the available two options are default and free
Activation Mark The ActivationMark’s default setting is “True” on all uploaded products because all products must be activated to be visible on Newegg websites.

You may set it to “False” if you wish to hide your product.

 

Memo String Additional information

Schema: InternationalPriceReportResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <sellerID>A006</sellerID>
    <OperationType>InternationalPriceReportResponse</OperationType>
    <ResponseBody>
        <RequestID>2PQC13C7UYDPQ</RequestID>
        <RequestType>INTERNATIONAL_PRICE_REPORT</RequestType>
        <RequestDate>2/21/2012 15:32:57</RequestDate>
        <ReportFileURL>ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalInventoryReport_2PQC13C7UYDPQ.xls</ReportFileURL>
    </ResponseBody>
    <Memo />
</NeweggAPIResponse>

Example: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "sellerID": "A006",
        "OperationType": "InternationalPriceReportResponse",
        "ResponseBody": {
            "RequestID": "2PQC13C7UYDPQ",
            "RequestType": "INTERNATIONAL_PRICE_REPORT",
            "RequestDate": "2/21/2012 15:32:57",
            "ReportFileURL": "ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalInventoryReport_2PQC13C7UYDPQ.xls"
        },
        "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