Get Batch Inventory

Batch track the inventory quantities of specified items in all registered warehouses around the world, including the United States.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/contentmgmt/item/international/inventorylist?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	10,000 request per hour

Request Body

Attribute	Required?	Format	Description
Type	No	Integer	Available values: 0: NE Item# 1: Seller Part# 2: UPC Code Note: If left blank, the default value will be Seller Part#
Values	Yes	String Array	Multiple strings of the specified value, max length 100.
WarehouseList	No	String Array	The ISO standard 3-digit codes of the country where your warehouse is located. Please download the following to review the details: International Country Guide Note: If left blank, the default value will be All.

Schema: GetInventoryListRequest.xsd

Example: XML, Request

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

<ContentQueryCriteria>
  <Type>1</Type>
  <Values>
    <Key>A006-TestItem-001</Key>
    <Key>A006-TestItem-002</Key>
    <Key>A006-TestItem-003</Key>
  </Values>
  <WarehouseList>
    <WarehouseLocation>USA</WarehouseLocation>
    <WarehouseLocation>AUS</WarehouseLocation>
  </WarehouseList>
</ContentQueryCriteria>

Example: Json, Request

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

{
  "Type": "1",
  "Values": ["A006-TestItem-001","A006-TestItem-002","A006-TestItem-003"],
  "WarehouseList": ["USA","AUS"]
}

Response Body

Attribute	Format	Description
SellerID	String	Your seller ID
TotalCount	Integer	Result Inventory Count
SellerPartNumber	String	Seller Part#, A seller-defined unique identifier for an item.
ItemNumber	String	Newegg Item# initial with 9SI
WarehouseLocation	String	The ISO standard 3-digit codes of the country where your warehouse is located. Please download the following to review the details: International Country Guide
FulfillmentOption	String	Available values: 0: ShipBySeller 1: ShipByNewegg
Condition	Integer	Item Condition 1: New 2: Refurbished 3: Used – Like New 4: Used – Very Good 5: Used – Good 6: Used – Acceptable
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. Default value: 0

Schema: GetInventoryListResponse.xsd

Example: XML, Response

<NeweggAPIResponse
  xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
  xmlns:xsd=http://www.w3.org/2001/XMLSchema>
  <IsSuccess>true</IsSuccess>
  <OperationType>GetInventoryList</OperationType>
  <SellerID>A006</SellerID>
  <ResponseDate>2022-04-20T23:46:41.7786361-07:00</ResponseDate>
  <ResponseBody>
    <ItemList>
      <InventoryResult>
        <ItemNumber>9SIA00603V5190</ItemNumber>
        <SellerPartNumber>A006-TestItem-001</SellerPartNumber>
        <Condition>1</Condition>
        <InventoryAllocation>
          <Inventory>
            <WarehouseLocation>USA</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>10</AvailableQuantity>
          </Inventory>
          <Inventory>
            <WarehouseLocation>AUS</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>0</AvailableQuantity>
          </Inventory>
        </InventoryAllocation>
      </InventoryResult>
      <InventoryResult>
        <ItemNumber>9SIA00603V5191</ItemNumber>
        <SellerPartNumber>A006-TestItem-002</SellerPartNumber>
        <Condition>1</Condition>
        <InventoryAllocation>
          <Inventory>
            <WarehouseLocation>USA</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>5</AvailableQuantity>
          </Inventory>
          <Inventory>
            <WarehouseLocation>AUS</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>10</AvailableQuantity>
          </Inventory>
        </InventoryAllocation>
      </InventoryResult>
      <InventoryResult>
        <ItemNumber>9SIA00603V5192</ItemNumber>
        <SellerPartNumber>A006-TestItem-003</SellerPartNumber>
        <Condition>1</Condition>
        <InventoryAllocation>
          <Inventory>
            <WarehouseLocation>AUS</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>15</AvailableQuantity>
          </Inventory>
          <Inventory>
            <WarehouseLocation>KOR</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>20</AvailableQuantity>
          </Inventory>
        </InventoryAllocation>
      </InventoryResult>
    </ItemList>
    <TotalCount>3</TotalCount>
  </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
  "ResponseBody": {
    "ItemList": [
      {
        "ItemNumber": "9SIA00603V5190",
        "SellerPartNumber": "A006-TestItem-001",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 10
          },
          {
            "WarehouseLocation": "AUS",
            "FulfillmentOption": "0",
            "AvailableQuantity": 0
          }
        ]
      },
      {
        "ItemNumber": "9SIA00603V5191",
        "SellerPartNumber": "A006-TestItem-002",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 5
          },
          {
            "WarehouseLocation": "AUS",
            "FulfillmentOption": "0",
            "AvailableQuantity": 10
          }
        ]
      },
      {
        "ItemNumber": "9SIA00603V5192",
        "SellerPartNumber": "A006-TestItem-003",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 15
          },
          {
            "WarehouseLocation": "AUS",
            "FulfillmentOption": "0",
            "AvailableQuantity": 20
          }
        ]
      }
    ],
    "TotalCount": 3
  },
  "IsSuccess": true,
  "OperationType": "GetInventoryList",
  "SellerID": "A006",
  "ResponseDate": "2022-04-20T23:46:41.7786361-07:00"
}

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: March 09, 2022