Get Batch Inventory

Retrieve current inventory for up to 100 of your Newegg.com items in a single request. The response includes each item's available quantity by warehouse and fulfillment option: shipped by seller or shipped by Newegg.

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 requests per hour (per seller, Newegg.com)

Request Body

Attribute Required? Format Description

Type

Integer

Attribute	Required?	Format	Description
Type	No	Integer	Specifies the item identifier type. Default: `1`. 0: Newegg item number 1: Seller part number 2: UPC
Values	Yes	String	Item identifiers to query. Provide 1 to 100 values. Each value must be nonblank and no longer than 40 characters. Leading and trailing spaces are removed. In XML, each value is a `Key` element.
WarehouseList	No	String	Filters inventory by warehouse location. Each value must contain 3 characters, such as `USA`, when leading and trailing spaces are excluded from the length check. However, matching uses the value exactly as submitted, without trimming spaces. For example, `USA` passes validation but matches no records. Matching is case-insensitive, but submitting the same value with different capitalization (for example, `USA` and `usa`) returns duplicate entries. If omitted, inventory for all warehouse locations is returned. In XML, each value is a `WarehouseLocation` element.

Specifies the item identifier type. Default: 1.

0: Newegg item number

1: Seller part number

2: UPC

Values

Yes

String

Item identifiers to query. Provide 1 to 100 values. Each value must be nonblank and no longer than 40 characters. Leading and trailing spaces are removed.

In XML, each value is a Key element.

WarehouseList

String

Filters inventory by warehouse location. Each value must contain 3 characters, such as USA, when leading and trailing spaces are excluded from the length check. However, matching uses the value exactly as submitted, without trimming spaces. For example, USA passes validation but matches no records. Matching is case-insensitive, but submitting the same value with different capitalization (for example, USA and usa) returns duplicate entries. If omitted, inventory for all warehouse locations is returned.

In XML, each value is a WarehouseLocation element.

XML root element: ContentQueryCriteria

Example: XML, Request

<ContentQueryCriteria>
  <Type>1</Type>
  <Values>
    <Key>ABCD-001</Key>
    <Key>ABCD-002</Key>
  </Values>
  <WarehouseList>
    <WarehouseLocation>USA</WarehouseLocation>
  </WarehouseList>
</ContentQueryCriteria>

Example: Json, Request

{
  "Type": 1,
  "Values": [
    "ABCD-001",
    "ABCD-002"
  ],
  "WarehouseList": [
    "USA"
  ]
}

Response Body

Attribute	Format	Description
IsSuccess	Boolean	Whether the request was processed successfully.
OperationType	String	Fixed value: `GetInventoryList`
SellerID	String	Your seller ID.
ResponseDate	DateTime	The server time when the response was generated, in ISO 8601 format.
ResponseBody	Object	Inventory query results.
ResponseBody.ItemList	Array	One entry per item found. In XML, each entry is an `InventoryResult` element.
ItemNumber	String	Newegg item number.
SellerPartNumber	String	Seller part number.
Condition	Integer	Item condition: 1: New 2: Refurbished 3: Used - Like New 4: Used - Very Good 5: Used - Good 6: Used - Acceptable Omitted in Json (or `xsi:nil="true"` in XML) if the condition is unknown.
InventoryAllocation	Array	Inventory entries for the item. In XML, each entry is an `Inventory` element. The array is empty if no inventory matches the request, such as when `WarehouseList` filters out all inventory.
WarehouseLocation	String	Warehouse country code. Shipped by seller: one entry per seller warehouse. Multiple warehouses in the same country produce multiple entries with the same `WarehouseLocation`. Shipped by Newegg: one combined entry with the fixed value `USA`.
FulfillmentOption	String	0: Shipped by seller 1: Shipped by Newegg
AvailableQuantity	Integer	Available quantity. For items shipped by Newegg, this is the sum of the quantities across all Newegg warehouses in `WarehouseAllocation`.
WarehouseAllocation	Array	Quantity in each Newegg warehouse. Returned only for items shipped by Newegg; omitted for items shipped by seller. In XML, each entry is a `Warehouse` element.
WarehouseCode	String	The warehouse code Currently available Newegg warehouse code in united states: 06: Tennesse Bulk Warehouse 07: California Small Warehouse 08: California Bulk Item Warehouse 10: New Jersy Bulk Warehouse 14: New Jersy Small Warehouse Currently available Newegg Warehouse code in Canada 36: Canada Warehouse
Quantity	Integer	Available quantity at this warehouse.
TotalCount	Integer	The number of entries in `ItemList`.

