Item Subscription Feed

Batch add/remove items for Subscription & Save program.

Subscribe & Save is Newegg’s subscription service. It is available for most items in different categories. This program allows customers to subscribe to certain items for repeat uses and have them shipped every few months with certain percentage of discount.

Note: By submitting seller’s item, all listed items will automatically join/leave for all the ongoing Newegg’s subscription programs.

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_SUBSCRIPTION

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: Subscription
SellerPartNumber Yes String The item’s seller part number. It will be used to identify the item for opt-in/out of program.
Action Yes String Specify the action you would like to perform.

Available values:

Add: If you want to add the items to Subscription & Save program.
Remove: If you want to remove the items from Subscription & Save program.

If no value was entered for this field, by default the system will treat it as “Add”.

Schema: ItemSubscription.xsd

Example: XML, Request

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

<NeweggEnvelope>
    <Header>
        <DocumentVersion>1.0</DocumentVersion>
    </Header>
    <MessageType>Subscription</MessageType>
    <Message>
        <Item>
            <SellerPartNumber>JACKETEST0921001004</SellerPartNumber>
            <Action>Add</Action>
        </Item>
        <Item>
            <SellerPartNumber>JACKETEST0921001003</SellerPartNumber>
            <Action>Remove</Action>
        </Item>
    </Message>
</NeweggEnvelope>

Example: Json, Request

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

{
    "NeweggEnvelope": {
        "Header": {
            "DocumentVersion": "1.0"
        },
        "MessageType": "Subscription",
        "Message": {
            "Item": [
                {
                    "SellerPartNumber": "JACKETEST0921001004",
                    "Action": "Add"
                },
                {
                    "SellerPartNumber": "JACKETEST0921001003",
                    "Action": "Remove"
                }
            ]
        }
    }
}

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_SUBSCRIPTION
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_SUBSCRIPTION</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_SUBSCRIPTION"
            }
        ]
    },
    "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