Item Promotion Feed

Batch request items to promotion deal center.

Newegg marketplace offers a lot of promotion strategies to help sellers increase their sales, in order to better organize the deals.  Our promotion team will review the request and find the best place where the promotion could be seen by customers.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/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_PROMOTION_DATA

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
POST Required XML, Json XML, Json Max. 100 requests per min per client

Note: Maximum Size of Request 10,000 records per file. Limit 30,000 records per hour.

Request Body

Attribute Required? Format Description
DocumentVersion Yes Decimal Fixed value: 1.0
MessageType Yes String Fixed value: ItemPromotion
TabID No Integer This Tab ID is NOT required. If you left this empty all requests will go to “Marketplace Deal Center”.  (You can see this tab on Seller Portal > Manage Promotion > Submit Deals page) .

Our promotion team will review the request and once the request gets approved, will assign an appropriate promotion vehicle for the item.

If you already know the Tab ID, you can specify it here and the request will be added in the tab group on Newegg Marketplace Hot Deals page.

Note:  Obtaining the Tab ID information go to  Newegg Seller Portal > Manage Promotion > Submit Deals page.

SellerPartNumber Yes, if NeweggItemNumber is not provided String The item’s seller part number. It will be used to identify the item for promotion.
NeweggItemNumber Yes, if SellerPartNumber is not provided String Newegg’s assigned number to item. It will be used to identify the item for promotion.
PromoMSRP No Decimal The manufacturer’s suggested retail price (MSRP) or list price for item during the
promotion.Format: 10 digits allowed to the left of the decimal point and 2 digits to the right of the decimal point. Please do not use commas or dollar signs.
PromoSellingPrice Yes Decimal The actual price at which the item is offered for during the promotion.

Format: 10 digits allowed to the left of the decimal point and 2 digits to the right of the decimal point. Please do not use commas or dollar signs.

PromoShipping Yes String The shipping charge setting for item during the promotion.

Available values: “Default” or “Free”

Shipping charge for “Default” setting is determined by seller’s shipping rate setting at Newegg Seller Portal > Manage Account > Shipping Settings.

PromoStartDate Yes Datetime The date when the promotion will be starting.

Format: mm/dd/yyyy

The default time is 12:00:00 AM

PromoEndDate Yes Datetime The date when the promotion will be end.

Format: mm/dd/yyyy

The default time is 11:59:00 PM

LimitQty No Integer The maximum quantity this item can be purchased by a customer within a 48 hour time period.

If left empty, there will be no quantity limitation.

MaxQty No Integer The maximum quantity that can be sold for this item during this promotion period.

Once the promotion schedule has started, this value cannot be updated.

If left empty, there will be no quantity limitation.

MinInventory No Integer The minimum inventory level. The level below which inventory can never drop 24 hours prior to promotion start time.

Inventory updates via datafeeds / API / seller portal will not be processed if the updates are less than this value.

You can freely update inventory 24 hours after promotion start time. For urgent inventory adjustment please contact datafeeds@newegg.com for assistance.

Default value is “0”.

This field is usable only when “InventoryLocked” = true.

InventoryLocked No String If set with “Yes”, any inventory update via datafeeds / API / seller portal will not be
processed if request to update inventory less than the value in “MinInventory”. For urgent inventory adjustment please contact datafeeds@newegg.com for assistance.Default value is “No”.
Note No String Additional message or memo to provide to promotional team.

Max 200 characters limit

Schema: ItemPromotion.xsd

Example: XML, Request

POST https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_PROMOTION_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggEnvelope>
    <Header>
        <DocumentVersion>1.0</DocumentVersion>
    </Header>
    <MessageType>ItemPromotion</MessageType>
    <Message>
        <Item>
            <SellerPartNumber>1234567</SellerPartNumber>
            <NeweggItemNumber>9SI600185746359</NeweggItemNumber>
            <PromoMSRP>290.99</PromoMSRP>
            <PromoSellingPrice>190.99</PromoSellingPrice>
            <PromoShipping>Free</PromoShipping>
            <PromoStartDate>07/27/2014</PromoStartDate>
            <PromoEndDate>08/01/2014</PromoEndDate>
            <LimitQty>20</LimitQty>
            <MaxQty>1000</MaxQty>
            <MinInventory>0</MinInventory>
            <InventoryLocked>No</InventoryLocked>
            <Note>This is a promotion for Back to School</Note>
        </Item>
        <Item>
            <SellerPartNumber>1234567</SellerPartNumber>
            <NeweggItemNumber>9SI600185746359</NeweggItemNumber>
            <PromoMSRP>290.99</PromoMSRP>
            <PromoSellingPrice>190.99</PromoSellingPrice>
            <PromoShipping>Free</PromoShipping>
            <PromoStartDate>07/27/2014</PromoStartDate>
            <PromoEndDate>08/10/2014</PromoEndDate>
            <LimitQty>20</LimitQty>
            <MaxQty>1000</MaxQty>
            <MinInventory>0</MinInventory>
            <InventoryLocked>No</InventoryLocked>
            <Note/>
        </Item>
    </Message>
</NeweggEnvelope>

Example: Json, Request

POST https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_PROMOTION_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "NeweggEnvelope": {
        "Header": {
            "DocumentVersion": "1.0"
        },
        "MessageType": "ItemPromotion",
        "Message": {
            "Item": [
                {
                    "SellerPartNumber": "1234567",
                    "NeweggItemNumber": "9SI600185746359",
                    "PromoMSRP": "290.99",
                    "PromoSellingPrice": "190.99",
                    "PromoShipping": "Free",
                    "PromoStartDate": "07/27/2014",
                    "PromoEndDate": "08/01/2014",
                    "LimitQty": "20",
                    "MaxQty": "1000",
                    "MinInventory": "0",
                    "InventoryLocked": "No",
                    "Note": "This is a promotion for Back to School"
                },
                {
                    "SellerPartNumber": "1234567",
                    "NeweggItemNumber": "9SI600185746359",
                    "PromoMSRP": "290.99",
                    "PromoSellingPrice": "190.99",
                    "PromoShipping": "Free",
                    "PromoStartDate": "07/27/2014",
                    "PromoEndDate": "08/10/2014",
                    "LimitQty": "20",
                    "MaxQty": "1000",
                    "MinInventory": "0",
                    "InventoryLocked": "No"
                }
            ]
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: SubmitFeedResponse
SellerID String Your seller ID
RequestType String Value: ITEM_PROMOTION_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_PROMOTION_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_PROMOTION_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: October 15, 2018