Notes:

Values that do not match any of your items are omitted from the response. If no values match, the request fails with an error response (see Request Failure Errors).
In Json, fields with no value are omitted. In XML, numeric fields with no value are returned with xsi:nil="true".

Example: XML, Response

<?xml version="1.0" encoding="utf-16"?>
<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>ABCD</SellerID>
  <ResponseDate>2024-01-01T10:00:00.0000000-08:00</ResponseDate>
  <ResponseBody>
    <ItemList>
      <InventoryResult>
        <ItemNumber>9SIABCD0000001</ItemNumber>
        <SellerPartNumber>ABCD-001</SellerPartNumber>
        <Condition>1</Condition>
        <InventoryAllocation>
          <Inventory>
            <WarehouseLocation>USA</WarehouseLocation>
            <FulfillmentOption>0</FulfillmentOption>
            <AvailableQuantity>100</AvailableQuantity>
          </Inventory>
          <Inventory>
            <WarehouseLocation>USA</WarehouseLocation>
            <FulfillmentOption>1</FulfillmentOption>
            <AvailableQuantity>30</AvailableQuantity>
            <WarehouseAllocation>
              <Warehouse>
                <WarehouseCode>01</WarehouseCode>
                <Quantity>20</Quantity>
              </Warehouse>
              <Warehouse>
                <WarehouseCode>02</WarehouseCode>
                <Quantity>10</Quantity>
              </Warehouse>
            </WarehouseAllocation>
          </Inventory>
        </InventoryAllocation>
      </InventoryResult>
      <InventoryResult>
        <ItemNumber>9SIABCD0000002</ItemNumber>
        <SellerPartNumber>ABCD-002</SellerPartNumber>
        <Condition>1</Condition>
        <InventoryAllocation />
      </InventoryResult>
    </ItemList>
    <TotalCount>2</TotalCount>
  </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
  "ResponseBody": {
    "ItemList": [
      {
        "ItemNumber": "9SIABCD0000001",
        "SellerPartNumber": "ABCD-001",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 100
          },
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "1",
            "AvailableQuantity": 30,
            "WarehouseAllocation": [
              {
                "WarehouseCode": "01",
                "Quantity": 20
              },
              {
                "WarehouseCode": "02",
                "Quantity": 10
              }
            ]
          }
        ]
      },
      {
        "ItemNumber": "9SIABCD0000002",
        "SellerPartNumber": "ABCD-002",
        "Condition": 1,
        "InventoryAllocation": []
      }
    ],
    "TotalCount": 2
  },
  "IsSuccess": true,
  "OperationType": "GetInventoryList",
  "SellerID": "ABCD",
  "ResponseDate": "2024-01-01T10:00:00.0000000-08:00"
}

Request Failure Errors

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

Each error response entry includes a Code and a Message.

Invalid request body. The request fails with an error response containing one of the following Message values.

Validation checks for Type and Values run separately from checks for WarehouseList. Each message contains the failed checks from one group only. If multiple checks within a group fail, their messages are combined into a single message.

The element 'ContentQueryCriteria' has incomplete content.List of possible elements expected: 'Values'.
The 'Type' element is invalid - The value '{Type}' is invalid according to its datatype 'Int'.- The Enumeration constraint failed.
The 'Values' element is invalid - The Max Length is 100.
The 'Values' element is invalid - The value '' is invalid according to its datatype 'string' - The actual length is less than the MinLength value.
The 'Values' element is invalid - The value '{value}' is invalid according to its datatype 'string' - The actual length is greater than the MaxLength value.
The 'WarehouseList' element is invalid - The value '{value}' is invalid according to its datatype 'string' - The actual length is less than the MinLength value.
The 'WarehouseList' element is invalid - The value '{value}' is invalid according to its datatype 'string' - The actual length is greater than the MaxLength value.

No matching item. If no entries in Values match your items, the request fails with HTTP status 400 and the following error response:

Error Code	Description
CT026	The item cannot be found, please check your inputted parameters.

[
  {
    "Code": "CT026",
    "Message": "The item cannot be found, please check your inputted parameters."
  }
]

<Errors>
  <Error>
    <Code>CT026</Code>
    <Message>The item cannot be found, please check your inputted parameters.</Message>
  </Error>
</Errors>

Unexpected server error. The API returns HTTP status 500 with Code set to InternalError.

Last updated: April 20, 2022