Get Item Inventory

Tracking the inventory quantity of items in all registered warehouses around the world, including the United States.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?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 1000 per min per client

Request Body

Attribute Required? Format Description
Condition No Integer Available values:

1: New
2: Refurbished
3: Used – Like New
4: Used – Very Good
5: Used – Good
6: Used – Acceptable

Note:

  • Only applies if type = [2-UPC code]. If type does not = [2-UPC code], then this column will be disregarded.
  • If left blank, default value will be New.
Type Yes Integer Available values:

0: NE Item#
1: Seller Part#
2: UPC Code

Value Yes String A string according to the specified value of Type.
WarehouseLocation No String The ISO standard 3-digit codes of the country where your warehouse is located. Please download the following to review details:

If left blank, default value will be All.

Schema: GetInventoryRequest.xsd

Example: XML, Request

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

<ContentQueryCriteria>
    <Type>1</Type>
    <Value>A006testitem201201021459</Value>
    <WarehouseList>
        <WarehouseLocation>USA</WarehouseLocation>
        <WarehouseLocation>AUS</WarehouseLocation>
    </WarehouseList>
</ContentQueryCriteria>

Example: Json, Request

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

{
    "Type": "1",
    "Value": "A006testitem201201021459",
    "WarehouseList": {
        "WarehouseLocation": [
            "USA",
            "AUS"
        ]
    }
}

Response Body

Attribute Format Description
SellerID String Your seller ID
ItemNumber String Newegg Item#
SellerPartNumber String Seller Part#
WarehouseLocation String The ISO standard 3-digit codes of the country where your warehouse is located. Please download the following to review details:

FulfillmentOption String Available values:

0: ShipBySeller
1: ShipByNewegg

AvailableQuantity Integer Current available inventory in this warehouse.
WarehouseCode String Indicates the inventory is currently stored in which Newegg warehouse.

Available values:

06: Tennessee Bulk Warehouse
07: California Small Warehouse
08: California Bulk Item Warehouse
10: New Jersey Bulk Warehouse
12: Tennessee Small Warehouse
14: New Jersey Small Warehouse

Note: This information will be returned only when the inventory is currently stored in Newegg’s warehouse.

Quantity Integer Current available inventory in this Newegg warehouse.

Note: This information will be returned only when the inventory is currently stored in Newegg’s warehouse.

Schema: GetInventoryResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<InventoryResult>
    <SellerID>A006</SellerID>
    <ItemNumber>9SIA0060884598</ItemNumber>
    <SellerPartNumber>A006testitem201201021459</SellerPartNumber>
    <InventoryAllocation>
        <Inventory>
            <WarehouseLocation>USA</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>107</AvailableQuantity>
        </Inventory>
        <Inventory>
            <WarehouseLocation>USA</WarehouseLocation>
            <FulfillmentOption>1</FulfillmentOption>
            <AvailableQuantity>40</AvailableQuantity>
            <WarehouseAllocation>
                <Warehouse>
                    <WarehouseCode>07</WarehouseCode>
                    <Quantity>3</Quantity>
                </Warehouse>
                <Warehouse>
                    <WarehouseCode>12</WarehouseCode>
                    <Quantity>37</Quantity>
                </Warehouse>
            </WarehouseAllocation>
        </Inventory>
        <Inventory>
            <WarehouseLocation>AUS</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>0</AvailableQuantity>
        </Inventory>
    </InventoryAllocation>
</InventoryResult>

Example: Json, Response

{
    "SellerID": "A006",
    "ItemNumber": "9SIA0060884598",
    "SellerPartNumber": "A006testitem201201021459",
    "InventoryAllocation": {
        "Inventory": [
            {
                "WarehouseLocation": "USA",
                "FulfillmentOption": "0",
                "AvailableQuantity": "107"
            },
            {
                "WarehouseLocation": "USA",
                "FulfillmentOption": "1",
                "AvailableQuantity": "40",
                "WarehouseAllocation": {
                    "Warehouse": [
                        {
                            "WarehouseCode": "07",
                            "Quantity": "3"
                        },
                        {
                            "WarehouseCode": "12",
                            "Quantity": "37"
                        }
                    ]
                }
            },
            {
                "WarehouseLocation": "AUS",
                "FulfillmentOption": "0",
                "AvailableQuantity": "0"
            }
        ]
    }
}

Request Failure Errors

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

Error Code Description
CT001 Invalid ItemNumber
CT002 Invalid SellerPartNumber
CT003 Invalid UPCCode
CT005 Invalid Action Type. We only support: 0 – NE Item#, 1 — Seller Parts#, 2 — UPC Code
CT010 Cannot find item with specified item condition.
CT026 No data found

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>CT002</Code>
        <Message>Invalid SellerPartNumber</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "CT002",
    "Message": "Invalid SellerPartNumber"
}

Last updated: October 15, 2018