Download Feed Schema

Download the schema of specified feed type. You can download schema files for Item Creation, Inventory Update or Order Shipping.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sellermgmt/seller/feedschema?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/sellermgmt/seller/feedschema?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/sellermgmt/seller/feedschema?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 10 per min per client

Request Body

Attribute Required? Format Description
OperationType Yes String Fixed values: GetFeedSchemaRequest
FeedType Yes Integer The feed schema type which you want to download from Newegg system.

Current only support the following:

Feed Value Available for Platform(s) Description
1 All ITEM_DATA – The schema for batch create item / update item / update and/or append image to item(s).
2 Neweggbusiness.com, Newegg.ca INVENTORY_AND_PRICE_DATA – The schema for batch update inventory/price.
3 All ORDER_SHIP_NOTICE_DATA – The schema for batch ship order.
4 All ITEM_BATCH_UPDATE – The schema for batch item update. The schema for batch updating the basic information for items under multiple subcategories at a time. This template can only be used to update common fields: (i.e. “Website Short Title”, “Product Description”, “Item Images”, etc.)
5 Newegg.com, Newegg.ca MULTICHANNEL_ORDER_DATA – The schema for batch create multi-channel order.
6 All ITEM_DATA_UPCMATCH – A simplified version of item creation. This can be used to create items that exist on Newegg.com.
7 Newegg.com ITEM_PROMOTION_DATA – The schema for batch create item promotion requests.
8 All VOLUME_DISCOUNT_DATA – The schema for batch create/update/delete volume discount.
10 Newegg.com INVENTORY_DATA – Through this type you can batch update inventory.
11 Newegg.com PRICE_DATA – Through this type you can batch update price.

 
IndustryCode Yes, if FeedType = ITEM_DATA String The industry code which the ITEM_DATA schema belongs to.

You can get the industry code through GET Industry List function.

Schema:  GetSchemaRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetFeedSchemaRequest</OperationType>
    <RequestBody>
        <GetFeedSchema>
            <FeedType>1</FeedType>
            <IndustryCode>BA</IndustryCode>
        </GetFeedSchema>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

PUT https://api.newegg.com/marketplace/sellermgmt/seller/feedschema?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
    "OperationType": "GetFeedSchemaRequest",
    "RequestBody": {
        "GetFeedSchema": {
            "FeedType": "1",
            "IndustryCode": "BA"
        }
    }
}

Response Body

Newegg compresses the schema file(s), response is a Base64-encoded string. To obtain this package:

  1. Download response, save it as binary file with a “.zip” extension.
  2. Decode the Base64-encoded string using zip file extractor application.

Request Failure Errors

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

Error Code Description
DF008 Invalid industry code [{0}].

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>DF008</Code>
        <Message>Invalid industry code ABC</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "DF008",
        "Message": "Invalid industry code ABC"
    }
]

Last updated: May 26, 2021