Get Daily Inventory Report

Get a list of seller’s available inventory quantity in pre-defined warehouse(s).

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 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 values: InternationalInventoryReportRequest
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>InternationalInventoryReportRequest</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": "InternationalInventoryReportRequest",
    "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: InternationalInventoryReportResponse
RequestID String Newegg’s assigned ID for submitted request
RequestType String INTERNATIONAL_INVENTORY_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
Warehouse Location The ISO standard 3-digit codes of the country where your warehouse is located.

Fulfillment Option Seller Only
Inventory The quantity of inventory in the warehouse you specified in the Warehouse Location field.

 

Memo String Additional information

Schema: InternationalInventoryReportResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <sellerID>A006</sellerID>
    <OperationType>InternationalInventoryReportResponse</OperationType>
    <ResponseBody>
        <RequestID>2PQC13C7UYDPQ</RequestID>
        <RequestType>INTERNATIONAL_INVENTORY_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": "InternationalInventoryReportResponse",
        "ResponseBody": {
            "RequestID": "2PQC13C7UYDPQ",
            "RequestType": "INTERNATIONAL_INVENTORY_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