Get Batch Price (B2B and CAN) – Newegg Developer Portal

Get Batch Price

Batch track the price-related information of items in the default warehouse.

Resource URL

This operation is designed for Neweggbusiness.com and Newegg.ca:

Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/contentmgmt/item/Pricelist?sellerid={SellerID}
Newegg.ca: https://api.newegg.com/marketplace/can/contentmgmt/item/Pricelist?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

Integer

Available values:

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

Note: If left blank, default value will be Seller Part#.

Value

Yes

String Array

Multiple strings of the specified value.

Schema: GetItemPriceListRequest.xsd

Example: XML, Request

POST https://api.newegg.com/marketplace/b2b/contentmgmt/item/pricelist?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>
</ContentQueryCriteria>

Example: Json, Request

POST https://api.newegg.com/marketplace/b2b/contentmgmt/item/pricelist?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"]
}

Response Body

Attribute	Format	Description
SellerID	String	Your seller ID
TotalCount	Integer	Item Price Count
SellerPartNumber	String	Seller Part#, A seller-defined unique identifier for an item.
ItemNumber	String	Newegg Item# initial with 9SI
CountryCode	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
Currency	String	The currency is to identify the Selling Price, 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: International Country Guide
Active	Integer	Available values: 0: Inactive 1: Active
MAP	Decimal	Minimum Advertised Price If the Selling Price is below the defined MAP, the website will ask the customer to add the item to the shopping cart to see the item’s price.
CheckoutMAP	Integer	Available values: 0: False 1: True Note: If Checkout MAP is marked as True, then the website will ask customer to add the item to the shopping cart AND go to the 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 the item to the cart and go to checkout to see the item’s price. If MAP is greater than 0.00 and CheckoutMAP is left blank, by default CheckoutMAP will equal False.
SellingPrice	Decimal	The actual selling price
EnableFreeShipping	Integer	Available values: 0: Default 1: Free Shipping
OnPromotion	Integer	Available values: 0: No active Promotion 1: Active promotion with Price Lock 2: Active Promotion with Promotion Code 3: Active promotion with Auto Add To Cart 4: Active Promotion with Combo 5: Active Promotion with General Promotion
ShipByNewegg	Integer	Available values: 0: ShipBySeller 1: ShipByNewegg
LimitQuantity	Integer	Limit quantity represents the maximum quantity this item can be purchased by a customer within a 48-hour time period. The maximum value is 500. Note if the value is: 0: The system will delete the existing value null: No update

Schema: GetItemPriceListResponse.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>GetPriceList</OperationType>
  <SellerID>A006</SellerID>
  <ResponseDate>2022-04-20T23:46:41.7786361-07:00</ResponseDate>
  <ResponseBody>
    <ItemList>
      <PriceResult>
        <ItemNumber>9SIA00603V5190</ItemNumber>
        <SellerPartNumber>A006-TestItem-001</SellerPartNumber>
        <PriceList>
          <Price>
            <CountryCode>USB</CountryCode>
            <Active>1</Active>
            <MAP>12.00</MAP>
            <CheckoutMAP>1</CheckoutMAP>
            <SellingPrice>22.00</SellingPrice>
            <EnableFreeShipping>0</EnableFreeShipping>
            <OnPromotion>0</OnPromotion>
            <ShipByNewegg>0</ShipByNewegg>
            <LimitQuantity xsi:nil="true"/>
          </Price>
        </PriceList>
      </PriceResult>
      <PriceResult>
        <ItemNumber>9SIA00603V5191</ItemNumber>
        <SellerPartNumber>A006-TestItem-002</SellerPartNumber>
        <PriceList>
          <Price>
            <CountryCode>USB</CountryCode>
            <Active>1</Active>
            <MAP>12.0</MAP>
            <CheckoutMAP>0</CheckoutMAP>
            <SellingPrice>21.00</SellingPrice>
            <EnableFreeShipping>0</EnableFreeShipping>
            <OnPromotion>0</OnPromotion>
            <ShipByNewegg>1</ShipByNewegg>
            <LimitQuantity>20</LimitQuantity>
          </Price>
        </PriceList>
      </PriceResult>
      <PriceResult>
        <ItemNumber>9SIA00603V5192</ItemNumber>
        <SellerPartNumber>A006-TestItem-003</SellerPartNumber>
        <PriceList>
          <Price>
            <CountryCode>USB</CountryCode>
            <Active>1</Active>
            <MAP>12.00</MAP>
            <CheckoutMAP>1</CheckoutMAP>
            <SellingPrice>20.00</SellingPrice>
            <EnableFreeShipping>0</EnableFreeShipping>
            <OnPromotion>0</OnPromotion>
            <ShipByNewegg>0</ShipByNewegg>
            <LimitQuantity xsi:nil="true"/>
          </Price>
        </PriceList>
      </PriceResult>
    </ItemList>
    <TotalCount>3</TotalCount>
  </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
  "ResponseBody": {
    "ItemList": [
      {
        "ItemNumber": "9SIA00603V5190",
        "SellerPartNumber": "A006-TestItem-001",
        "PriceList": [
          {
            "CountryCode": "USB",
            "Active": 1,
            "MAP": 12,
            "CheckoutMAP": 1,
            "SellingPrice": 22,
            "EnableFreeShipping": 0,
            "OnPromotion": "0",
            "ShipByNewegg": 0
          }
        ]
      },
      {
        "ItemNumber": "9SIA00603V5191",
        "SellerPartNumber": "A006-TestItem-002",
        "PriceList": [
          {
            "CountryCode": "USB",
            "Active": 1,
            "MAP": 12,
            "CheckoutMAP": 0,
            "SellingPrice": 21,
            "EnableFreeShipping": 0,
            "OnPromotion": "0",
            "ShipByNewegg": 1,
            "LimitQuantity": 20
          }
        ]
      },
      {
        "ItemNumber": "9SIA00603V5192",
        "SellerPartNumber": "A006-TestItem-003",
        "PriceList": [
          {
            "CountryCode": "USB",
            "Active": 1,
            "MAP": 12,
            "CheckoutMAP": 1,
            "SellingPrice": 20,
            "EnableFreeShipping": 0,
            "OnPromotion": "0",
            "ShipByNewegg": 0
          }
        ]
      }
    ],
    "TotalCount": 3
  },
  "IsSuccess": true,
  "OperationType": "GetPriceList",
  "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	Can’t find this item in the system, please create it first

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