Item Basic Information Feed
Batch updating basic information for items without having to specify item subcategory.
This template can only be used to update common item fields such as “Website Short Title”, Product Description”, “Item Images”, etc.
Resource URL
Newegg.com: https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype={RequestType} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype={RequestType} Newegg.ca: https://api.newegg.com/marketplace/can/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype={RequestType}
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 |
RequestType | Yes | Value: ITEM_DATA |
Resource Information
HTTP Method | Authentication? | Request Formats | Response Formats | Rate Limited? | Maximum Size of Request |
POST | Required | XML, Json | XML, Json | 10 request per minute | Max: 3000 records per file and each file cannot exceed 15 MB
Limit: 30,000 records per hour |
Request Body
Attribute | Required? | Format | Description |
DocumentVersion | Yes | Decimal | Fixed value: 3.0 |
MessageType | Yes | String | Fixed value: BatchItemCreation |
Action | Yes | String | Specify the action you would like to perform, types of action:
Create Item: Create a new product that is not currently in your item list. Update Item: Update the information of a product already in your item list (does NOT include updating of pricing fields: Currency, MSRP, MAP, Selling Price, Shipping, Inventory and Activation Mark) Update/Append Image: Upload additional image(s) of the product or overwrite existing image(s). Replace Image: Replace all of your existing images with the image URL’s provided in this file. When this action is selected, the system will only process the Item Images field and Activation Mark; all other information, including Selling Price, will be ignore. IMPORTANT: If no action is selected, by default, system will use Create Item action. |
SellerPartNumber | Yes | String | A seller-defined unique identifier for an item.
An alphanumeric string, max 40 characters including space. Note: Once an item is created, this information cannot be updated. |
WebsiteShortTitle | No | String | The short, easily identifiable item name for an item. It will be used as the main name for your product on all store pages, sales orders and receipts.
Max characters: 200 |
BulletDescription | No | String | Enter concise descriptions of selected product features or functions which will be listed by bullet point below the website short/long title on the product page. Use separator “^^” to separate different points. Max characters: 1000, including spaces and separators. NO HTML is allowed. |
ProductDescription | No | String | The detailed description to be featured on the item page. This description should state the features and functions of the product. Should be the same for all items in product family.
Max characters: 4000 Accepted HTML tags for Product Description fields: <ol>,<ul>, <li>,<br>, <p>, <b>, <i>, <u>, <em>, <strong>, <sub>, <sup> and <img> |
ItemLength | No | Decimal | Item’s shipping length in inches, value only, do not include the metric unit.
Format: Two digits after decimal point. Example: 1.00 |
ItemWidth | No | Decimal | Item’s shipping width in inches, value only, do not include the metric unit.
Format: Two digits after decimal point. Example: 1.00 |
ItemHeight | No | Decimal | Item’s shipping height in inches, value only, do not include the metric unit.
Format: Two digits after decimal point. Example: 1.00 |
ItemWeight | No | Decimal | Item’s shipping weight in pounds, value only, do not include the metric unit.
Format: Two digits after decimal point. Example: 1.00 |
ActivationMark | No | String | Available values:
True: Activate item, the product will be listed for sale at Newegg website. If Null, system will do nothing, no change to current item active/deactivate status. Note:
|
ImageUrl | No | String | Image URL for this item’s product image.
Requirements:
|
IsPrimary | No | Boolean | Specify one default image, if multiple images will be uploaded. |
ConditionDetails | No | String | Information related to the condition, not including New or Refurbished, of the product can be described here to help customer understanding the product.
Note: This information is only applicable for Newegg.com platform. |
ImageUrl | No | String | Image URL for USED item’s product image.
Requirements:
Note: This information is only applicable for Newegg.com platform. |
IsPrimary | No | Boolean | Specify one default image for USED item, if multiple images will be uploaded. |
Prop65 | No | String | Newegg.com and Neweggbusiness.com: This field is not being used.
Once item has been created, to update prop 65 accordingly for regulations in California refer to ITEM_CAPROP65_DATA feed. Newegg.ca platform not required |
Prop65Motherboard | No | String | |
CountryOfOrigin | No | String | Country of Origin is the country of manufacture/ production of your items. Newegg only accept ISO standard three-letter codes for the various countries of the world. For complete list, please refer to the following: |
OverAge18Verification | No | String | Used if the product contains graphics or adult content that is inappropriate for person under 18 years old. If not included/blank/null, the default is “No”
Available values: “Yes” or “No” |
ChokingHazard | No | String | Choking Hazard Warning Requirements for Children’s Toys and Games, you may select up to four of these six warnings.
You should never need to choose more than four warnings, as a warning that a product “contains” a small ball or marble should not apply simultaneously with the corresponding warning that a product “is” a small ball or marble. Please refer to Consumer Product Safety Improvement Act (CPSIA) for more information. If not included/blank/null, the value will be blank. |
ShippingRestriction | No | String | Certain item’s have shipping restrictions where the item cannot be shipped through air.
If the item you are creating has such restriction, set value to “Yes”. Otherwise, set it to “No”. If not included/blank/null, the default is “No”. |
LeadTime | No | Integer | Max 14 business days. Estimated delivery time is calculated based on lead time. You must ship the order within this time for good “On-time Order Fulfillment Rate” performance. Default will be 2 days, if you leave it blank |
ShippingTemplate | No | String | Shipping template name, The Default Shipping Template will be apply to your item if you leave it blank |
Schema: ItemUpdate.xsd
Example: XML, Request
POST https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_DATA Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggEnvelope> <Header> <DocumentVersion>3.0</DocumentVersion> </Header> <MessageType>BatchItemCreation</MessageType> <Message> <Itemfeed> <Item> <Action>Update Item</Action> <BasicInfo> <SellerPartNumber>A006Leon_Test_001</SellerPartNumber> <WebsiteShortTitle>Test for Leon</WebsiteShortTitle> <WebsiteLongTitle/> <BulletDescription>This is first bullet^^This is second bullet</BulletDescription> <ProductDescription>Test for Leon</ProductDescription> <ItemDimension> <ItemLength>2.0</ItemLength> <ItemWidth>2.0</ItemWidth> <ItemHeight>2.0</ItemHeight> </ItemDimension> <ItemWeight>2.0</ItemWeight> <ActivationMark>False</ActivationMark> <ItemImages> <Image> <ImageUrl>http://10.1.24.143:4567/images/20.gif</ImageUrl> <IsPrimary>True</IsPrimary> </Image> <Image> <ImageUrl>http://10.1.24.143:4567/images/21.gif</ImageUrl> </Image> <Image> <ImageUrl>http://10.1.24.143:4567/images/22.gif</ImageUrl> </Image> </ItemImages> <ConditionDetails>Works fine, almost like new, missing original plastics cover</ConditionDetails> <UsedItemImages> <Image> <ImageUrl>http://10.1.24.143:4567/images/Used.gif</ImageUrl> </Image> </UsedItemImages> <Warning> <Prop65>No</Prop65> <Prop65Motherboard>Yes</Prop65Motherboard> <CountryOfOrigin>USA</CountryOfOrigin> <OverAge18Verification>No</OverAge18Verification> <ChokingHazard> <SmallParts>Yes</SmallParts> <SmallBall>Is a small ball</SmallBall> <Balloons>Yes</Balloons> <Marble>Contains a marble</Marble> </ChokingHazard> </Warning> <ShippingRestriction>No</ShippingRestriction> <LeadingTime>1</LeadingTime> <ShippingTemplate>Default</ShippingTemplate> </BasicInfo> </Item> <Item> <Action>Update Item</Action> <BasicInfo> <SellerPartNumber>A006Leon_Test_002</SellerPartNumber> <WebsiteShortTitle>Test for Leon</WebsiteShortTitle> <WebsiteLongTitle/> <BulletDescription>This is first bullet^^This is second bullet</BulletDescription> <ProductDescription>Test for Leon</ProductDescription> <ItemDimension> <ItemLength>2.0</ItemLength> <ItemWidth>2.0</ItemWidth> <ItemHeight>2.0</ItemHeight> </ItemDimension> <ItemWeight>2.0</ItemWeight> <ActivationMark>False</ActivationMark> <ItemImages> <Image> <ImageUrl>http://10.1.24.143:4567/images/20.gif</ImageUrl> <IsPrimary>True</IsPrimary> </Image> </ItemImages> <Warning> <Prop65>No</Prop65> <Prop65Motherboard>Yes</Prop65Motherboard> <OverAge18Verification>No</OverAge18Verification> <ChokingHazard> <SmallParts>Yes</SmallParts> <SmallBall>Is a small ball</SmallBall> <Balloons>Yes</Balloons> <Marble>Contains a marble</Marble> </ChokingHazard> </Warning> <ShippingRestriction>No</ShippingRestriction> <LeadingTime>2</LeadingTime> </BasicInfo> </Item> <Item> <Action>Update Item</Action> <BasicInfo> <SellerPartNumber>A006Leon_Test_003</SellerPartNumber> <WebsiteShortTitle>Test for Leon</WebsiteShortTitle> <WebsiteLongTitle/> <BulletDescription>This is first bullet^^This is second bullet</BulletDescription> <ProductDescription>Test for Leon</ProductDescription> <ItemDimension> <ItemLength>2.0</ItemLength> <ItemWidth>2.0</ItemWidth> <ItemHeight>2.0</ItemHeight> </ItemDimension> <ItemWeight>2.0</ItemWeight> <ActivationMark>False</ActivationMark> <ItemImages> <Image> <ImageUrl>http://10.1.24.143:4567/images/20.gif</ImageUrl> <IsPrimary>True</IsPrimary> </Image> </ItemImages> <Warning> <Prop65>No</Prop65> <Prop65Motherboard>Yes</Prop65Motherboard> <OverAge18Verification>No</OverAge18Verification> <ChokingHazard> <SmallParts>Yes</SmallParts> <SmallBall>Is a small ball</SmallBall> <Balloons>Yes</Balloons> <Marble>Contains a marble</Marble> </ChokingHazard> </Warning> </BasicInfo> </Item> </Itemfeed> </Message> </NeweggEnvelope>
Example: Json, Request
POST https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_DATA Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "NeweggEnvelope": { "Header": { "DocumentVersion": "3.0" }, "MessageType": "BatchItemCreation", "Message": { "Itemfeed": { "Item": [ { "Action": "Update Item", "BasicInfo": { "SellerPartNumber": "A006Leon_Test_001", "WebsiteShortTitle": "Test for Leon", "BulletDescription":"This is first bullet^^This is second bullet", "ProductDescription": "Test for Leon", "ItemDimension": { "ItemLength": "2.0", "ItemWidth": "2.0", "ItemHeight": "2.0" }, "ItemWeight": "2.0", "ActivationMark": "False", "ItemImages": { "Image": [ { "ImageUrl": "http://10.1.24.143:4567/images/20.gif", "IsPrimary": "True"}, { "ImageUrl": "http://10.1.24.143:4567/images/21.gif"}, { "ImageUrl": "http://10.1.24.143:4567/images/22.gif"} ] }, "ConditionDetails": "Works fine, almost like new, missing original plastics cover ", "UsedItemImages": { "Image": { "ImageUrl": "http://10.1.24.143:4567/images/Used.gif" } }, "Warning": { "Prop65": "No", "Prop65Motherboard": "Yes", "CountryOfOrigin": "USA", "OverAge18Verification": "No", "ChokingHazard": { "SmallParts": "Yes", "SmallBall": "Is a small ball", "Balloons": "Yes", "Marble": "Contains a marble" } } } }, { "Action": "Update Item", "BasicInfo": { "SellerPartNumber": "A006Leon_Test_002", "WebsiteShortTitle": "Test for Leon", "BulletDescription":"This is first bullet^^This is second bullet", "ProductDescription": "Test for Leon", "ItemDimension": { "ItemLength": "2.0", "ItemWidth": "2.0", "ItemHeight": "2.0" }, "ItemWeight": "2.0", "ActivationMark": "False", "ItemImages": { "Image": { "ImageUrl": "http://10.1.24.143:4567/images/20.gif", "IsPrimary": "True" } }, "Warning": { "Prop65": "No", "Prop65Motherboard": "Yes", "OverAge18Verification": "No", "ChokingHazard": { "SmallParts": "Yes", "SmallBall": "Is a small ball", "Balloons": "Yes", "Marble": "Contains a marble" } } } }, { "Action": "Update Item", "BasicInfo": { "SellerPartNumber": "A006Leon_Test_003", "WebsiteShortTitle": "Test for Leon", "ProductDescription": "Test for Leon", "ItemDimension": { "ItemLength": "2.0", "ItemWidth": "2.0", "ItemHeight": "2.0" }, "ItemWeight": "2.0", "ActivationMark": "False", "ItemImages": { "Image": { "ImageUrl": "http://10.1.24.143:4567/images/20.gif", "IsPrimary": "True" } }, "Warning": { "Prop65": "No", "Prop65Motherboard": "Yes", "OverAge18Verification": "No", "ChokingHazard": { "SmallParts": "Yes", "SmallBall": "Is a small ball", "Balloons": "Yes", "Marble": "Contains a marble" } } } } ] } } } }
Response Body
Attribute | Format | Description |
IsSuccess | String | Get feed status operation:
True: Successful |
OperationType | String | Fixed value: SubmitFeedResponse |
SellerID | String | Your seller ID |
RequestType | String | Value: ITEM_DATA |
RequestDate | String | The date when the feed was submitted. (Pacific Standard Time) |
RequestStatus | String | The status of the feed submission:
SUBMITTED |
Memo | String | Additional Information |
Schema: SubmitFeedResponse.xsd
Example: XML, Response
<?xml version="1.0" encoding="utf-8"?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>SubmitFeedResponse</OperationType> <SellerID>A006</SellerID> <ResponseBody> <ResponseList> <ResponseInfo> <RequestId>2291326430</RequestId> <RequestType>ITEM_DATA</RequestType> <RequestDate>2/16/2012 12:29:19</RequestDate> <RequestStatus>SUBMITTED</RequestStatus> </ResponseInfo> </ResponseList> </ResponseBody> <Memo /> </NeweggAPIResponse>
Example: Json, Response
{ "IsSuccess": true, "OperationType": "SubmitFeedResponse", "ResponseBody": { "ResponseList": [ { "RequestDate": "2/22/2012 17:24:35", "RequestId": "2PQCX3CMQ82MK", "RequestStatus": "SUBMITTED", "RequestType": "ITEM_DATA" } ] }, "SellerID": "A006" }
Request Failure Errors
For common HTTP error responses, please refer to Failed Response Error Code List.
Error Code | Description |
DF003 | The MaxCount (maximum request records) CANNOT be over 30000. |
DF004 | Unfortunately, we are unable to process your request at this time. We apologize for the inconvenience. Please try again later. |
DF011 | Your data feed request will not be processed during the scheduled data feed processing restriction from [{begin timestamp: hh:mm:ss, MM/DD/YYYY}] to [{end timestamp: hh:mm:ss, MM/DD/YYYY}]). Please contact datafeeds@newegg.com if you have any question or concern. Thank you for your patience. |
Example: XML, Response
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>DF003</Code> <Message>The MaxCount (maximum request records) CANNOT be over 30000</Message> </Error> </Errors>
Example: Json, Response
[ { "Code": "DF003", "Message": "The MaxCount (maximum request records) CANNOT be over 30000" } ]
Last updated: May 14, 2021