Newegg Marketplace APIDeveloper Guide V3.07
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 515
| Download | |
| Open PDF In Browser | View PDF |
Newegg Marketplace API Developer Guide
Version 3.07, September 2018
1
Contents
Change History ........................................................................................................................................................................................... 4
Newegg Marketplace API ........................................................................................................................................................................... 6
1.
Registering To Use API Services ................................................................................................................................................. 6
2.
Newegg Marketplace API Authentication ................................................................................................................................. 7
2.1.
Authentication Failure Errors ...................................................................................................................................... 8
2.2.
Authorization for Third-party Developer ..................................................................................................................... 9
3.
TLS Requirements for Inbound Connections ........................................................................................................................... 10
4.
URL Case-sensitive................................................................................................................................................................... 10
5.
Pacific Standard Time Requirement ........................................................................................................................................ 11
6.
Throttling ................................................................................................................................................................................. 12
7.
8.
9.
10.
6.1.
Per Seller ................................................................................................................................................................... 12
6.2.
Rate Limit .................................................................................................................................................................. 12
6.3.
Datafeed Limit ........................................................................................................................................................... 12
6.4.
HTTP Headers and Response Codes .......................................................................................................................... 13
Create Your Own Client Library ............................................................................................................................................... 14
7.1.
Request Format ......................................................................................................................................................... 14
7.2.
Create a HTTP Request .............................................................................................................................................. 14
7.3.
Bad Request ............................................................................................................................................................... 15
7.4.
Code Examples .......................................................................................................................................................... 17
Service Status .......................................................................................................................................................................... 34
8.1.
Get Service Status...................................................................................................................................................... 34
8.2.
Failover Endpoints for API Service ............................................................................................................................. 38
Item Management ................................................................................................................................................................... 39
9.1.
Manufacturer Lookup ................................................................................................................................................ 39
9.2.
Manufacturer Lookup for international country ....................................................................................................... 46
9.3.
Submit Manufacturer Request .................................................................................................................................. 53
9.4.
Get Manufacturer Request Status ............................................................................................................................. 58
9.5.
Volume Discount Creation/Update/Removal ............................................................................................................ 62
9.6.
Get Volume Discount Request Result ........................................................................................................................ 69
9.7.
Get Item Inventory .................................................................................................................................................... 73
9.8.
Get Item Price ............................................................................................................................................................ 79
9.9.
Update Item Inventory .............................................................................................................................................. 85
9.10.
Update Item Price ................................................................................................................................................. 90
9.11.
Submit Item Warranty Request ........................................................................................................................... 100
Order Management.......................................................................................................................................................... 108
10.1.
Get Order Status ................................................................................................................................................. 108
10.2.
Update Order Status ........................................................................................................................................... 111
10.3.
Order Confirmation ............................................................................................................................................. 121
10.4.
Remove Item(s) ................................................................................................................................................... 125
2
11.
12.
13.
14.
15.
16.
10.5.
Get Order Info ..................................................................................................................................................... 130
10.6.
Get SBN (Shipped by Newegg) Order Cancellation Request Result .................................................................... 146
10.7.
Get Additional Order Information ....................................................................................................................... 149
Newegg Shipping Label Service ........................................................................................................................................ 157
11.1.
Submit Shipping Request .................................................................................................................................... 157
11.2.
Get Request Detail .............................................................................................................................................. 168
11.3.
Confirm Shipping Request ................................................................................................................................... 181
11.4.
Void Shipping Request ........................................................................................................................................ 185
11.5.
Get Package List .................................................................................................................................................. 189
11.6.
Get Shipping Labels ............................................................................................................................................. 193
DataFeed Management .................................................................................................................................................... 198
12.1.
Submit Feed ............................................................................................................................................................. 199
12.2.
Get Feed Status ....................................................................................................................................................... 277
12.3.
Get Feed Result ....................................................................................................................................................... 283
RMA Management ........................................................................................................................................................... 309
13.1.
Submit RMA............................................................................................................................................................. 309
13.2.
Update RMA ............................................................................................................................................................ 323
13.3.
Get RMA Info ....................................................................................................................................................... 338
13.4.
Issue Courtesy Refund ......................................................................................................................................... 351
13.5.
Get Courtesy Refund Request Status .................................................................................................................. 355
13.6.
Get Courtesy Refund Info .................................................................................................................................... 362
Report Management ........................................................................................................................................................ 369
14.1.
Submit Report Request ....................................................................................................................................... 369
14.2.
Get Report Status ................................................................................................................................................ 392
14.3.
Get Report Result ................................................................................................................................................ 397
Seller Management .......................................................................................................................................................... 440
15.1.
Get Industry List ...................................................................................................................................................... 440
15.2.
Get Subcategory Status ........................................................................................................................................... 443
15.3.
Get Subcategory Status for international country ................................................................................................... 448
15.4.
Download Feed Schema .......................................................................................................................................... 453
15.5.
Get Subcategory Properties..................................................................................................................................... 456
15.6.
Get Subcategory Property Values ............................................................................................................................ 461
15.7.
Seller Status Check .................................................................................................................................................. 466
SBN (Shipped by Newegg) Management ......................................................................................................................... 470
16.1.
Get Inbound Shipment Plan Suggestion .................................................................................................................. 470
16.2.
Submit Inbound Shipment Request ......................................................................................................................... 478
16.3.
Get Inbound Shipment Status Request ................................................................................................................... 489
16.4.
Get Inbound Shipment Request Result ................................................................................................................... 493
16.5.
Get Inbound Shipment List ...................................................................................................................................... 500
16.6.
Get Warehouse List ................................................................................................................................................. 507
Appendix ................................................................................................................................................................................................ 513
3
1.
Common Request Headers .................................................................................................................................................... 513
2.
Failed Response Error Code List ............................................................................................................................................ 513
3.
2.1.
General HTTP error code ......................................................................................................................................... 513
2.2.
Common Error Response ......................................................................................................................................... 514
Acceptable Date Format ........................................................................................................................................................ 515
Change History
Version
Change Date
Description
09/15/2018
New API call
DataFeed Management
ITEM_CHINATAXSETTING_DATA is available to set tax type for items enabled for China,
Section 12.
Report Management
V3.07
07/24/2018
Tax setting report is available for Items Enabled for China, Section 14.
New API call
DataFeed Management
ITEM_CAPROP65_DATA is available to set the California’s Proposition 65 (“Prop 65”)
warning for items, Section 12.
Report Management
California’s Proposition 65 Warning Report is available for requesting the report for the
California’s Proposition 65 (“Prop 65”) warning for items, Section 14.
Updated API calls
Report Management
Version 310 is available for compressing multiple files into a zip formatted single package for the
following reports:
V3.07
06/11/2018
Daily Inventory Report
Daily Price Report
Updated API calls
Order Management
Additional value was added to the element of SalesChannel to identify the RMA Replacement
Order. Related functions:
Get Order Status, Section 10.1.
Get Order Info, Section 10.5.
Report Management > Get Report Result > Order List Report, section 14.3.
RMA Management
Additional element: ReplacementOrderNuber was added to identify the RMA
Replacement Order. Related functions:
4
Get RMA Info, section 13.3.
Report Management > Get Report Result > RMA List Report, section
14.3.
Additional Version 309 was added to reference the replacement order numbers for
existing return requests. Related functions:
Get RMA Info, section 13.3.
Report Management > Get Report Result > RMA List Report, section
14.3.
Report Management
Version update for Get Report Result call, section 14.3:
304 was removed.
305 was replaced by 306.
Note for existing users. API calls with antiquated version will not receve errors.
V3.07
03/19/2018
New API calls
Order Management
Get Additional Order Information. API guide > Section 10.7. This is designed for the
following:
Additional order requirement for certain countries.
The original recipient information for orders shipped by NISP service.
The original recipient information inputted by international customers.
API Request Throttling
The API request throttling for item price and inventory update has been updated. Details can be
reviewd at:
Datafeed Management. API guide > section 12.1.
5
Newegg Marketplace API
Newegg Marketplace API is a set of API services that enable sellers to manage items, orders, accounts and reports.
Please go through the following before you start:
1. Registering To User API Service
2. Newegg Marketplace API Authentication
3. SSL Requirements for Inbound Connections
4. URL Case-sensitive
5. Pacific Standard Time Requirement
6. Throttling
7. Create Your Own Client Library
The following sections define all available services in details to serve different business operations:
8. Service Status
9. Item Management
10. Order Management
11. Newegg Shipping Label Service
12. DataFeed Management
13. RMA Management
14. Reports Management
15. Seller Management
16. SBN (Shipped by Newegg) Management
1. Registering To Use API Services
If you would like to use Newegg Marketplace API services, please contact your Newegg Marketplace seller account
manager to obtain your Newegg API credentials.
Obtain your API account API Key & Secret Key– once your API account request has been approved and created,
Newegg Marketplace integration team will assign and send a pair of API key and secret key to you. You must provide the
API key and the secret key per function as authentication in order to access Newegg Marketplace API services.
Authorize the access rights to 3rd party developer – if you want to allow your 3rd party developer(s) to access the
Newegg Marketplace API services, with your authorization, we can assign an additional pair of API key and secret key to
the developer(s). The 3rd party developer(s) must present the additionally assigned API key and secret key in order to
access Newegg Marketplace API services on your behalf.
6
*Note: We highly recommend that you do not let any unauthorized personnel or 3rd party developers have access to
your original pair of API key and secret key. Anyone with this information can access Newegg Marketplace API services
as you. As stated before, we can issue additional API key and secret key to your 3rd party developers, but you should
keep your original key information to yourself.
2. Newegg Marketplace API Authentication
To access Newegg Marketplace API services, you must provide authentication information listed below:
Name
Required?
Description
Authorization
Yes
Format: Authorization:{authorization}
API key: the unique API Key which Newegg Marketplace integration team
assigned to you
Secretkey
Yes
Format: Secretkey:{secretkey}
Secret key: the unique Secret Key which Newegg Marketplace integration
team assigned to you
Example: XML, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/inventory?sellerid=A006
Authorization: 727ddc067f4d115bd544aff46bc15634
SecretKey: 1B6B1383-01D1-4A1E-BA53-05DECE9BD765
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/inventory?sellerid=A006
Authorization: 727ddc067f4d115bd544aff46bc15634
SecretKey: 1B6B1383-01D1-4A1E-BA53-05DECE9BD765
Content-Type: application/json
Accept: application/json
7
2.1. Authentication Failure Errors
API key authentication failure:
Error Code
Description
InvalidConsumerKey
The provided consumer key is incorrect or invalid
Example: XML, Response
InvalidConsumerKey
The provided consumer key is incorrect or invalid.
Example: Json, Response
{
"Code": "InvalidConsumerKey",
"Message": "The provided consumer key is malformed or otherwise invalid."
}
Secret Key authentication failure:
Error Code
Description
InvalidToken
SellerID is null
InvalidToken
Secret Key is null
InvalidToken
Invalid Secret Key
AccessDenied
The specified seller ID is invalid or you do not have authorization from this seller
AccessDenied
The API services for this seller account has been deactivated
Example: XML, Response
InvalidToken
Secret Key is null.
8
Example: Json, Response
{
"Code": "InvalidToken",
"Message": "The provided secret key is null."
}
2.2. Authorization for Third-party Developer
If you are a third-party developer/integration partner who wants to access and utilize Newegg Marketplace API services
for a seller, you must:
Get one API key from our Newegg Marketplace Integration Team (Datafeeds@Newegg.com)
Get the Seller ID and Secret key from the seller/Newegg that authorized the Newegg Marketplace API services
access to you, for each seller you are integrating for. (Seller and 3rd party developer can contact Newegg
Marketplace for this information)
Attach the API key and Secret key in the http header, and specify the Seller ID in the URL, and please make sure
the Secret Key is for the correct seller.
For the below example, the Secret Key must be the one corresponding to seller ID A001.
Example: XML, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/inventory?sellerid=A001
Authorization: 727ddc067f4d115bd544aff46bc15634
SecretKey: 1B6B1383-01D1-4A1E-BA53-05DECE9BD765
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/inventory?sellerid=A001
Authorization: 727ddc067f4d115bd544aff46bc15634
SecretKey: 1B6B1383-01D1-4A1E-BA53-05DECE9BD765
Content-Type: application/json
9
Accept: application/json
Otherwise the system will respond with below error message due to invalid secret key.
Example: XML, Response
InvalidToken
Invalid secret key.
Example: Json, Response
{
"Code": "InvalidToken",
"Message": "Invalid secret key."
}
3. TLS Requirements for Inbound Connections
Inbound connections to Newegg Marketplace API endpoints require TLS version 1.0 or higher.
4. URL Case-sensitive
Newegg Marketplace API URL’s are case-sensitive. Please make sure your request URL (excluding Seller ID) is all in
lower case. And the URL cannot contain any blank space or line break. Seller ID is an exception, and can be capitalized.
Example:
https://api.newegg.com/marketplace/contentmgmt/item
https://api.newegg.com/marketplace/contentmgmt/item/inventory?sellerid={sellerid}
https://api.newegg.com/marketplace/contentmgmt/item/price?sellerid={sellerid}
https://api.newegg.com/marketplace/contentmgmt/item/inventoryandprice?sellerid={sellerid}
https://api.newegg.com/marketplace/ordermgmt/orderstatus
10
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
5. Pacific Standard Time Requirement
Newegg Marketplace API requires the datetime field to be in Pacific Standard Time in all request and response content.
Please ensure in all your files and requests, the datetime field are specified in Pacific Standard Time.
The C# code example as following demonstrates how to convert your local time to a Pacific Standard Time.
Example: C#
//Your local time
System.DateTime localTimeNow = System.DateTime.Now;
//Get the PST time zone info
System.TimeZoneInfo pstTimeZoneInfo =
TimeZoneInfo.FindSystemTimeZoneById("Pacific Standard Time");
//Convert your local time to PST time
DateTime pstTime = ResolveAmbiguousOrInvalidTime(localTimeNow);
//Resolve Ambiguous or invalid time issue between PDT and PST exchange
private static DateTime ResolveAmbiguousOrInvalidTime(DateTime ambiguousOrInvalidTime)
{
TimeZoneInfo timeZoneInfo = TimeZoneInfo.FindSystemTimeZoneById("Pacific Standard
Time");
if(timeZoneInfo.IsInvalidTime(ambiguousOrInvalidTime) ||
timeZoneInfo.IsAmbiguousTime(ambiguousOrInvalidTime))
{
//DateTime utcTime = ambiguousOrInvalidTime.ToUniversalTime();
DateTime utcTime = DateTime.SpecifyKind(ambiguousOrInvalidTime TimeZoneInfo.Local.BaseUtcOffset,DateTimeKind.Utc);
return TimeZoneInfo.ConvertTime(utcTime, timeZoneInfo);
}
return ambiguousOrInvalidTime;
}
11
6. Throttling
Newegg Marketplace API supports large variety of application and process millions of API requests daily. To maintain stable
service with a high level of availability, Newegg Marketplace limits the API usage.
6.1. Per Seller
Rate limiting of each API request is based on per-seller basis.
6.2. Rate Limit
Rate limits are divided into minute intervals. This means you have a maximum number of requests you can submit to a
specific function in a one-minute period.
6.3. Datafeed Limit
Certain datafeed related functions have the hourly limitation of request and the maximum size of each request. This means
you have a maximum allowance of requests you can submit to a specific function in a one-hour period. And each request
cannot exceed the maximum size limitation.
Below is the response if you exceed the limit:
Example: XML, Response
DF012
Your feed with request ID: 2291326430 exceeded the hourly allowance and cannot be
processed. Please submit your feed again after 2016-12-16 11:05:00.
Example: Json, Response
{
"Code": "DF012",
12
"Message": "Your feed with request ID: 2291326430 exceeded the hourly allowance and cannot be
processed. Please submit your feed again after 2016-12-16 11:05:00."
}
6.4. HTTP Headers and Response Codes
The following elements in HTTP headers can be used for diagnosing a given rate limit for the API service endpoint.
X-RateLimit-Limit:Request limit per defined time window
X-RateLimit-Remaining: The number of requests left for the time window.
X-RateLimit-ResetTime: the time for resetting the remaining records.
X-RecordCount-Limit: the max record seller can upload.
X-RecordCount-Remaining: the # of record count left for the time window
X-RecordCount-ResetTime: the time for resetting the remaining records.
The API will return a HTTP 429 “Too Many Requests” response code, and the following error will be returned in the response
body:
Example: XML, Response
429
Too many request.
Example: Json, Response
[
{
"Code": "429",
"Message": "Too many request."
}
]
13
7. Create Your Own Client Library
You can create your own client library to use with the Newegg Marketplace API. Your code should construct and sign a
request in the format expected by the Newegg Marketplace API, and then you can parse the XML response.
You can access the Newegg Marketplace API by following steps:
1. Determine the correct Newegg Marketplace API URL to use.
3. Specify the parameter value in the request URL.
4. Specify the correct HTTP request method and the xml/Json content types that are accepted.
5. Attach your API Key and the Secret Key in requests (refer to authentication examples above).
5. Construct the request body as required. Submit the HTTP request.
6. Parse the response.
7.1. Request Format
Newegg Marketplace API supports query/update requests for calling Restful service actions. Query requests are simple
HTTP requests, using the GET or POST method with query parameters in the URL or HTTP body respectively. Update
requests using the PUT or DELETE method with updated parameters in the URL or HTTP body respectively.
Newegg Marketplace API requires the use of HTTPS in order to prevent third-party eavesdropping on your
communication with Newegg.
7.2. Create a HTTP Request
To create a Newegg Marketplace API query/update request, you need to first construct a correctly formatted request
URL. You can refer to the URL template of the API services you want to use (please refer to the API reference section).
Below are the possible value lists in your HTTP request:
Name
Required?
Description
Request URL
Yes
The Newegg Marketplace API service endpoint you are using
Request Method
Yes
The GET/POST or PUT/DELETE method of the API service required
Body Content-type
No
The XML/Json format of the content in the request body. The default is
XML.
Response Content-type
No
The XML/Json format of the content in the response. The default is XML.
Authentication header
Yes
Format: Authorization:{api-key}
The API key of the authorized API developer
SecretKey header
Yes
Format: Secretkey:{secretkey}
14
The secret key of an authorized API developer
RAW body
No
Pass parameters by the request body. The format of the content should
conform to the specification of the API service.
Note: The API reference section includes the important information for each API function for your reference.
Example:
GET
Https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
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
OrderNumber
Yes
The order number
URL Resource Information:
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
HTTP method – specifies which request method.
Authentication -- indicates this service needs an authentication to use.
Request Formats – the request parameters format in the request body.
Response Formats – the supported format of the response content.
Rate Limited – API Request Limit
Request Parameters:
URL Parameters – the required parameters in the request URL.
Request Parameters – some specific parameters in the request body. The format shall be XML or Json; you can get the
supported type from the “request format” in the URL Resource Information section above.
7.3. Bad Request
Newegg Marketplace API will return a bad request (HTTP status code = 400) if you submitted an inappropriate request
in the following types:
15
Illegal request body. Such as not well-formatted XML or incorrect tag or data type.
Example: XML, Response
CE003
XML parsing error. The 'NeweggAPIRequest1' start tag on line 1 position 2 does not
match the end tag of 'NeweggAPIRequest'. Line 1, position 451.
Example: Json, Response
{
"Code":"CE003",
"Message":"XML parsing error. The 'NeweggAPIRequest1' start tag on line 1 position 2 does not
match the end tag of 'NeweggAPIRequest'. Line 1, position 451."
}
Business validation failure. Invalid data request or fail to match business requirement. For the detail error code
and message please refer to the “Request Failure Errors” part at the end of every service definition.
Example: XML, Response
SO011
Only unshipped orders can be shipped. The order status is currently Closed
Example: Json, Response
{
"Code": "SO011",
"Message": "Only unshipped orders can be shipped. The order status is currently Closed"
}
In order to parse error messages in your own programs correctly, please refer to “Exception Handling for Bad Request” in
the “Code Examples” section.
16
7.4. Code Examples
* Please note that these examples are provided to you with the simple purpose of demonstrating how you can use
Newegg Marketplace API functions and resources. The examples do not take in consideration of extra requirements such
as authentication/security required by each programming language.
C# Example
The code example below demonstrates how to query the inventory quantity of the specified Newegg Item
“9SIA00600000023” for the seller “A006” in .NET C#
1.
Create a new class to de-serialize the response:
Example: C#, Inventory response entity
public class InventoryResult
{
public string SellerID { get; set; }
public string ItemNumber { get; set; }
public int AvailableQuantity { get; set; }
public string Active { get; set; }
public string SellerPartNumber { get; set; }
public string ShipByNewegg { get; set; }
}
2.
Get the inventory available quantity:
Example: C#, Get Item Inventory
Console.WriteLine(string.Format("Newegg Marketplace API - Get Inventory request at:{0}",
DateTime.Now.ToString()));
Console.WriteLine("");
Console.WriteLine("*********************************************************************");
Console.WriteLine("");
try
{
InventoryResult inventoryResult = null;
//Determine the correct Newegg Marketplace API endpoint to use.
17
// Please make sure your request URL is all in lower case
string endpoint =
@"https://api.newegg.com/marketplace/contentmgmt/item/inventory?sellerid={0}";
endpoint = String.Format(endpoint, "A006");
//Create an HttpWebRequest
System.Net.HttpWebRequest request =
System.Net.WebRequest.Create(endpoint) as HttpWebRequest;
//Remove proxy
request.Proxy = null;
//Specify the request method
request.Method = "POST";
//Specify the xml/Json request and response content types.
request.ContentType = "application/xml";
request.Accept = "application/xml";
//Attach authorization information
request.Headers.Add("Authorization", "your API-key here");
request.Headers.Add("Secretkey", "your secretkey here");
//Construct the query criteria in the request body
string requestBody = @"
1
A006ZX-35833
";
byte[] byteStr = Encoding.UTF8.GetBytes(requestBody);
request.ContentLength = byteStr.Length;
using (Stream stream = request.GetRequestStream())
{
stream.Write(byteStr, 0, byteStr.Length);
}
//Parse the response
using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
{
18
if (response.StatusCode != HttpStatusCode.OK)
{
Console.WriteLine(String.Format("Code:{0}.Error:{1}",
response.StatusCode.ToString(), response.StatusDescription));
return;
}
using (Stream responseStream = response.GetResponseStream())
{
XmlSerializer serializer =
new XmlSerializer(typeof(InventoryResult));
inventoryResult =
serializer.Deserialize(responseStream) as InventoryResult;
}
}
string sellerID = inventoryResult.SellerID;
string itemNumber = inventoryResult.ItemNumber;
int availableQuantity = inventoryResult.AvailableQuantity;
string message = String.Format("SellerID:{0} ItemNumber:{1} Availble Quantity:{2} \r\n
Active:{3} SellerPartNumber:{4} ShipByNewegg:{5}",
inventoryResult.SellerID,
inventoryResult.ItemNumber,
inventoryResult.AvailableQuantity,
inventoryResult.Active,
inventoryResult.SellerPartNumber,
inventoryResult.ShipByNewegg);
Console.WriteLine(message);
}
catch (WebException we)//Error Handling for Bad Request
{
if (((WebException)we).Status == WebExceptionStatus.ProtocolError)
{
WebResponse errResp = ((WebException)we).Response;
using (Stream respStream = errResp.GetResponseStream())
{
StreamReader reader = new StreamReader(respStream);
Console.WriteLine(String.Format("{0}", reader.ReadToEnd()));
19
}
}
}
catch (Exception ex)//unhandle error
{
Console.WriteLine(string.Format("exception: at time:{0}", DateTime.Now.ToString()));
Console.WriteLine(ex.Message + "---->");
Console.WriteLine(ex.StackTrace.ToString());
}
Console.WriteLine("");
Console.WriteLine("*********************************************************************");
Console.WriteLine("");
Console.WriteLine("Please input any key to exit……");
Console.ReadLine();
Error Handling for Bad Request (Status Code = 400)
try
{
//Your code here
}
catch (WebException we)//Error Handling for Bad Request
{
if (((WebException)we).Status == WebExceptionStatus.ProtocolError)
{
WebResponse errResp = ((WebException)we).Response;
using (Stream respStream = errResp.GetResponseStream())
{
StreamReader reader = new StreamReader(respStream);
Console.WriteLine(String.Format("{0}", reader.ReadToEnd()));
}
}
}
Java Example
The following example demonstrates how to retrieve order information through Newegg Marketplace API in Java.
20
/*
* To change this template, choose Tools | Templates
* And open the template in the editor.
*/
package marketplaceapi_java_demo;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.net.URL;
import java.security.cert.X509Certificate;
import java.util.Calendar;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLSession;
import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager;
public class MarketplaceAPI_Java_Demo {
/**
* @param args the command line arguments
*/
public static void main(String[] args) throws Exception{
GetOrderInfo();
}
private static void GetOrderInfo() throws Exception{
System.out.println("[" + Calendar.getInstance().getTime() + "]Newegg Marketplace API GetOrderInfo:");
System.out.println("-----------------------------------");
String requestUrl =
"https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid=A006";
try {
// Create a trust manager that does not validate certificate chains
21
TrustManager[] trustAllCerts = new TrustManager[] {new X509TrustManager() {
public java.security.cert.X509Certificate[] getAcceptedIssuers() {
return null;
}
public void checkClientTrusted(X509Certificate[] certs, String authType) {
}
public void checkServerTrusted(X509Certificate[] certs, String authType) {
}
}
};
// Install the all-trusting trust manager
SSLContext sc = SSLContext.getInstance("SSL");
sc.init(null, trustAllCerts, new java.security.SecureRandom());
HttpsURLConnection.setDefaultSSLSocketFactory(sc.getSocketFactory());
// Create all-trusting host name verifier
HostnameVerifier allHostsValid = new HostnameVerifier() {
public boolean verify(String hostname, SSLSession session) {
return true;
}
};
// Install the all-trusting host verifier
HttpsURLConnection.setDefaultHostnameVerifier(allHostsValid);
URL url = new URL(requestUrl);
HttpsURLConnection httpsConnection = (HttpsURLConnection)url.openConnection();
//javax.net.ssl. = false;
//Set accepted format in response message:application/xml|application/json
httpsConnection.setRequestProperty("Accept", "application/xml");
//Set the accepted format in request body:application/xml|application/json
httpsConnection.setRequestProperty("content-type", "application/xml");
//Set the request method:GET|PUT|POST
httpsConnection.setRequestMethod("PUT");
//Set authorization key
22
httpsConnection.setRequestProperty("Authorization",
"720ddc067f4d115bd544aff46bc75634");
//Set secret-key
httpsConnection.setRequestProperty("SecretKey", "21EC2020-3AEA-1069-A2DD08002B30309D");
httpsConnection.setDoInput(true);
httpsConnection.setDoOutput(true);
String requestStr = ""
+ "GetOrderInfoRequest "
+ ""
+ "1 "
+ "10 "
+ ""
+ ""
+ "159243598 "
+ "41473642 "
+ " "
+ "1 "
+ "1 "
+ "2011-01-01 09:30:47 "
+ "2011-12-17 09:30:47 "
+ "0 "
+ " "
+ " "
+ " ";
byte[] requestBody = requestStr.getBytes();
//Set content-length
httpsConnection.setRequestProperty("Content-Length",
String.valueOf(requestBody.length));
OutputStream outStream = httpsConnection.getOutputStream();
outStream.write(requestBody);
outStream.close();
InputStreamReader inputReader = new
InputStreamReader(httpsConnection.getInputStream());
BufferedReader reader = new BufferedReader(inputReader);
23
String responseBody = "";
while(reader.ready()){
responseBody += reader.readLine();
}
reader.close();
inputReader.close();
System.out.println("[" + Calendar.getInstance().getTime() + "]Response Message:");
System.out.println("-----------------------------------");
System.out.println(responseBody);
} catch (MalformedURLException ex) {
System.out.println("Illegal request URI:" + ex.getMessage());
}
catch(Exception e){
System.out.println("Exception:" + e.getMessage());
//Error Handling for Bad Request
InputStreamReader errorReader = new
InputStreamReader(httpsConnection.getErrorStream());
BufferedReader bufferReader = new BufferedReader(errorReader);
String errorMsg = "";
while(bufferReader.ready()){
errorMsg += bufferReader.readLine();
}
bufferReader.close();
errorReader.close();
System.out.println(errorMsg);
}
}
}
24
Error Handling for Bad Request (Status Code = 400)
try
{
//Your code here
}
catch(Exception e){
System.out.println("Exception:" + e.getMessage());
//Error Handling for Bad Request
InputStreamReader errorReader = new InputStreamReader(httpsConnection.getErrorStream());
BufferedReader bufferReader = new BufferedReader(errorReader);
String errorMsg = "";
while(bufferReader.ready()){
errorMsg += bufferReader.readLine();
}
bufferReader.close();
errorReader.close();
System.out.println(errorMsg);
}
PHP Example
The code example below demonstrates how to access Newegg API with PHP curl extension under windows operation
system.
1.
Download php_curl.dll
2.
Edit php.ini and apply the extension:
Extension=php_curl.dll
3.
Restart the apache server
Example:PHP, Get order status
GET:
Example:PHP, Get item inventory
POST:
0
9SIA08I0492622
';
$header_array =array('Content-Type:application/xml',
'Accept:application/xml',
'Authorization: your API-key here',
'SecretKey: your secretkey here');
try
{
// Get the curl session object
$session = curl_init($request);
$putString = stripslashes($body);
$putData = tmpfile();
fwrite($putData, $putString);
fseek($putData, 0);
27
// Set the POST options.
curl_setopt($session, CURLOPT_HEADER, 1);
curl_setopt($session,CURLOPT_HTTPHEADER,$header_array);
curl_setopt($session, CURLOPT_POST, true);
curl_setopt($session, CURLOPT_HEADER, false);
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);
curl_setopt($session, CURLOPT_POSTFIELDS, $body);
curl_setopt($session, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($session, CURLOPT_INFILE, $putData);
curl_setopt($session, CURLOPT_INFILESIZE, strlen($putString));
// Do the POST and then close the session
$response = curl_exec($session);
curl_close($session);
print $response;
}
catch (InvalidArgumentException $e)
{
curl_close($session);
throw $e;
}
catch (Exception $e)
{
curl_close($session);
throw $e;
}
?>
Example:PHP, Update inventory and price
PUT:
1
A006testitem201201021459
1
200
34.98
29.92
1
0
';
$header_array =array('Content-Type:application/xml',
'Accept:application/xml',
'Authorization: your API-key here',
'SecretKey: your secretkey here');
try
{
// Get the curl session object
$session = curl_init($request);
$putString = stripslashes($body);
$putData = tmpfile();
fwrite($putData, $putString);
fseek($putData, 0);
// Set the POST options.
curl_setopt($session, CURLOPT_HEADER, 1);
curl_setopt($session,CURLOPT_HTTPHEADER,$header_array);
curl_setopt($session, CURLOPT_PUT, true);
curl_setopt($session, CURLOPT_HEADER, false);
curl_setopt($session, CURLOPT_RETURNTRANSFER, true);
curl_setopt($session, CURLOPT_POSTFIELDS, $body);
curl_setopt($session, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($session, CURLOPT_INFILE, $putData);
curl_setopt($session, CURLOPT_INFILESIZE, strlen($putString));
29
// Do the POST and then close the session
$response = curl_exec($session);
curl_close($session);
print $response;
}
catch (InvalidArgumentException $e)
{
curl_close($session);
throw $e;
}
catch (Exception $e)
{
curl_close($session);
throw $e;
}
?>
The code example below demonstrates how to access Newegg API with pecl http request extension under LINUX system.
1.
Download pecl_http extension from http://pecl.php.net/package/pecl_http, get the latest stable version such as 1.7.1
2.
Install the extension( refer to :
http://www.zipservers.com/community/showthread.php?59-How-to-install-PECL-Modules-on-Linux)
[root@server ]# cd /root/ ; wget http://pecl.php.net/get/pecl_http-1.6.5.tgz
[root@server ]# tar -zxvf pecl_http-1.6.5.tgz
[root@server ]# cd pecl_http-1.6.5
[root@server ]# phpize
[root@server ]# ./configure
[root@server ]# make
[root@server ]# make test
[root@server ]# make install
[root@server ]# php -i | grep “Configuration File”
Configuration File (php.ini) Path => /usr/local/lib
Loaded Configuration File => /usr/local/lib/php.ini
3.
Switch on the extension in the php.ini
[root@server ]# vi /usr/local/lib/php.ini
And add extension=http.so
30
4.
Restart the apache serve
Example: PHP, Get Item Inventory
'{your API-key here}',
'Secretkey' => '{your secret-key here}');
//set the body if necessary
$body = "
1
0
9SIA0B992342342
";
$options = array(headers => $header_array);
//create the httprequest object
//specfiy the request method:HTTP_METH_GET|HTTP_METH_POST|HTTP_METH_PUT
$httpRequest_OBJ = new httpRequest($url, HTTP_METH_POST, $options);
//add the content type
$httpRequest_OBJ->setContentType = 'Content-Type: text/xml';
//add the raw post data
//$httpRequest_OBJ->setRawPostData ($body);
$httpRequest_OBJ->setBody ($body);
try
{
//send the http request
$result = $httpRequest_OBJ->send();
}catch(HttpException $ex)
{
if (isset($ex->innerException)){
echo $ex->innerException->getMessage();
31
exit;
} else {
echo $ex;
exit;
}
}
$response_code = $httpRequest_OBJ->getResponseCode();
if($response_code == "200")
{
//reqeust success
echo $response_code;
echo $httpRequest_OBJ->getResponseBody();
}
else
{
//failure
echo $response_code;
echo $httpRequest_OBJ->getResponseBody();
}
?>
Error Handling for Bad Request (Status Code = 400)
// Do the POST and then close the session
$response = curl_exec($session);
curl_close($session);
//The error message will be stored in this variable if it’s a bad request
print $response;
Python Example
The code example below demonstrates how to access Newegg API in Python.
Example: Python, Get Item Price
import httplib2
#import pyodbc
import string
32
all_items_location_id=521799450
# whether to print item data retrieved from database
print_item_data=True
# items data retrieved from database
items=[]
def _put_call(url, xmlfeed):
h = httplib2.Http(".cache",disable_ssl_certificate_validation=True)
resp, content = h.request(url, "POST", body=xmlfeed, headers={'contenttype':'application/xml','Authorization': 'your API-key here', 'Secretkey':'your secretkey here' }
)
print "response header from Newegg:", resp
print "response body from Newegg:", content
def get_price():
header = ''
xmlfeed=[]
xmlfeed.append(header)
xmlfeed.append('')
xmlfeed.append('1 ')
xmlfeed.append('TCR8996 ')
xmlfeed.append(' ')
xmlfeed=string.join(xmlfeed,'')
print "Get item price:"
put_call_url = 'https://api.newegg.com/marketplace/contentmgmt/item/price?sellerid=A006'
_put_call(put_call_url,xmlfeed)
get_price()
33
Error Handling for Bad Request (Status Code = 400)
def _put_call(url, xmlfeed):
h = httplib2.Http(".cache",disable_ssl_certificate_validation=True)
resp, content = h.request(url, "POST", body=xmlfeed, headers={'contenttype':'application/xml','Authorization': 'your API-key here', 'Secretkey':'your secretkey here' }
)
print "response header from Newegg:", resp
#The error message will be stored in this variable if it’s a bad request
print "response body from Newegg:", content
8. Service Status
Newegg Marketplace API provides an interface in every major service group to allow you to check whether the service you
are invoking is available or not. Each major service group is listed in the Parameters section, domain field description.
8.1. Get Service Status
Return each major service group’s availability.
8.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/{domain}/servicestatus?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
domain
Yes
Major Service Groups Options:
-
contentmgmt
-
ordermgmt
-
datafeedmgmt
-
servicemgmt
-
reportmgmt
-
sellermgmt
-
sbnmgmt
-
shippingservice
34
Sellerid
Yes
Your seller ID on Newegg Marketplace
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
8.1.2. Request Body
Example: XML, Request
GET https://api.newegg.com/marketplace/contentmgmt/servicestatus?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
GET https://api.newegg.com/marketplace/contentmgmt/servicestatus?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
8.1.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify whether the requested service is successful or not. Returns true
OperationType
String
Fixed value: GetServiceStatus
SellerID
String
Your Seller ID
Integer
0.
Service unavailable
1.
Service available
Response Body
NeweggAPIResponse
or false.
Status
Timestamp
String
Request date time (Pacific Standard Time)
Message
String
When service is unavailable (status = 0), this field will provide a detailed
explanation.
35
Example: XML, Service Available Response
XSD
API Schema > SellerMgmt > SellerStatusCheck > GetSellerAccountStatusResponse.xsd
true
GetServiceStatus
A006
1
2/14/2012 9:42:46
Example: Json, Service Available Response
{
"IsSuccess": "true",
"OperationType": "GetServiceStatus",
"SellerID": "A006",
"ResponseBody": {
"Status": "1",
"Timestamp": "2/14/2012 9:42:46"
}
}
Example: XML, Service Unavailable Response
XSD
API Schema > SellerMgmt > SellerStatusCheck > GetSellerAccountStatusResponse.xsd
true
GetServiceStatus
A006
0
36
2/15/2012 14:50:38
The service is unavailable or experiencing extremely high error rates.
Example: Json, Service Unavailable Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"OperationType": "GetServiceStatus",
"SellerID": "A006",
"ResponseBody": {
"Status": "0",
"Timestamp": "2/15/2012 2:50:38",
"Message": "The service is unavailable or experiencing extremely high error rates."
}
}
}
8.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
CE001
SellerID cannot be null or empty
Example: Json, Response
{
"Code": "CE001",
37
"Message": "SellerID cannot be null or empty"
}
8.2. Failover Endpoints for API Service
To avoid any downtime caused by network, failover endpoints are available for accessing Newegg API services:
https://api.newegg.com (Primary)
https://api01.newegg.com
https://api02.newegg.com
The first listed endpoint should be configured as the primary and all other endpoints are treated as backups. Please
configuring your requests always sent only to the primary endpoint: http://api.newegg.com. If the primary endpoint fails,
please redirect your requests to the next active endpoint. For best performance, you should always switches back to the
primary endpoint as soon as it becomes available.
To check the current status of all available endpoints, please visit: http://www.newegg.com/sellers/EndpointTest.html
38
9. Item Management
The Item Management service group contains functions that will allow you to perform simple item related updates such as Update Item
Inventory, Price, Shipping and Status.
For item creation / information update (creating an item listing for the seller, updating item listing for the seller such as item description,
item title, item detailed properties and values), please refer to DataFeed Management section and refer to ITEM_DATA attribute type.
9.1. Manufacturer Lookup
Query available manufacturer list from Newegg.
9.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/manufacturer/manufacturerinfo?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
9.1.2. Request Body
Attribute
PageIndex
RequestBody
NeweggAPIRequest
OperationType
Required?
Format
Description
Yes
String
Fixed value: GetManufacturerRequest
No
Integer
Current page index
If left blank, will use 1 as default.
PageSize
No
Integer
Return records count in one page.
(Max is 100 per page)
If left blank, will use 100 as default.
39
RequestCriteria
CreatedDateFrom
No
String
Filter the manufacturers created after the date.
Please refer to the Acceptable Date Format
CreatedDateTo
No
String
Filter the manufacturers created before the date
Please refer to the Acceptable Date Format
ManufacturerName
No
String
Manufacturer name.
If left blank, will return all manufacturer names.
Example: XML, Request
XSD
API Schema > ContentMgmt > GetManufacturer > GetManufacturerRequest.xsd
PUT
https://api.newegg.com/marketplace/contentmgmt/manufacturer/manufacturerinfo?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetManufacturerRequest
1
10
2013-08-30 14:20:00
2013-08-30 18:20:00
Example: Json, Request
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetManufacturerResponse",
40
"ResponseDate": "2/22/2012 16:51:03",
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"ManufacturerList": {
"Manufacturer": [{
"Name": "sony & wonder",
"IsRestricted": "0",
"MappedNameList": {
"MappedName": "wonder"
}
}, {
"Name": "newegg",
"IsRestricted": "1",
"RestrictedSubcategoryList": {
"Subcategory": [{
"SubcategoryID": "1508",
"SubcategoryName": "Belts & Suspenders"
}, {
"SubcategoryID": "153",
"SubcategoryName": "Buckles"
}]
},
"MappedNameList": {
"MappedName": "test_newegg"
}
}]
}
}
}
9.1.3. Response Body
41
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Manufacturer
lookup is successful
String
Your seller ID
OperationType
String
Fixed value: GetManufacturerResponse
ResponseDate
String
Response date
Memo
String
Additional messages
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageIndex
Integer
Current page index
PageSize
Integer
How many records in a page.
Name
String
Manufacturer Name
IsRestricted
Integer
To identify the manufacturer is restricted or not.
PageInfo
SellerID
0: No
1: Yes
SubcategoryID
Integer
The subcategory ID which the restricted
Subcategory
manufacturer applies on.
RestrictedSubcategoryList
Manufacturer
ManufacturerList
ResponseByody
NeweggAPIResponse
Fixed value: True
This will be empty if the manufacturer restricts
for all subcategories.
SubcategoryName
String
The subcategory name which the restricted
manufacturer applies on.
This will be empty if the manufacturer restricts
for all subcategories.
42
MappedName
String
Mapped manufacturer name.
If you use this mapped name to create a new
item, Newegg will map it to the existing
MappedNameList
manufacturer accordingly.
For example:
Manufacturer Name: SONY
Mapped name:
Sony Ericsson Mobile, Sony Audio/Video, Sony
PlayStation, Sony Creative Software, Sony
Creative Software, Inc
If you use one of the Mapped name to create a
new item, the manufacturer will be replaced with
SONY.
Example: XML, Response
XSD
API Schema > ContentMgmt > GetManufacturer > GetManufacturerResponse.xsd
true
A006
GetManufacturerResponse
2/22/2012 16:51:03
1
1
10
1
0
wonder
1
1508
153
test_newegg
Example: Json, Response
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetManufacturerResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"ManufacturerList": {
"Manufacturer": [
44
{
"Name": "sony & wonder",
"IsRestricted": "0"
},
"MappedNameList": [
"sony & wonder inc."
{
]
"Name": "newegg",
"IsRestricted": "1",
"RestrictedSubcategoryList": {
"Subcategory": [
{
"SubcategoryID": "1508",
"SubcategoryName": "Belts & Suspenders"
},
{
"SubcategoryID": "153",
"SubcategoryName": "Buckles"
}
]
}
}
]
}
},
"ResponseDate": "2/22/2012 16:51:03"
"Memo": ""
}
9.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
CT033
Invalid manufacturer name :{0}.
Example: XML, Response
45
CT033
Invalid manufacturer name: Joe Machine
Example: Json, Response
{
"Code": "CT033",
"Message": "Invalid manufacturer name: Joe Machine"
}
9.2. Manufacturer Lookup for international country
Query available manufacturer list on international country from Newegg.
9.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/manufacturer/manufacturerinfo/V2?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
9.2.2. Request Body
46
Attribute
Requir
Format
Description
Yes
String
Fixed value: GetManufacturerRequest
No
Integer
Current page index
ed?
OperationType
PageIndex
If left blank, will use 1 as default.
PageSize
No
Integer
Return records count in one page.
(Max is 100 per page)
If left blank, will use 100 as default.
RestrictedCountryC
Yes
String
The country where the manufacturer is being restricted to sell
ode
Note: only the ISO standard 3-digit codes are accepted.
following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLibrary/
RequestBody
NeweggAPIRequest
To review the complete list of available values, please download the
International%20Country%20Guide.pdf
CreatedDateF
No
String
Filter the manufacturers created after the date.
rom
Please refer to the Acceptable Date Format
RequestCriteria
CreatedDateT
No
String
Filter the manufacturers created before the date
o
Please refer to the Acceptable Date Format
Manufacturer
Name
No
String
Manufacturer name.
If left blank, will return all manufacturer names.
Example: XML, Request
XSD
API Schema > ContentMgmt > GetManufacturer > GetManufacturerRequestV2.xsd
PUT
https://api.newegg.com/marketplace/contentmgmt/manufacturer/manufacturerinfo/v2?sellerid={SellerI
D}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
47
Content-Type: application/xml
Accept: application/xml
GetManufacturerRequest
1
10
USA
2013-08-30 14:20:00
2013-08-30 18:20:00
Example: Json, Request
PUT
https://api.newegg.com/marketplace/contentmgmt/manufacturer/manufacturerinfo/v2?sellerid={SellerI
D}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetManufacturerRequest",
"RequestBody": {
"PageIndex": "1",
"PageSize": "10",
“RestrictedCountryCode”:”USA”,
"RequestCriteria": {
"CreatedDateFrom": "2013-08-30 14:20:00",
"CreatedDateTo": "2013-08-30 18:20:00",
"ManufacturerName": "sony & wonder"
}
}
}
48
9.2.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Manufacturer
lookup is successful
Fixed value: True
String
Your seller ID
OperationType
String
Fixed value: GetManufacturerResponse
ResponseDate
String
Response date
Memo
String
Additional messages
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageIndex
Integer
Current page index
PageSize
Integer
How many records in a page.
Name
String
Manufacturer Name
IsRestricted
Integer
To identify the manufacturer is restricted or not.
0: No
1: Yes
CountryCode
String
The country where the manufacturer restriction is
Manufacturer
being applied to.
To review the complete list of available values,
please download the following:
https://promotions.newegg.com/Marketplace/Sel
lers/resourceLibrary/International%20Country%2
0Guide.pdf
SubcategoryID
tegoryList
Subcategory
RestrictedSubca
ManufacturerList
ResponseByody
NeweggAPIResponse
PageInfo
SellerID
Integer
The subcategory ID which the restricted
manufacturer applies on.
This will be empty if the manufacturer restricts
for all subcategories.
49
SubcategoryName
String
The subcategory name which the restricted
manufacturer applies on.
This will be empty if the manufacturer restricts
for all subcategories.
MappedName
String
Mapped manufacturer name.
If you use this mapped name to create a new
item, Newegg will map it to the existing
MappedNameList
manufacturer accordingly.
For example:
Manufacturer Name: SONY
Mapped name:
Sony Ericsson Mobile, Sony Audio/Video, Sony
PlayStation, Sony Creative Software, Sony
Creative Software, Inc
If you use one of the Mapped name to create a
new item, the manufacturer will be replaced with
SONY.
Example: XML, Response
XSD
API Schema > ContentMgmt > GetManufacturer > GetManufacturerResponse.xsd
true
A006
GetManufacturerResponse
2/22/2012 16:51:03
1
1
10
1
50
0
USA
wonder
1
USA
1508
153
test_newegg
Example: Json, Response
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetManufacturerResponse",
"ResponseDate": "2/22/2012 16:51:03",
51
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"ManufacturerList": {
"Manufacturer": [{
"Name": "sony & wonder",
"IsRestricted": "0",
“CountryCode”:”USA“,
"MappedNameList": {
"MappedName": "wonder"
}
}, {
"Name": "newegg",
"IsRestricted": "1",
“CountryCode”:”USA“,
"RestrictedSubcategoryList": {
"Subcategory": [{
"SubcategoryID": "1508",
"SubcategoryName": "Belts & Suspenders"
}, {
"SubcategoryID": "153",
"SubcategoryName": "Buckles"
}]
},
"MappedNameList": {
"MappedName": "test_newegg"
}
}]
}
}
}
9.2.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
52
Error Code
Description
CT033
Invalid manufacturer name :{0}.
Example: XML, Response
CT033
Invalid manufacturer name: Joe Machine
Example: Json, Response
{
"Code": "CT033",
"Message": "Invalid manufacturer name: Joe Machine"
}
9.3. Submit Manufacturer Request
Manufacturer is one of the required information for creating new items in Newegg Marketplace. Only pre-defined values
from our system can be used. A complete manufacturer list can be retrieved using Manufacturer Lookup, section 9.4. If the
manufacturer(s) for your items are not available from our system, you can submit new manufacturer creation request to
Newegg Marketplace.
53
9.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/manufacturer/creationrequest?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
100 per min per client
Resource Information
9.3.2. Request Body
Attribute
IssueUser
Required?
Format
Description
No
String
The request issuer’s registered Seller Portal email address.
System will only accept Seller’s registered Seller Portal email
ManufacturerRequest
OperationType
RequestBody
NeweggAPIRequest
addresses. If left blank, default value will be Seller ID.
Yes
String
Fixed value: SubmitManufacturerRequest
Name
Yes
String
Manufacturer name.
URL
No
String
Manufacturer website address.
Example: http://www.domain.com
SupportEmail
No
String
Manufacturer support email address.
SupportPhone
No
String
Manufacturer support phone number.
SupportURL
No
String
Manufacturer support website address
Example: http://support.domain.com
Example: XML, Request
XSD
API Schema > ContentMgmt > AddManufacturer > AddManufacturerRequest.xsd
54
POST https://api.newegg.com/marketplace/contentmgmt/manufacturer/creationrequest?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
SubmitManufacturerRequest
www.sonywonder.com
Example: Json, Request
POST https://api.newegg.com/marketplace/contentmgmt/manufacturer/creationrequest?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "SubmitManufacturerRequest",
"RequestBody": {
"ManufacturerRequest": {
"Name": "sony & wonder",
"URL": "www.sonywonder.com"
}
}
}
9.3.3. Response Body
55
Attribute
IsSuccess
Format
Description
String
Identify the operation of Manufacturer requests
successful
String
Your seller ID
OperationType
String
Fixed value: SubmitManufacturerResponse
ResponseDate
String
The response date
Name
String
Manufacturer Name
RequestDate
String
The submit date.
ManufacturerRequest
SellerID
RequestBody
NeweggAPIResponse
Fixed value: True
Example: XML, Response
XSD
API Schema > ContentMgmt > AddManufacturer > AddManufacturerResponse.xsd
true
A006
SubmitManufacturerResponse
2/22/2012 16:50:03
2/22/2012 16:51:03
Example: Json, Response
{
"IsSuccess": "true",
56
"SellerID": "A006",
"OperationType": "SubmitManufacturerResponse",
"ResponseBody": {
"ManufacturerRequest": {
"Name": "sony & wonder",
"RequestDate": "2/22/2012 16:50:03"
}
},
"ResponseDate": "2/22/2012 16:51:03"
}
9.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
CT034
[MfrName] Error: This Manufacturer is existing! Please use correct manufacturer name "{0}" for your reference.
CT035
[MfrName] Error: The manufacturer "{0}” already exists.
CT036
Require {manufacturer name|manufacturer URL}.
CT037
[MfrSupportPhone] Error: Format Error. Examples: Domestic – 222-222-2222-2222. International – 008612345678EXT1234.
CT038
[MfrName] Error: The manufacturer “{0}” already declined.Please try another manufacturer name.
CT039
[MfrURL] Error:Format Error,For example:http://www.example.com
CT041
[MfrName] Error: The manufacturer "{0}" already existed in another pending request.
CT042
[SupportEmail] Error:Format Error,For example:123@newegg.com
Example: XML, Response
CT035
Sony Error: The manufacturer Sony already exists.
Example: Json, Response
{
"Code": "CT035",
57
"Message": "Sony Error: The manufacturer Sony already exists."
}
9.4. Get Manufacturer Request Status
Check the status for the manufacturer request submitted previously.
9.4.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/manufacturer/creationrequeststatus?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
9.4.2. Request Body
Attribute
ManufacturerList
RequestBody
NeweggAPIRequest
OperationType
ManufacturerName
Required?
Format
Description
Yes
String
Fixed value: GetManufacturerStatusRequest
Yes
String
Manufacturer name.
Example: XML, Request
XSD
API Schema > ContentMgmt > GetManufacturerProcessStatus > GetManufacturerProcessStatusRequest.xsd
58
PUT https://api.newegg.com/marketplace/contentmgmt/manufacturer/creationrequeststatus?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetManufacturerStatusRequest
Example: Json, Request
PUT https://api.newegg.com/marketplace/contentmgmt/manufacturer/creationrequeststatus?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetManufacturerStatusRequest",
"RequestBody": {
"ManufacturerList": {
"ManufacturerName": [
"sony & wonder",
"AWG"
]
}
}
}
9.4.3. Response Body
59
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Manufacturer
lookup is successful
SellerID
String
Your seller ID
OperationType
String
Fixed value: GetManufacturerStatusResponse
ResponseDate
String
The response time.
RequestName
String
Original request manufacturer Name
ApprovedName
String
Approved manufacturer name that should be
Manufacturer
ManufacturerList
used in your request.
ResponseBody
NeweggAPIResponse
Fixed value: True
RequestDate
String
The request date.
Status
String
The manufacturer status.
Available values:
Processing
Approved
Mapped
Declined
ProcessDate
String
Processed date.
DeclineReason
String
The decline reason.
Available when Status = Declined.
Example: XML, Response
XSD
API Schema > ContentMgmt > GetManufacturerProcessStatus > GetManufacturerProcessStatusResponse.xsd
true
A006
GetManufacturerStatusResponse
2/22/2012 16:51:03
Processing
2/21/2012 16:51:03
sony
Approved
2/21/2012 15:51:03
2/21/2012 16:51:03
Declined
2/21/2012 12:51:03
2/21/2012 16:51:03
Example: Json, Response
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetManufacturerStatusResponse",
"ResponseDate": "2/22/2012 16:51:03",
"ResponseBody": {
"ManufacturerList": [
{
"RequestName": "AWG",
"Status": "Processing",
"RequestDate": "2/21/2012 16:51:03"
"ProcessDate": "",
"DeclineReason": ""
61
},
{
"RequestName": "sony & wonder",
"ApprovedName":"sony",
"Status": "Approved",
"RequestDate": "2/21/2012 15:51:03",
"ProcessDate": "2/21/2012 16:51:03",
"DeclineReason": ""
},
{
"RequestName": "Sony vario",
"Status": "Declined",
"RequestDate": "2/21/2012 12:51:03",
"ProcessDate": "2/21/2012 16:51:03",
"DeclineReason": "please provide manufacturer URL"
}
]
}
}
9.4.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
9.5. Volume Discount Creation/Update/Removal
A volume discount is an adjustment to the price of a product based on the quantity of that product in an order. By offering
volume discounts, sellers are able to reward those who purchase a multiple quantity of goods.
Newegg Marketplace volume discount is designed as a 3-tier calculation. Volume discount creation/adjustment can only be
submitted with the following rules:
Purchase Quantity: Minimum Purchase Quantity (If any) ≤ tier-1 < tier-2 < tier-3
Price per Product: Regular Selling Price > tier-1 > tier-2 > tier-3
Shipping setting: tier-1 ≥ tier-2 ≥ tier-3
To specify volume discount for item A as following:
Purchase quantity from 2 to 4 units, the unit price is $10
Purchase quantity from 5 to 9, the unit price is $8
Purchase quantity from 10 and above, the unit price is $5.
62
Volume Discount Structure:
Examples of
Examples of
Acceptable Shipping Setting
Unacceptable Shipping Setting
Tier
Quantity
Price/ Product
1
2
$10.00
Default
Default
Default
Free
Default
Free
2
5
$8.00
Default
Default
Free
Default
Free
Default
3
10
$5.00
Default
Free
Free
Default
Default
Free
NOTE:
Volume discount setting will not be available for customers if an ongoing promotion price is less than the
1st -tier unit price.
Only available for shipping destination as United States.
9.5.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/volumediscount?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
100 per min per client
Resource Information
9.5.2. Request Body
Attribute
OperationType
Required?
Format
Description
Yes
String
Fixed value:
SellerPartNumber
No, if
String
Seller Part#
String
NE Item#
NeweggItemNumber
tInfo
ItemVolumeDiscoun
t
RequestBody
NeweggAPIRequest
SubmitVolumeDiscountReques
NeweggItemNumber
is provided.
No, if
SellerPartNumber is
provided.
63
VolumeActivation
Yes
String
Two action values are available:
True: Add / Update
False: Remove.
The default setting is "True".
You may set it to "False" if you
wish to remove the existing
volume discount.
DiscountSetting
Tier
Priority
Yes
Integer
Set the tier for the volume
discount.
Quantity
Yes
Integer
Set the quantity for the tier's
volume discount.
SellingPrice
Yes
decimal
Set the unit price for the tier's
volume discount.
EnableFreeShipping
Yes
Integer
Set a shipping method for the
tier's volume discount. The
acceptable shipping method:
0: Default
1: Free
Example: XML, Request
XSD
API Schema > ContentMgmt > SubmitVolumeDiscount > SubmitVolumeDiscountRequest.xsd
POST https://api.newegg.com/marketplace/contentmgmt/item/volumediscount?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
9SIA0010287920
true
1
12
64
110
0
2
20
105
0
Example: Json, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/volumediscount?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "",
"RequestBody": {
"ItemVolumeDiscountInfo": {
"NeweggItemNumber": "9SIA0010287920",
"VolumeActivation": "true",
"DiscountSetting": {
"Tier": [
{
"Priority": "1",
"Quantity": "12",
"SellingPrice": "110",
"EnableFreeShipping": "0"
},
{
"Priority": "2",
"Quantity": "20",
"SellingPrice": "105",
"EnableFreeShipping": "0"
65
}
]
}
}
}
}
9.5.3. Response Body
Attribute
IsSuccess
Format
Description
String
Identify the operation of
Manufacturer requests
successful
SellerID
String
Your seller ID
OperationType
Fixed value:
OperationType
SellerPartNumber
String
Seller Part#
NeweggItemNumber
String
NE Item#
Priority
Integer
The tier for the volume discount.
Quantity
Integer
The quantity for the tier's volume
discount.
Tier
DiscountSetting
ItemVolumeDiscountInfo
SubmitVolumeDiscountRespons
RequestBody
NeweggAPIResponse
Fixed value: True
SellingPrice
decimal
The unit price for the tier's
volume discount.
EnableFreeShipping
Integer
The shipping method for the
tier's volume discount.
Example: XML, Response
XSD
API Schema > ContentMgmt > SubmitVolumeDiscount > SubmitVolumeDiscountResponse.xsd
true
SubmitVolumeDiscountResponse
a001
66
B0147001
9SIA0010287920
1
12
110
0
2
20
105
0
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "SubmitVolumeDiscountResponse",
"SellerID": "a001",
"ResponseBody": {
"ItemVolumeDiscountInfo": {
"SellerPartNumber": "B0147001",
"NeweggItemNumber": "9SIA0010287920",
"DiscountSetting": {
"Tier": {
"Priority": "1",
"Quantity": "12",
"SellingPrice": "110",
"EnableFreeShipping": "0"
},
"Tier": {
"Priority": "2",
67
"Quantity": "20",
"SellingPrice": "105",
"EnableFreeShipping": "0"
}
}
}
}
}
9.5.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
CT001
Invalid ItemNumber
CT002
Invalid SellerPartNumber
CT058
Invalid 1st tier quantity. Item has minimum quantity, the 1st tier quantity should be an integer and greater than
or equal to minimum quantity [{0}]
CT059
Item number or seller part# is required.
CT060
Not found. The requested item does not have volume discount yet.
CT061
The volume quantity must following this condition: 1 pc < 1st Qty < 2nd Qty < 3rd Qty {0}.
CT062
The volume price must following this condition: general selling price > 1st Price > 2nd Price > 3rd Price
{0}.
CT063
Invalid shipping method on {0}.
CT064
The tiers of volume discount are fractured please set from tier 1 one by one.
CT066
Item had been restricted, you cannot add volume discount.
Example: XML, Response
CT001
Invalid ItemNumber
Example: Json, Response
{
68
"Code": "CT001",
"Message": "Invalid ItemNumber"
}
9.6. Get Volume Discount Request Result
9.6.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/volumediscount?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
100 per min per client
Resource Information
9.6.2. Request Body
OperationType
RequestBody
NeweggAPIRequest
Attribute
SellerPartNumber
Required?
Format
Description
Yes
String
Fixed value: GetVolumeDiscountRequest
No, if NeweggItemNumber is
String
Seller Part#
String
NE Item#
provided.
NeweggItemNumber
No, if SellerPartNumber is provided.
Example: XML, Request
XSD
API Schema > ContentMgmt > GetVolumeDiscount > GetVolumeDiscountRequest.xsd
PUT https://api.newegg.com/marketplace/contentmgmt/item/volumediscount?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
69
Content-Type: application/xml
Accept: application/xml
GetVolumeDiscountRequest
9SIA0010287920
Example: Json, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/volumediscount?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetVolumeDiscountRequest",
"RequestBody": {
"NeweggItemNumber": "9SIA0010287920"
}
}
9.6.3. Response Body
Attribute
IsSuccess
Format
Description
String
Identify the operation of
Manufacturer request is successful
SellerID
String
Your seller ID
OperationType
Fixed value:
OperationType
Seller Part#
NeweggItemNumber
String
NE Item#
Priority
Integer
The tier for the volume discount.
Quantity
Integer
The quantity for the tier's volume
Tier
String
Setting
SellerPartNumber
Discount
untInfo
ItemVolumeDisco
GetVolumeDiscountResponse
RequestBody
NeweggAPIResponse
Fixed value: True
discount.
70
SellingPrice
decimal
The unit price for the tier's volume
discount.
EnableFreeShipping
Integer
The shipping method for the tier's
volume discount.
Example: XML, Response
XSD
API Schema > ContentMgmt > GetVolumeDiscount > GetVolumeDiscountResponse.xsd
true
GetVolumeDiscountResponse
a001
B0147001
9SIA0010287920
1
12
110
0
2
20
105
0
Example: Json, Response
71
{
"IsSuccess": "true",
"OperationType": "GetVolumeDiscountResponse",
"SellerID": "a001",
"ResponseBody": {
"ItemVolumeDiscountInfo": {
"SellerPartNumber": "B0147001",
"NeweggItemNumber": "9SIA0010287920",
"DiscountSetting": {
"Tier": {
"Priority": "1",
"Quantity": "12",
"SellingPrice": "110",
"EnableFreeShipping": "0"
},
"Tier": {
"Priority": "2",
"Quantity": "20",
"SellingPrice": "105",
"EnableFreeShipping": "0"
}
}
}
}
}
9.6.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
CT001
Invalid ItemNumber
CT002
Invalid SellerPartNumber
CT059
Item number or seller part# is required.
CT060
Not found. The requested item does not have volume discount yet.
Example: XML, Response
72
CT001
Invalid ItemNumber
Example: Json, Response
{
"Code": "CT001",
"Message": "Invalid ItemNumber"
}
9.7. Get Item Inventory
Tracking the inventory quantity of items in all registered warehouses around the world, including the United States.
9.7.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
9.7.2. Request Body
Condition
Criteria
ContentQuery
Attribute
Required?
Format
Description
No
Integer
Available values:
1: New
2: Refurbished
3: Used – Like New
73
4: Used – Very Good
5: Used – Good
6: Used – Acceptable
Only applies if type = [2-UPC code]. If type does not = [2-UPC code],
then this column will be disregarded.
If left blank, default value will be New.
Type
Yes
Integer
0: NE Item#
1: Seller Part#
2: UPC Code
Value
String
A string according to the specified value of Type
No
String
The ISO standard 3-digit codes of the country where your warehouse is
WarehouseList
WarehouseLocation
Yes
located. Please download the following to review details:
http://promotions.newegg.com/marketplace/sellers/resourceLibrary/I
nternational%20Country%20Guide.pdf
If left blank, default value will be All.
Example: XML, Request
XSD
API Schema > ContentMgmt > GetInventory > GetInventoryRequest.xsd
PUT
https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1
A006testitem201201021459
USA
AUS
74
Example: Json, Request
PUT
https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"Type": "1",
"Value": "A006testitem201201021459",
"WarehouseList": {
"WarehouseLocation": [
"USA",
"AUS"
]
}
}
9.7.3. Response Body
Attribute
Format
Description
SellerId
String
Your seller ID
ItemNumber
String
Newegg item number
SellerPartNumber
String
Seller part number
String
The ISO standard 3-digit codes of the country where your
warehouse is located. Please download the following to review
details:
Inventory
InventoryAllocation
InventoryResult
WarehouseLocation
http://promotions.newegg.com/marketplace/sellers/resourceLibr
ary/International%20Country%20Guide.pdf
FulfillmentOption
String
Available values:
0: ShipBySeller
1: ShipByNewegg
AvailableQuantity
Integer
Current available inventory in this warehouse.
75
WarehouseCode
String
Indicates the inventory is currently stored in which Newegg
warehouse.
Available values:
06: Tennessee Bulk Warehouse
07: California Small Warehouse
10: New Jersey Bulk Warehouse
Warehouse
WarehouseAllocation
08: California Bulk Item Warehouse
12: Tennessee Small Warehouse
14: New Jersey Small Warehouse
Note: this information will be returned only when the inventory
is currently stored in Newegg’s warehouse.
Quantity
Integer
Current available inventory in this Newegg warehouse.
Note: this information will be returned only when the inventory
is currently stored in Newegg’s warehouse.
Example: XML, Response
XSD
API Schema > ContentMgmt > GetInternationalInventory > GetInventoryResponse.xsd
A006
9SIA0060884598
A006testitem201201021459
USA
0
107
USA
1
40
76
07
3
12
37
AUS
0
0
Example: Json, Response
{
"SellerID": "A006",
"ItemNumber": "9SIA0060884598",
"SellerPartNumber": "A006testitem201201021459",
"InventoryAllocation": {
"Inventory": [
{
"WarehouseLocation": "USA",
"FulfillmentOption": "0",
"AvailableQuantity": "107"
},
{
"WarehouseLocation": "USA",
"FulfillmentOption": "1",
"AvailableQuantity": "40",
"WarehouseAllocation": {
"Warehouse": [
{
"WarehouseCode": "07",
"Quantity": "3"
},
77
{
"WarehouseCode": "12",
"Quantity": "37"
}
]
}
},
{
"WarehouseLocation": "AUS",
"FulfillmentOption": "0",
"AvailableQuantity": "0"
}
]
}
}
9.7.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
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
No data found
Example: XML, Response
CT002
Invalid SellerPartNumber
78
Example: Json, Response
{
"Code": "CT002",
"Message": "Invalid SellerPartNumber"
}
9.8. Get Item Price
Tracking the price related information of items for destination countries, including the United States.
9.8.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/international/price?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
9.8.2. Request Body
Attribute
Type
Required?
Format
Description
Yes
Integer
0: NE Item#
ContentQueryCriteria
1: Seller Part#
2: UPC Code
Value
Yes
String
A string according to a given inquiry type
Condition
No
Integer
Available values:
1: new
2: Refurbished
3: Used – Like New
4: Used – Very Good
5: Used – Good
6: Used – Acceptable
79
Only applies if type = [2-UPC code]. If type does not = [2-UPC
code], then this column will be disregarded.
If left blank, default value will be 1: New.
CountryCode
No
String
The ISO standard 3-digit codes of the country where your
CountryList
warehouse is located. Please download the following to review
details:
http://promotions.newegg.com/marketplace/sellers/resourceLi
brary/International%20Country%20Guide.pdf
If left blank, default value will be All.
Example: XML, Request
XSD
API Schema > ContentMgmt > GetPrice > GetPriceRequest.xsd
PUT https://api.newegg.com/marketplace/contentmgmt/item/international/price?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1
A006testitem201201021459
USA
AUS
Example: Json, Request
PUT https://api.newegg.com/marketplace/contentmgmt/item/international/price?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
80
{
"Type": "1",
"Value": "A006testitem201201021459",
"CountryList": {
"CountryCode": [
"USA",
"AUS"
]
}
}
9.8.3. Response Body
Attribute
Format
Description
SellerId
String
Your seller ID
ItemNumber
String
Newegg item number
SellerPartNumber
String
Seller part number
String
The ISO standard 3-digit codes of the country where your warehouse is
CountryCode
located. Please download the following to review details:
http://promotions.newegg.com/marketplace/sellers/resourceLibrary/Intern
ational%20Country%20Guide.pdf
String
The currency is to identify the Selling Price, MSRP, 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:
Price
PriceList
PriceResult
Currency
http://promotions.newegg.com/marketplace/sellers/resourceLibrary/Intern
ational%20Country%20Guide.pdf
Active
Integer
0: Inactive
1: Active
MSRP
Decimal
The manufacturer’s suggested retail price
MAP
Decimal
Minimum Advertised Price. If the Selling Price is below the defined MAP,
website will ask customer to add item to shopping cart to see the item's
price.
81
CheckoutMAP
Integer
0: False
1: True
If Checkout MAP is marked as True, then the website will ask customer to
add item to shopping cart AND go to checkout page to see the item's price.
The MAP value will not be considered. Another words, 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 item to cart and go to checkout to see
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
0: Default
1: Free Shipping
On promotion
Integer,
0: No active Promotion
separated
1: Active promotion with Price Lock
by comma
2: Active Promotion with Promotion Code
3: Active promotion with Auto Add To Cart
4: Active Promotion with Combo
5: Active Promotion with Volume Discount
Example: XML, Response
XSD
API Schema > ContentMgmt > GetPrice > GetPriceResponse.xsd
A006
9SIA0060884598
A006testitem201201021459
USA
USD
0
30.98
0
20.92
1
82
1,5
IND
INR
1
459.98
0
389.92
0
1,5
IRL
EUR
0
30.98
0
19.92
0
Example: Json, Response
{
"SellerID": "A006",
"ItemNumber": "9SIA0060884598",
"SellerPartNumber": "A006testitem201201021459",
"PriceList": {
"Price": [
{
"CountryCode": "USA",
"Currency": "USD",
"Active": "0",
83
"MSRP": "30.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "20.92",
"EnableFreeShipping": "1",
"OnPromotion": "1,5"
},
{
"CountryCode": "IND",
"Currency": "INR",
"Active": "1",
"MSRP": "459.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "389.92",
"EnableFreeShipping": "0",
"OnPromotion": "1,5"
},
{
"CountryCode": "IRL",
"Currency": "EUR",
"Active": "0",
"MSRP": "30.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "19.92",
"EnableFreeShipping": "0"
}
]
}
}
9.8.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
CT001
Invalid ItemNumber
CT002
Invalid SellerPartNumber
84
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
No data found
Example: XML, Response
CT002
Invalid SellerPartNumber
Example: Json, Response
{
"Code": "CT002",
"Message": "Invalid SellerPartNumber"
}
9.9. Update Item Inventory
Maintaining the inventory quantity of items in all registered warehouses around the world, including the United States.
9.9.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
300 per min per client
Resource Information
85
9.9.2. Request Body
Attribute
Type
Required?
Format
Description
Yes
Integer
Available values:
0: NE Item #
1: Seller Part #
2: UPC
Value
Yes
String
A string according to inquiry type
Condition
No
Integer
Available values:
1: New (default)
2: Refurbished
ItemInventoryInfo
3: Used – Like New
4: Used – Very Good
5: Used – Good
6: Used – Acceptable
Only applies if type = [2-UPC code]. If type does not = [2-UPC code],
then this column will be disregarded.
WarehouseLocation
Yes
String
The ISO standard 3-digit codes of the country where your
details:
Inventory
InventoryList
warehouse is located. Please download the following to review
http://promotions.newegg.com/marketplace/sellers/resourceLibra
ry/International%20Country%20Guide.pdf
NOTE: Submissions with incorrect values will error-out.
AvailableQuantity
Yes
Integer
Current available inventory in this warehouse.
Example: XML, Request
XSD
API Schema > ContentMgmt > UpdateInventory > UpdateInventoryRequest.xsd
POST
https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/xml
Content-Type: application/xml
86
1
A006BSP3
USA
107
AUS
0
Example: Json, Request
POST
https://api.newegg.com/marketplace/contentmgmt/item/international/inventory?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/json
Content-Type: application/json
{
"Type": "1",
"Value": "A006BSP3",
"InventoryList": {
"Inventory": [
{
"WarehouseLocation": "USA",
"AvailableQuantity": "107"
},
{
"WarehouseLocation": "AUS",
"AvailableQuantity": "0"
}
]
}
}
87
9.9.3. Response Body
Format
Description
SellerID
String
Your seller ID
ItemNumber
String
Newegg item number
SellerPartNumber
String
Seller Part Number
String
The ISO standard 3-digit codes of the country where your warehouse is
WarehouseLocation
located. copy
Inventory
InventoryList
UpdateInventoryResult
Attribute
link to your browser to review details:
http://promotions.newegg.com/marketplace/sellers/resourceLibrary/In
ternational%20Country%20Guide.pdf
AvailableQuantity
Integer
Current available inventory in this warehouse.
Example: XML, Response
XSD
API Schema > ContentMgmt > UpdateInventory > UpdateInventoryResponse.xsd
A006
9SIA00607Y6476
A006BSP3
USA
107
AUS
0
Example: Json, Response
{
"SellerID": "A006",
88
"ItemNumber": "9SIA00607Y6476",
"SellerPartNumber": "A006BSP3",
"InventoryList": {
"Inventory": [
{
"WarehouseLocation": "USA",
"AvailableQuantity": "107"
},
{
"WarehouseLocation": "AUS",
"AvailableQuantity": "0"
}
]
}
}
9.9.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
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.
CT014
SellerItemNumber or SellerPartNumber does not exist
CT015
Item does not belong to this seller
CT023
Inventory value must be between 0 and 999999
CT025
This item is an approved promotion and its minimum inventory cannot be lower than {0}
CT055
This is a duplicated request for Seller Part #: [seller part #]. This item does not exist in Newegg so we are not able
to process your request. We will resume the process of price and inventory update for this item 8 hours after [last
failed timestamp].
CT073
The request for item: { SellerPart#} has been processed with error.Country: [country1,country2] Failed reason: The
specified warehouse location has not been setup yet. Please set up your warehouse(s) then submit your request
again,
Example: XML, Response
89
CE003
The 'Type' element is invalid - The value 'a' is invalid according to its
datatype 'Int' - The string 'a' is not a valid Int32 value.
Example: Json, Response
{
"Code": "CT002",
"Message": "Invalid SellerPartNumber"
}
9.10. Update Item Price
Maintaining the price of items in all eligible countries, including the United States.
9.10.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/international/price?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
300 per min per client
Resource Information
90
9.10.2. Request Body
Attribute
Type
Required?
Format
Description
Yes
Integer
Available values:
0: NE Item #
1: Seller Part #
2: UPC
Value
Yes
String
A string according to inquiry type
Condition
No
Integer
Available values:
1: New (default)
2: Refurbished
3: Used – Like New
4: Used – Very Good
5: Used – Good
6: Used – Acceptable
Only applies if type = [2-UPC code]. If type does not = [2-UPC code],
then this column will be disregarded.
CountryCode
Yes
String
The target country you will be selling your items to. Only the ISO
ItemPriceInfo
standard 3-digit codes are accepted.
To review the complete list of available values, please download
the following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLib
rary/International%20Country%20Guide.pdf
NOTE: Item price must be submitted with the correct currency
code based on ship-to destination country code. Submissions with
Price
PriceList
incorrect combinations will error-out.
Currency
Yes
String
The currency is to identify the Selling Price, MSRP, MAP for the
target country you will be selling your items to. Only the ISO
standard 3-digit codes are accepted.
To review the complete list of available values, please download the
following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLib
rary/International%20Country%20Guide.pdf
NOTE: Correct currency code must be submitted based on ship-to
destination country code. Submissions with incorrect combinations
will error-out.
91
Active
No
Integer
Available values:
1: Activate item
0: Deactivate item
Null = Ignore this action, no change to current item
active/deactivate setting
MSRP
No
Decimal
The manufacturer’s suggested retail price
MAP
No
Decimal
Minimum Advertised Price. If the Selling Price is below the defined
MAP, website will ask customer to add item to shopping cart to
see the item's price.
CheckoutMAP
No
Integer
Available values:
0: False
1: True
If Checkout MAP is marked as True, then the website will ask
customer to add item to shopping cart AND go to checkout page
to see the item's price. The MAP value will not be considered.
Another words, 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 item to cart and go to checkout to see item's price.
If MAP is greater than 0.00 and CheckoutMAP is left blank, by
default CheckoutMAP will equal False.
SellingPrice
No
Decimal
The actual selling price
EnableFreeShipping
No
Integer
Available values:
0: Default
1: Free Shipping
Example: XML, Request
XSD
API Schema > ContentMgmt > UpdatePrice > UpdatePriceRequest.xsd
POST https://api.newegg.com/marketplace/contentmgmt/item/international/price?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/xml
Content-Type: application/xml
92
1
A006BSP3
USA
USD
0
30.98
0
20.92
1
IND
INR
1
459.98
0
389.92
0
IRL
EUR
0
30.98
0
19.92
0
Example: Json, Request
POST
https://api.newegg.com/marketplace/contentmgmt/item/inventoryandprice?sellerid={SellerID}&version
=304
93
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/json
Content-Type: application/json
{
"Type": "1",
"Value": "A006BSP3",
"PriceList": {
"Price": [
{
"CountryCode": "USA",
"Currency": "USD",
"Active": "0",
"MSRP": "30.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "20.92",
"EnableFreeShipping": "1"
},
{
"CountryCode": "IND",
"Currency": "INR",
"Active": "1",
"MSRP": "459.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "389.92",
"EnableFreeShipping": "0"
},
{
"CountryCode": "IRL",
"Currency": "EUR",
"Active": "0",
"MSRP": "30.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "19.92",
"EnableFreeShipping": "0"
}
]
94
}
}
9.10.3. Response Body
Attribute
Format
Description
SellerID
String
Your seller ID
ItemNumber
String
Newegg item number
SellerPartNumber
String
Seller Part Number
String
The target country you will be selling your items to. Newegg will return
CountryCode
the value in ISO standard 3-digit codes.
To review the complete list of available values, please download the
following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLibrary/Int
ernational%20Country%20Guide.pdf
Currency
String
The currency is to identify the Selling Price, MSRP, MAP for the target
country you will be selling your items to. Newegg will return the value in
To review the complete list of available values, please download the
following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLibrary/Int
ernational%20Country%20Guide.pdf
Price
PriceList
UpdatePriceResult
ISO standard 3-digit codes.
Active
Integer
Available values:
0: Inactive
1: Active
MSRP
Decimal
The manufacturer’s suggested retail price
MAP
Decimal
Minimum Advertised Price. If the Selling Price is below the defined MAP,
website will ask customer to add item to shopping cart to see the item's
price.
CheckoutMAP
Integer
Available values:
0: False
1: True
If Checkout MAP is marked as True, then the website will ask customer to
add item to shopping cart AND go to checkout page to see the item's
price. The MAP value will not be considered. Another words, if this field is
marked as true, it doesn't matter if the selling price is above or below
95
MAP, the customer will always need to add item to cart and go to
checkout to see 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
Example: XML, Response
XSD
API Schema > ContentMgmt > UpdatePrice > UpdatePriceResponse.xsd
A006
9SIA00607Y6476
A006BSP3
USA
USD
0
30.98
0
20.92
1
IND
INR
1
459.98
0
389.92
0
96
IRL
EUR
0
30.98
0
19.92
0
Example: Json, Response
{
"SellerID": "A006",
"ItemNumber": "9SIA00607Y6476",
"SellerPartNumber": "A006BSP3",
"PriceList": {
"Price": [
{
"CountryCode": "USA",
"Currency": "USD",
"Active": "0",
"MSRP": "30.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "20.92",
"EnableFreeShipping": "1"
},
{
"CountryCode": "IND",
"Currency": "INR",
"Active": "1",
"MSRP": "459.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "389.92",
"EnableFreeShipping": "0"
97
},
{
"CountryCode": "IRL",
"Currency": "EUR",
"Active": "0",
"MSRP": "30.98",
"MAP": "25.99",
"CheckoutMAP": "0",
"SellingPrice": "19.92",
"EnableFreeShipping": "0"
}
]
}
}
9.10.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
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
CT004
Item under review, you cannot activate.
CT006
Invalid MSRP. The range should be between 0-99999.99
CT007
Invalid Selling Price. The range should be between 0-99999.99
CT008
Invalid Shipping type. We only support: 0 - default, 1 - free shipping
CT009
Cannot activate item by restricted manufacturer - {0}[({1}){2}].
CT010
Cannot find item with specified item condition.
CT014
SellerItemNumber or SellerPartNumber does not exist
CT015
Item does not belong to this seller
CT016
The item: [SellerPart#] is locked for an on-going/upcoming promotion. CANNOT update the Shipping. Please
note: the inventory or minimum purchase quantity update will NOT be affected.
CT019
The item: [SellerPart#] is locked for an on-going/upcoming promotion. CANNOT update the Selling Price. Please
note: the inventory or minimum purchase quantity update will NOT be affected.
CT028
Invalid Active Mark. We only support: 0 - deactivate item, 1 - activate item
CT029
The selling price {selling price} cannot be greater than MSRP {MSRP}.
CT030
MAP price should be decimal with 2 digitals. The range should be between 0-99999.99.
98
CT031
Invalid CheckoutMAP value. We only support: 0 - False, 1 – True.
CT032
The selling price cannot be 0.
CT043
The item cannot be active because of one of the following reasons:1.Does not exist 2.Breaks the price rule 3.No
image
CT044
The item cannot be deactivated because of an on-going/upcoming promotion that is locked by Newegg. Please
note: the inventory or minimum purchase quantity update will NOT be affected.
CT045
Item was automatically deactivated due to 7 days out of stock and cannot be reactivated with 0 inventory.
CT050
Item Activation Failed. Strict MAP enforced: ${0} – Selling Price must be greater than or equal to strict MAP. Please
contact your account manager for more information.
CT052
This item cannot be activate because of the subcategory had been disabled for your account.
CT053
This item now matches a restricted item and cannot be activated. All other updates will be processed.
CT055
This is a duplicated request for Seller Part #: [seller part #]. This item does not exist in Newegg so we are not able
to process your request. We will resume the process of price and inventory update for this item 8 hours after [last
failed timestamp].
CT065
Invalid Selling Price. The Selling Price should be greater than the existing 1st tier volume discount unit price: [{0}]
CT067
The item: [SellerPart#] is regulated by a Newegg existing MAP (Minimum Advertised Pricing) setting: MAP =
[amount], Checkout MAP = [status]. When MAP amount is great than 0 or Checkout MAP = True, the attempt to
change either MAP or Checkout MAP is restricted. All other requests have been processed.
CT071
The Inventory update for item: [SellerPart#] cannot be processed because of the warehouse: [warehouselocation]
has not been created.
CT075
Price update failed. Invalid currency code. The currency code received: [code] does not match the specified country:
[code].
CT076
Item cannot be activated for specified country: [code]. Please activate the country, then submit your request again.
CT092
The request for item: {Seller Part #} has been processed with error. Error: You have reached the maximum allowance
of listing: [limit #] items. To list more, please optimize your listings. To increase the allowance, please upgrade your
service. Country(s): [code1, code 2, ….code #]
CT096
FREE SHIPPING is not available for NISP (Newegg International Shipping Program). For free domestic shipping,
please update your shipping settings in Seller Portal.
CT097
Item shipping dimensions do not meet the limits of NISP (Newegg International Shipping Program).
Example: XML, Response
CE003
99
The 'Type' element is invalid - The value 'a' is invalid according to its
datatype 'Int' - The string 'a' is not a valid Int32 value.
Example: Json, Response
{
"Code": "CT002",
"Message": "Invalid SellerPartNumber"
}
9.11. Submit Item Warranty Request
Specifying warranty services on refurbished items selling on Newegg Marketplace.
9.11.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/contentmgmt/item/warranty?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
300 per min per client
Resource Information
9.11.2. Request Body
Required?
Format
Description
Yes
String
Fixed value:
est
OperationType
APIRequ
Newegg
Attribute
ActionType
SubmitItemWarrantyRequest
Yes
Integer
Available values:
100
0: Create Warranty
1: Update Warranty
2: Delete Warranty
ItemManufacturerWarrantyID
No
Integer
Warranty
ID.
When
updating
and
deleting warranty, if warranty id is 0, we
will
find
the
warranty
by
SellerPartNumber and CountryCode.
SellerPartNumber
Yes
String
Seller Part #
PartsDay
No
Integer
Parts Day, 0-99999. You can set Parts Days
warranty.
ItemWarranty
ItemWarrantyList
RequestBody
as "99999" to indicate a lifetime
LaborDay
No
Integer
Labor Day, 0-99999. You can set Labor
Days as "99999" to indicate a lifetime
warranty.
ServiceProvider
Yes
String
Service Provider Name
ProviderSupportEmail
Yes
String
Warranty support email address.
ProviderSupportURL
No
String
Warranty support URL
ProviderCustomerServicePhone
Yes
String
Warranty
Customer
Service
phone
number. Please use NANP phone number
format.
Example: 234-235-5678.
CountryCode
Yes
String
Ship to country. Fixed Value: USA
ApplyToAllCountryCode
Yes
Boolean
Fixed value: false.
Example: XML, Request
XSD
API Schema > ContentMgmt > ItemWarranty > ItemWarrantyRequest.xsd
POST https://api.newegg.com/marketplace/contentmgmt/item/warranty?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/xml
Content-Type: application/xml
101
SubmitItemWarrantyRequest
0
0
bg9h2016042003
10
10
Test
test@newegg.com
http://www.sohnen.com/CustomerSupport.aspx
562-946-3531
USA
false
0
bg9h2016042001
10
10
Test
test@newegg.com
562-946-3531
USA
false
Example: Json, Request
POST https://api.newegg.com/marketplace/contentmgmt/item/warranty?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/json
Content-Type: application/json
102
{
"OperationType": "SubmitItemWarrantyRequest",
"ActionType": 0,
"RequestBody": {
"ItemWarrantyList": [
{
"ItemWarranty": [
{
"ItemManufacturerWarrantyID": 0,
"SellerPartNumber": "bg9h2016042003",
"PartsDay": 10,
"LaborDay": 10,
"ServiceProvider": "Test",
"ProviderSupportEmail": "test@newegg.com",
"ProviderSupportURL": "http://www.sohnen.com/CustomerSupport.aspx",
"ProviderCustomerServicePhone": "562-946-3531",
"CountryCode": "USA",
"ApplyToAllCountryCode": "false"
},
{
"ItemManufacturerWarrantyID": 0,
"SellerPartNumber": "bg9h2016042001",
"PartsDay": 10,
"LaborDay": 10,
"ServiceProvider": "Test",
"ProviderSupportEmail": "test@newegg.com",
"ProviderSupportURL": null,
"ProviderCustomerServicePhone": "562-946-3531",
"CountryCode": "USA",
"ApplyToAllCountryCode": "false"
}
]
}
]
}
}
9.11.3. Response Body
103
Attribute
IsSuccess
Format
Description
Boolean
Used to identify the operation is successful. Always returns
String
Fixed value: SubmitItemWarrantyResponse.
SellerID
String
Your seller ID.
Boolean
Used to identify the warranty is processed successful.
ErrorCode
String
Error Code.
ErrorMessage
String
The description of the error code.
ResponseDate
String
The response time.
ResponseMessage
String
If all warranty settings processed successfully, return fixed
Error
ErrorList
IsSuccess
ItemWarranty
ItemWarrantyList
OperationType
ResponseBody
NewegAPIResponse
true.
value:
"You have successfully submitted third-party warranty
settings. It may take up to 10 minutes for your settings to
propagate to all systems."
Example: XML, Response
true
SubmitItemWarrantyResponse
BG9H
true
false
CT507
'Provider Support URL' is not in the correct
format.
104
04/28/2016 02:48:29
Example: Json, Response
{
"ResponseDate": "05/03/2016 15:48:09",
"IsSuccess": true,
"OperationType": "SubmitItemWarrantyResponse",
"SellerID": "BG8U",
"ResponseBody": {
"ItemWarrantyList": [
{
"IsSuccess": true,
},
{
"IsSuccess": false,
"ErrorList": [
{
"ErrorCode": "CT508",
"ErrorMessage": "SellerPartNumber: bg9h2016042001 does not exist or it is not
refurbished."
}
]
}
]
}
}
9.11.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
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
CT004
Item under review, you cannot activate.
105
CT006
Invalid MSRP. The range should be between 0-99999.99
CT007
Invalid Selling Price. The range should be between 0-99999.99
CT008
Invalid Shipping type. We only support: 0 - default, 1 - free shipping
CT009
Cannot activate item by restricted manufacturer - {0}[({1}){2}].
CT010
Cannot find item with specified item condition.
CT014
SellerItemNumber or SellerPartNumber does not exist
CT015
Can't find this item in the system, please create it first
CT016
The item: [SellerPart#] is locked for an on-going/upcoming promotion. CANNOT update the Shipping. Please
note: the inventory or minimum purchase quantity update will NOT be affected.
CT019
The item: [SellerPart#] is locked for an on-going/upcoming promotion. CANNOT update the Selling Price. Please
note: the inventory or minimum purchase quantity update will NOT be affected.
CT028
Invalid Active Mark. We only support: 0 - deactivate item, 1 - activate item
CT029
The selling price {selling price} cannot be greater than MSRP {MSRP}.
CT030
MAP price should be decimal with 2 digitals. The range should be between 0-99999.99.
CT031
Invalid CheckoutMAP value. We only support: 0 - False, 1 – True.
CT032
The selling price cannot be 0.
CT043
Item with no image cannot be activated. Please update your item with valid image then try again.
CT044
The item cannot be deactivated because of an on-going/upcoming promotion that is locked by Newegg. Please
note: the inventory or minimum purchase quantity update will NOT be affected.
CT045
CT050
Item was automatically deactivated due to 7 days out of stock and cannot be reactivated with 0 inventory.
Item Activation Failed. Strict MAP enforced: ${0} – Selling Price must be greater than or equal to strict MAP. Please
contact your account manager for more information.
CT052
This item cannot be activate because of the subcategory had been disabled for your account.
CT053
This item now matches a restricted item and cannot be activated. All other updates will be processed.
CT055
This is a duplicated request for Seller Part #: [seller part #]. This item does not exist in Newegg so we are not able
to process your request. We will resume the process of price and inventory update for this item 8 hours after [last
failed timestamp].
CT065
Invalid Selling Price. The Selling Price should be greater than the existing 1st tier volume discount unit price: [{0}]
CT067
The item: [SellerPart#] is regulated by a Newegg existing MAP (Minimum Advertised Pricing) setting: MAP =
[amount], Checkout MAP = [status]. When MAP amount is great than 0 or Checkout MAP = True, the attempt to
change either MAP or Checkout MAP is restricted. All other requests have been processed.
CT071
The Inventory update for item: [SellerPart#] cannot be processed because of the warehouse: [warehouselocation]
has not been created.
CT075
Price update failed. Invalid currency code. The currency code received: [code] does not match the specified country:
[code].
CT076
Item cannot be activated for specified country: [code]. Please activate the country, then submit your request again.
CT501
'Seller Part Number' is required.
106
CT502
'Service Provider' is required.
CT504
'Parts Day' and 'Labor Day' should not be equal to 0 at the same time.
CT505
'Provider Support Email' is required.
CT506
'Provider Support Email' is not in the correct format.
CT507
'Provider Support URL' is not in the correct format.
CT508
SellerPartNumber: xxx does not exist.
CT509
"Warranty does not exist in CountryCode: xxx, SellerPartNumber: xxx." Or "Warranty does not exist in CountryCode:
xxx, SellerPartNumber: xxx, ItemManufacturerWarrantyID: xxx."
CT511
'Provider Customer Service Phone' is not in the correct format.
CT512
SellerPartNumber: xxx is not refurbished or used item.
CT513
'Provider Customer Service Phone' is required.
CT514
Warranty exists in CountryCode: xxx, SellerPartNumber: xxx.
Example: XML, Response
CE003
The 'Type' element is invalid - The value 'a' is invalid according to its
datatype 'Int' - The string 'a' is not a valid Int32 value.
Example: Json, Response
{
"Code": "CT002",
"Message": "Invalid SellerPartNumber"
}
107
10. Order Management
The Order Management service group contains functions that will allow you to perform order related operations such as
get order info, status, update order status, remove items, confirm orders… etc.
10.1. Get Order Status
Get the order status by specified the order number of existing order.
10.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={versionno}
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
{ordernumber}
Yes
The order number
version
No
Available version numbers:304
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
10.1.2. Request Body
Example: XML, Rquest
GET
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
108
Example: Json, Request
GET
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
10.1.3. Response Body
Attribute
Format
Description
Available Ver.#
OrderNumber
String
The order number that qualified for your search
All
OrderStatusCode
Integer
The available values of the order status
All
0: Unshipped
1: PartiallyShipped
2: Shipped
3: Invoiced
4: Void
OrderStatusName
String
The description of the status
All
Unshipped for status code: 0
QueryOrderStatusInfo
PartiallyShipped for status code: 1
Shipped for status code: 2
Invoiced for status code: 3
Void for status code: 4
SellerID
String
Your seller ID
All
OrderDownloaded
String
False: Order has not been downloaded yet.
All
True: Order downloaded already.
When order is shipped, this field will automatically
become “True”.
SalesChannel
Integer
Order sales channel:
304
0: Newegg order
1: Multi-channel order
2: Replacement order
FulfillmentOption
Integer
Order fulfillment option:
304
0: Ship by Seller
1: Ship by Newegg
109
Example: XML, Response
XSD
API Schema > OrderMgmt > GetOrderStatus > GetOrderStatusResponse.xsd
159243598
A006
1
PartiallyShipped
true
0
0
Example: Json, Response
{
"OrderDownloaded": true,
"OrderNumber": "159243598",
"OrderStatusCode": 1,
"OrderStatusName": "PartiallyShipped",
"SellerID": "A006",
“SalesChannel”:0,
“FulfillmentOption”:0
}
10.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SO002
Order Number should be an integer (ranging from 1 to 2147483647)
SO003
No data found or this order does not belong to this seller
110
Example: XML, Response
SO002
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SO002",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
10.2. Update Order Status
Update order status by specific order number. Currently support cancel or ship a single order.
10.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={versionno}
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
{ordernumber}
Yes
The order number for the operation
version
Yes
Available version numbers:304
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
111
10.2.2. Request Body
Cancel Order
Attribute
Action
Required?
Format
Description
Yes
Integer
1: Cancel Order
UpdateOrderStatus
Note: SBN order might not be cancelled if the order is
been processing by Newegg Warehouse. Please use
Get SBN Order Cancellation Request Result, section
10.6 to check the status.
Value
Yes
Integer
The cancel reason code:
24: OutOfStock
72: Customer Requested to Cancel
73: PriceError
74: Unable to Fulfill Order
Example: XML, Request (Cancel Order Request Example)
XSD
API Schema > OrderMgmt > UpdateOrder > CancelRequest.xsd
PUT
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept:application/xml
1
24
Example: Json, Request
PUT
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
112
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"Action": "1",
"Value": "24"
}
Ship Order
Ship Order function allows you to update shipment of one or all items in an order. When an order has been completely
fulfilled, mean that all the items are fulfilled, the order process is completed.
Please review the following example and the possible shipment options you can assign for each request:
Order XYZ has item A (5 units) and item B (1 unit)
Single package contains 5 units of item A and 1 unit of item B with one tracking number.
Single package contains either 5 units of item A or 1 unit of item B with one tracking number.
Multiple packages: one package contains 5 units of item A with one tracking number. The other package contains
1 unit of item B with another tracking number.
Multiple packages: one package contains 2 units of item A with one tracking number. Another package contains 3
units of item A with another tracking number. The other package contains 1 unit of item B with another tracking
number.
Multiple packages: one package contains 2 units of item A with one tracking number. The other package contains
3 units of item A and one unit of item B with another tracking number.
You cannot submit a request for partial shipment as following: Single package contains 2 units of item A with
one tracking number.
Required?
Format
Description
Yes
Integer
2: Ship Order
SellerID
Yes
String
Your Seller ID
SONumber
Yes
Integer
Sales order number
Yes
String
Tracking number for the shipped
TrackingNumber
age
ageL
Pack
ist
Header
Pack
Shipment
Action
Value
UpdateOrderStatus
Attribute
package.
113
ShipCarrier
Yes
String
Shipping carrier type, choose from:
UPS
UPS MI
FedEX
DHL
USPS
NOTE: Please specify the ship carrier
name other than above. Please refer
to the following XML formatted
example.
ShipService
Yes
String
Shipping service type, such as air,
ground, etc. Please reference your
Item
ItemList
shipping carrier directly
SellerPartNumber
Yes
String
The Seller Part # of the item(s)
NeweggItemNumber
No
String
Newegg Item Number of the item
ShippedQty
Yes
Integer
Shipped quantity of items. Must be
larger than 0
Example: XML, Request
XSD
API Schema > OrderMgmt > UpdateOrder > ShipmentRequest.xsd
PLEASE NOTE MUST BE ENCLOSED BY , See Example for Detail.
PUT
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
2
A006
159243598
114
lztestA0060001
Other Carrier
Other Service
-
A006ZX-35833
1
]]>
Example: Json, Request
PUT
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/Json
Accept: application/Json
{
"Action": "2",
"Value": {
"Shipment": {
"Header": {
"SellerID": "A006",
"SONumber": "159243598"
},
"PackageList": {
"Package": [
{
"TrackingNumber": "alistestonly1",
"ShipCarrier": "Purolator",
"ShipService": "3-5",
115
"ItemList": {
"Item": {
"SellerPartNumber": "A3WG11002378965412586",
"ShippedQty": "1"}
}
},
{
"TrackingNumber": "alistestonly2",
"ShipCarrier": "Purolator",
"ShipService": "3-5",
"ItemList": {
"Item": [{
"SellerPartNumber": "A3WG11002378965412583",
"ShippedQty": "1"},
{
"SellerPartNumber": "A3WG11002378965412584",
"ShippedQty": "1"}]
}
}]
}
}
}
}
10.2.3. Response Body
Cancel Order
IsSuccess
Format
Description
String
Used to identify the operation of order update is successful
Returns true or false.
Result
sInfo
UpdateOrderStatu
Attribute
OrderNumber
Integer
The order number
SellerID
String
Your Seller ID
116
OrderStatus
String
The order status. The following values are available:
Void – Void successfully.
Processing – Cancellation request has been received and under
processing. This status is ONLY available for the cancellation
request of SBN orders. The final processing result can be
checked using 10.6 Check SBN Order Cancellation Result.
Example: XML, Response
XSD
API Schema > OrderMgmt > UpdateOrder > CancelOrderResponse.xsd
true
159243598
A006
Void
Example: Json, Response
{
"IsSuccess": "true",
"Result": {
"OrderNumber": "159243598",
"SellerID": "A006",
"OrderStatus": "Void"
}
}
Ship Order
IsSuccess
Format
Description
String
Used to identify the operation of order update
y
ar
m
m
ssi
ce
ro
eP
ag
TotalPackageCount
Su
is successful. Always returns true.
ng
derStatusI
Pa nfo
ck
UpdateOr
Attribute
Integer
package(s) count
117
Integer
package(s) processed successfully
FailCount
Integer
package(s) failed to process
OrderNumber
Integer
The order number for the operation
SellerID
String
OrderStatus
String
Your Seller ID
The new order status:
Shipped
PartiallyShipped
TrackingNumber
String
Tracking number for the shipped package
ShipDate
String
Ship date(Pacific Standard Time)
ProcessStatus
String
True or False. True stands for package have
been successfully processed. False stands for
package that failed to process.
ProcessResult
String
Success or fail. If fail, detailed error description
ItemDes
displayed here.
ItemList
Package
PackageList
Shipment
Result
SuccessCount
SellerPartNumber
String
The Seller Part # of the item(s)
NeweggItemNumber
String
Newegg Item Number of the item
ShippedQty
Integer
Shipped quantity of items.
Example: XML, Response
XSD
API Schema > OrderMgmt > UpdateOrder > ShipmentResponse.xsd
true
1
1
0
159243598
A006
Shipped
118
lztestA0060001
2012-02-10T15:30:01
true
Success
9SIA0060845543
A006ZX-35833
1
Example: Json, Response
{
"IsSuccess": true,
"PackageProcessingSummary": {
"FailCount": 0,
"SuccessCount": 1,
"TotalPackageCount": 1
},
"Result": {
"OrderNumber": "159243598",
"OrderStatus": "Shipped",
"SellerID": "A006",
"Shipment": {
"PackageList": [{
"ItemList": [{
"NeweggItemNumber": "9SIA0060845543",
"SellerPartNumber": "A006ZX-35833",
"ShippedQty": 1
}],
"ProcessResult": "Success",
119
"ProcessStatus": true,
"ShipDate": "2012-02-10T15:30:01",
"TrackingNumber": "lztestA0060001"
}]
}
}
}
10.2.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SO001
Seller ID cannot be null or empty
SO002
Order Number should be an integer (ranging from 1 to 2147483647)
SO003
No data found or this order does not belong to this seller
SO004
This is a replacement SO with a RMA number. It cannot be voided
SO005
Cannot remove item because this is a Shipped by Newegg order. order is Shipped by Newegg
SO006
Only unshipped orders can be voided. The order status is currently {0}
SO007
Cannot get the order status info
SO008
This order has already been voided
SO009
Order number cannot be null or empty
SO010
Invalid order. No item exists
SO011
Only unshipped orders can be shipped. The order status is currently {0}
SO012
Only shipped by seller orders can be supported currently
SO014
The action should be [ Canceled = 1 | Shipped = 2]
SO015
The Argument '{0}' cannot be null
SO016
This order has not been downloaded onto seller portal yet. Please re-submit your request after two hours.
SO017
Reason code should be [24 -- OutOfStock,72 -- Customer Requested to Cancel,73 -- PriceError,74 -- Unable to
Fulfill the Order]
SO020
There is a package or packages without shipping information in this shipment.
SO025
Some items in the shipment have already been shipped.
SO027
This order has already been shipped.
SO030
There is a format error in shipment segment of this XML request.
SO036
The order’s shipping method is null. Please contact System Admin.
SO037
The action should be [1 - Cancelled, 2 - Shipped]
SO040
The Order number or Seller ID provided is not the same as in the URL.
SO056
Your request cannot be processed. Order: [order #] is a Newegg Premier order and can only be shipped using
Newegg Shipping Label Service.
120
Example: XML, Response
SO002
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
“Code”: “SO002”,
“Message”: “ Order Number should be an integer (ranging from 1 to 2147483647)”
}
10.3. Order Confirmation
Notify Newegg to mark the orders you have downloaded. You will be able to exclude these downloaded orders in the Get
Order Info API’s through OrderDownloaded filter.
10.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/confirmation?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
121
10.3.2. Request Body
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email address)
NeweggAPIRequest
here.
DownloadedOrderList
RequestBody
OperationType
OrderNumber
Yes
String
Fixed value: OrderConfirmationRequest
Yes
Integer
The order(s) you want to mark as downloaded
already.
Example: XML, Request
XSD
API Schema > OrderMgmt > OrderConfirm > OrderConfirmRequest.xsd
POST
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/confirmation?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
OrderConfirmationRequest
159243598
Example: Json, Request
122
POST
https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/confirmation?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Accept: application/json
Content-Type: application/json
{
“OperationType”: “OrderConfirmationRequest”,
“RequestBody”: {
“DownloadedOrderList”: {
“OrderNumber”: [
“159243598”
]
}
}
}
10.3.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of order confirmation is successful
OperationType
String
Fixed value: OrderConfirmationResponse
SellerID
String
Your Seller ID
ResponseDate
String
The date time of response (Pacific Standard Time)
String
The date time of request (Pacific Standard Time)
Integer
The order(s) you want to mark as downloaded already.
String
Additional Information. Currently will return null.
Memo
DownloadedOrderList
RequestDate
ResponseBody
NeweggAPIResponse
Response: true or false
OrderNumber
123
Example: XML, Response
XSD
API Schema > OrderMgmt > OrderConfirm > OrderConfirmResponse.xsd
true
OrderConfirmationResponse
A006
2/22/2012 16:37:20
2/22/2012 16:37:20
159243598
Example: Json, Response
{
“NeweggAPIResponse”: {
“IsSuccess”: “true”,
“OperationType”: “OrderConfirmationResponse”,
“SellerID”: “A006”,
“ResponseDate”: “2/22/2012 16:38:53”,
“ResponseBody”: {
“RequestDate”: “2/22/2012 16:38:53”,
“DownloadedOrderList”: {
“OrderNumber”: “159243598”
}
}
}
}
124
10.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
CE001
SellerID cannot be null or empty
Example: Json, Response
{
“Code”: “CE001”,
“Message”: “SellerID cannot be null or empty”
}
10.4. Remove Item(s)
Remove item(s) from specified order. If all items removed from an order, order status becomes void. Please note:but only supports
order(s) that is fulfilled by seller.
10.4.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/ordermgmt/killitem/orders/{ordernumber}?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
{ordernumber}
Yes
The order number for the operation
125
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
10.4.2. Request Body
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email
Yes
String
Fixed value: KillItemRequest
Yes
String
The Seller Part # of the item(s).Note: Items
Item
ItemLis
SellerPartNumber
Memo
Order
KillItem
OperationType
RequestBody
NeweggAPIRequest
address) here.
cannot be removed with SBN orders
No
String
Example: XML, Request
XSD
API Schema > OrderMgmt > RemoveItem > RemoveItemRequest.xsd
PUT
https://api.newegg.com/marketplace/ordermgmt/killitem/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
KillItemRequest
-
AWHZ3434
-
126
AWHZ3435
Example: Json, Request
PUT
https://api.newegg.com/marketplace/ordermgmt/killitem/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
“OperationType”: “KillItemRequest”,
“RequestBody”: {
“KillItem”: {
“Order”: {
“ItemList”: {
“Item”: [
{ “SellerPartNumber”: “AWHZ3434” },
{ “SellerPartNumber”: “AWHZ3435” }
]
}
}
}
}
}
127
10.4.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of removing item(s)
OperationType
String
Fixed value: KillItemResponse
SellerID
String
Your seller ID
ResponseDate
String
The DateTime of a request(Pacific Standard Time)
Integer
The order number
String
The Seller Part # of the item(s).
String
The DateTime of a request(Pacific Standard Time)
String
When operation false, this field will contain
OrderNumber
Item
ItemList
Orders
Result
SellerPartNumber
ResponseByody
NeweggAPIResponse
from order is successful. Returns true or false
Memo
RequestDate
detailed error description.
Example: XML, Response
XSD
API Schema > OrderMgmt > RemoveItem > RemoveItemResponse.xsd
true
KillItemResponse
A006
2012-02-22 16:42:10
88237462
-
AWHZ3434
128
2012-02-22 16:42:10
Example: Json, Response
{
“IsSuccess”: true,
“Memo”: null,
“OperationType”: “KillItemResponse”,
“SellerID”: “A006”,
“ResponseBody”: {
“Orders”: {
“OrderNumber”: “88237462”,
“Result”: {
“ItemList”: [{
“SellerPartNumber”: “AWHZ3434”
}]
}
},
“RequestDate”: “2012-02-22 16:42:10”
},
“ResponseDate”: “2012-02-22 16:42:10”
}
10.4.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SO002
Order number should be integer (ranging from 1 to 2147483647)
SO003
No data found or this order does not belong to this seller
SO005
Cannot remove item because the order is Ship By Newegg.
SO006
Only unshipped orders can be voided. The order status is currently {0}.
SO008
This order has already been voided.
SO009
Order number CANNOT be null
SO041
CANNOT find SONumber: {0}
129
SO042
Application exception occurred during calling EC Interface. SONumber: {0}, ItemNumber: {1}. Please Contact
Newegg Marketplace.
SO043
Business exception occurred during calling EC Interface(3 invoice,4 void,1 shipped). SONumber: {0}, ItemNumber:
{1}. Please Contact Newegg Marketplace.
SO045
Failed to get customer information! The customer number is {0}.
SO046
CANNOT find item in Newegg_SOTransaction, SONumber: {0}, ItemNumber: {1}
SO047
CANNOT get item detail information (sub category), ItemNumber: {0}
SO049
The '{0}' is required.
SO050
The SellerPartNumber '{0}' is invalid.
SO051
This '{0}' has already been canceled in Newegg System
SO052
CANNOT find out item by ordernumber ='{0}' and sellerid='{1}'.
SO053
Cannot get the ordernumber='{0}' status.
SO054
The ordernumber= '{0}' is Replacement SO. CANNOT be voided.
SO055
The seller part# = ‘{0}’ is repeated.
Example: XML, Response
SO008
This order has already been voided
Example: Json, Response
{
"Code": "SO008",
"Message": " This order has already been voided"
}
10.5. Get Order Info
Retrieve order info by specified order number.
10.5.1. Resource URL & Information
130
Resource URL
https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid={sellerid}&version={versionno}
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
version
Yes
Available version numbers:
304
305
306
307
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
10.5.2. Request Body
Attribute
Req
For
uire
mat
Description
Available
Ver.#
d?
IssueUser
No
Strin
Specify your eligible seller account (email address) here.
All
Fixed value: GetOrderInfoRequest
All
Inte
Current page index
All
ger
If left blank, will use 1 as default.
Inte
Return records count in one page.
ger
(Max is 100 per page)
g
OperationType
Yes
Strin
g
PageSize
No
No
All
RequestCriteria
If left blank, will use 100 as default.
OrderNumberList
RequestBody
NeweggAPIRequest
PageIndex
OrderNu
mber
No
Inte
The order number
ger
Ignore other search conditions (request criteria) if order number specified this field.
All
131
No
derNum
Stri
The seller order number.
ng
This is available for sellers using SBN (Shipped by Newegg) to fulfill multi-
ber
Status
307
channel orders.
List
SellerOrderNumber
SellerOr
If not specify Newegg order number in field “OrderNumber”, ignore other
search conditions (request criteria) and only apply the query result on seller
order numbers specified in this field.
No
Inte
0: Unshipped
ger
1: Partially Shipped
All
2: Shipped
3: Invoiced
4: Voided
If left blank, will return orders in all order status
OrderDownl
No
oaded
Type
No
Inte
0: False(Default): include downloaded orders
ger
1: True: do not include downloaded orders
Inte
0: All (Default)
ger
1: SBN (Shipped by Newegg)
All
All
2: SBS (Shipped by Seller)
3: Multi-Channel
VoidSoon
No
Inte
The order will be auto voided after 24 or 48 hours.
ger
Available values:
All
24
48
OrderDateFr
No
om
OrderDateTo
CountryCode
No
No
Strin
Order Date From (Pacific Standard Time)
g
Please refer to the Acceptable Date Format
Strin
Order Date To (Pacific Standard Time)
g
Please refer to the Acceptable Date Format
Strin
The country for your orders. Only the ISO standard 3-digit codes are accepted.
g
To review the complete list of available values, please download the following:
All
All
All
https://promotions.newegg.com/Marketplace/Sellers/resourceLibrary/Intern
ational%20Country%20Guide.pdf
PremierOrde
r
No
Inte
0: All (Default)
ger
1: Premier Order Only
All
2: No Premier Order
Example: XML, Request
XSD
API Schema > OrderMgmt > GetOrderInfo > GetOrderInfoRequest.xsd
132
PUT https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetOrderInfoRequest
1
10
159243598
41473642
SO159243598
SO41473642
1
1
2011-01-01 09:30:47
2011-12-17 09:30:47
0
USA
1
Example: Json, Response
PUT https://api.newegg.com/marketplace/ordermgmt/order/orderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetOrderInfoRequest",
133
"RequestBody": {
"PageIndex": "1",
"PageSize": "10",
"RequestCriteria": {
"OrderNumberList": {
"OrderNumber": [
"159243598",
"41473642"
]
},
"SellerOrderNumberList": {
"SellerOrderNumber": [
"SO159243598",
"SO41473642"
]
},
"Status": "1",
"Type": "1",
"OrderDateFrom": "2011-01-01 09:30:47",
"OrderDateTo": "2011-12-17 09:30:47",
"OrderDownloaded": 0,
"CountryCode":"USA",
"PremierOrder":"1"
}
}
}
10.5.3. Response Body
Attribute
Format
Description
Availa
ble
IsSuccess
String
Used to identify the operation of Get Order Info is
successful
onse
NeweggAPIResp
Ver.#
All
True or False
SellerID
String
Your seller ID
All
OperationType
String
Fixed value: GetOrderInfoResponse
All
134
PageInfo
TotalCount
Integer
Total number of records
All
TotalPageCount
Integer
Total page count
All
PageSize
Integer
How many records in a page.
All
PageIndex
Integer
Current page index
All
SellerID
String
Seller ID
All
OrderNumber
Integer
Newegg Order number
All
SellerOrderNumber
String
Order number, assigned by seller.
307
This is available for sellers using SBN (Shipped by
Newegg) to fulfill multi-channel orders.
InvoiceNumber
Integer
The Invoice Number
All
OrderDownloaded
String
False: Order has not been downloaded yet.
All
True: Order downloaded already.
When order is shipped, this field will automatically
become “True”.
OrderDate
String
Create date
All
OrderStatus
Integer
The Order Status:
All
1: Partially Shipped
2: Shipped
OrderInfo
3: Invoiced
OrderInfoList
ResponseByody
0: Unshipped
4: Voided
OrderStatusDescription
String
The Order Status Description
All
(Unshipped|PartiallyShipped|Shipped|Invoiced|Voi
d)
Unshipped for order status code: 0
Partially Shipped for order status code: 1
Shipped for order status code: 2
Invoiced for order status code: 3
Voided for order status code: 4
CustomerName
String
The order’s customer name.
All
CustomerPhoneNumber
String
The order’s shipping phone number
All
CustomerEmailAddress
String
The masked customer email address, you can reach
All
to the customer through this email address.
For example:
gdv6l0viwo4l7j1d@marketplace.newegg.com
ShipToAddress1
String
The order will be shipped to address
All
ShipToAddress2
String
The order will be shipped to address line 2
All
ShipToCityName
String
The order will be shipped to city name
All
ShipToStateCode
String
The order will be shipped to state
All
135
ShipToZipCode
String
The order will be shipped to zip code
All
ShipToCountryCode
String
The country for your orders. i.e. United Kingdom
All
ShipService
String
The order’s shipping service:
All
Shipped By Newegg
APO/FPO – Military ONLY
Super Saver(7-14 business days)
Standard Shipping (5-7 business days)
Expedited Shipping (3-5 business days)
Two-Day Shipping(2 business days)
One-Day Shipping(Next day)
International Expedited Shipping(3-5 business days)
International Two-Day Shipping(2 business days)
International Economy Shipping(8-15 business days)
International Standard Shipping(5-7 business days)
Newegg Premier 3 Days
Newegg Premier 2 Days
Newegg Premier Next Day
Please note that the following shipping services are
for indicating Newegg Premier orders, you should
ship the order as soon as the service required.
Please contact Datafeeds@Newegg.com for more
detail regarding Premier Seller Enrollment Program.
Newegg Premier 3 Days
Newegg Premier 2 Days
Newegg Premier Next Day
ShipToFirstName
String
The ship to First Name
All
ShipToLastName
String
The ship to Last Name
All
ShipToCompany
String
The order’s ship to company
All
OrderItemAmount
Decimal
The order’s item(s) total amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
ShippingAmount
Decimal
The order’s shipping Amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
DiscountAmount
Decimal
The order’s total discount amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
OrderQty
Integer
Order’s total item quantity.
All
136
RefundAmount
Decimal
The order’s refund amount.
All
NOTE: All amounts are set in U.S. Dollars (USD).
SalesTax
Decimal
VATTotal
Decimal
The order’s sales tax.
305,
NOTE: All amounts are set in U.S. Dollars (USD).
306
International Value Additional Tax Total.
306
NOTE: All amounts are set in U.S. Dollars (USD).
DutyTotal
Decimal
International Duty Total
306
NOTE: All amounts are set in U.S. Dollars (USD).
OrderTotalAmount
Decimal
The order’s total amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
IsAutoVoid
String
If an order was auto voided by Newegg system, then
All
the value is true. Otherwise, value is false.
SalesChannel
Integer
Order sales channel:
All
0: Newegg order
1: Multi-channel order
2: Replacement order
FulfillmentOption
Integer
Order fulfillment option:
All
0: Ship by seller
ItemInfo
ItemInfoList
1: Ship by Newegg
SellerPartNumber
String
The item’s seller part number
All
NeweggItemNumber
String
The item’s newegg item number
All
MfrPartNumber
String
The item’s manufacture part number
All
UPCCode
String
The item’s upc
All
Description
String
The item’s web title description
All
OrderedQty
Integer
Item’s Ordered Quantity.
All
ShippedQty
Integer
Item’s Shipped Quantity.
All
UnitPrice
Decimal
The final price per unit of the item appearing in
All
customer's shopping cart
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendUnitPrice
Decimal
Item's total charge (Item Unit Price x Quantity
All
Ordered)
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendShippingCharg
e
Decimal
Item's total shipping charge (Item Unit Shipping
All
Price x Quantity Ordered)
NOTE: All amounts are set in U.S. Dollars (USD).
137
ExtendSalesTax
ExtendVAT
Decimal
Decimal
Item’s total sales tax charge.
305,
NOTE: All amounts are set in U.S. Dollars (USD).
306
Item’s total Value Additional Tax charge
306
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendDuty
Decimal
Item’s total Duty charge
306
NOTE: All amounts are set in U.S. Dollars (USD).
Status
Integer
1: Unshipped
All
2: Shipped
3: Cancelled
StatusDescription
String
Unshipped for status code: 1
All
Shipped for status code: 2
PackageType
String
The package type. Shipped | Unshipped
All
ShipCarrier
String
The package’s actual ship Carrier
All
ShipService
String
The package’s actual ship Service
All
TrackingNumber
String
The package’s tracking number.
All
ShipDate
String
The package’s ship date. (Pacific Standard Time)
All
String
The item’s seller part number
All
String
The item’s manufacture part number
All
Integer
Item’s Shipped Quantity.
All
SellerPartN
umber
Item Info
ItemInfoList
PackageInfo
PackageInfoList
Cancelled for status code: 3
MfrPartNu
mber
ShippedQt
y
Memo
String
Other information.
All
ResponseDate
String
The response date
All
Example: XML, Response
XSD
API Schema > OrderMgmt > GetOrderInfo > GetOrderInfoResponse.xsd
true
A006
GetOrderInfoResponse
138
2
1
10
1
A006
41473642
2153930
0
true
1/23/2012 7:33:05
4
Voided
WY SD
123-223-3223
gdv6l0viwo4l7j1d@marketplace.newegg.com
149 Kenwood Dr
Newcastle
WY
82701
UNITED STATES
Media Mail (7-14 business days)
WY
SD
0
0.00
0.00
0
0.00
1
true
0
139
1
A00655467241
9SIA0060823129
55467241
test creation test item
1
0
1.00
1.03
1.03
3
Canceled
A006
159243598
2153930
82961992
true
1/18/2012 1:05:18
3
Invoiced
WY SD
123-223-3223
gdv6l0viwo4l7j1d@marketplace.newegg.com
149 Kenwood Dr
Newcastle
WY
82701
UNITED STATES
Media Mail (7-14 business days)
140
WY
SD
2.00
10.00
1.00
0
11.00
2
false
0
1
A006ZX-35833
9SIA0060845543
ZX-35833
431573000287
GYRO Huge Metal Goliath 3.5CH Electric RTF RC
Helicopter
2
2
1.00
2
Shipped
1.03
1.03
Shipped
UPS
342
2342424
1/18/2012 16:59:15
141
A006ZX-35833
ZX-35833
2
2/22/2012 16:51:03
Example: Json, Response
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetOrderInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "2",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"OrderInfoList": {
"OrderInfo": [{
"SellerID": "A006 ",
"OrderNumber": "41473642",
"SellerOrderNumber": "2153930",
"InvoiceNumber": "0",
"OrderDownloaded": "true",
"OrderDate": "1/23/2012 7:33:05",
"OrderStatus": "4",
"OrderStatusDescription": "Voided",
"CustomerName": "WY SD",
"CustomerPhoneNumber": "123-223-3223",
142
"ShipToAddress1": "149 Kenwood Dr",
"ShipToAddress2": null,
"ShipToCityName": "Newcastle",
"ShipToStateCode": "WY",
"ShipToZipCode": "82701",
"ShipToCountryCode": "UNITED STATES",
"ShipService": "Media Mail (7-14 business days)",
"ShipToFirstName": "WY",
"ShipToLastName": "SD",
"ShipToCompany": null,
"OrderItemAmount": "0",
"ShippingAmount": "0.00",
"DiscountAmount": "0.00",
"RefundAmount": "0",
“SalesTax”:”0.00”,
“VATTotal”:”0.00”,
“DutyTotal”:”0.00”,
"OrderTotalAmount": "0.00",
"OrderQty": "1",
"IsAutoVoid": "true",
“SalesChannel”:0,
“FulfillmentOption”:1,
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "A00655467241",
"NeweggItemNumber": "9SIA0060823129",
"MfrPartNumber": "55467241",
"UPCCode": null,
"Description": "test creation test item”,
"OrderedQty": "1",
"ShippedQty": "0",
"UnitPrice": "1.00",
"ExtendUnitPrice": "1.03",
"ExtendShippingCharge": "1.03",
“ExtendSalesTax”:”0.00”,
“ExtendVATTotal”:”0.00”,
“ExtendDutyTotal”:”0.00”,
"Status": "3",
"StatusDescription": "Canceled"
}
},
143
"PackageInfoList": null
}, {
"SellerID": "A006 ",
"OrderNumber": "159243598",
"SellerOrderNumber": "2153930",
"InvoiceNumber": "82961992",
"OrderDownloaded": "true",
"OrderDate": "1/18/2012 1:05:18",
"OrderStatus": "3",
"OrderStatusDescription": "Invoiced",
"CustomerName": "WY SD",
"CustomerPhoneNumber": "123-223-3223",
"CustomerEmailAddress”:gdv6l0viwo4l7j1d@marketplace.newegg.com",
"ShipToAddress1": "149 Kenwood Dr",
"ShipToAddress2": null,
"ShipToCityName": "Newcastle",
"ShipToStateCode": "WY",
"ShipToZipCode": "82701",
"ShipToCountryCode": "UNITED STATES",
"ShipService": "Media Mail (7-14 business days)",
"ShipToFirstName": "WY",
"ShipToLastName": "SD",
"ShipToCompany": null,
"OrderItemAmount": "2.00",
"ShippingAmount": "10.00",
"DiscountAmount": "1.00",
"RefundAmount": "0",
“SalesTax”:”0.00”,
“VATTotal”:”0.00”,
“DutyTotal”:”0.00”,
"OrderTotalAmount": "11.00",
"OrderQty": "2",
"IsAutoVoid": "false",
“SalesChannel”:0,
“FulfillmentOption”:1,
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "A006ZX-35833",
"NeweggItemNumber": "9SIA0060845543",
"MfrPartNumber": "ZX-35833",
"UPCCode": "431573000287",
144
"Description": "GYRO Huge Metal Goliath 3.5CH Electric RTF RC Helicopter
",
"OrderedQty": "2",
"ShippedQty": "2",
"UnitPrice": "1.00",
"ExtendUnitPrice": "1.03",
"ExtendShippingCharge": "1.03",
“ExtendSalesTax”:”0.00”,
“ExtendVATTotal”:”0.00”,
“ExtendDutyTotal”:”0.00”,
"Status": "2",
"StatusDescription": "Shipped"
}
},
"PackageInfoList": {
"PackageInfo": {
"PackageType": "Shipped",
"ShipCarrier": "UPS",
"ShipService": "342",
"TrackingNumber": "2342424",
"ShipDate": "1/18/2012 16:59:15",
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "A006ZX-35833",
"MfrPartNumber": "ZX-35833",
"ShippedQty": "2"
}
}
}
}
}]
}
},
"Memo": null,
"ResponseDate": "2/22/2012 16:53:26"
}
10.5.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
145
Example: XML, Response
CE001
SellerID cannot be null or empty
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
10.6. Get SBN (Shipped by Newegg) Order Cancellation Request Result
Get the status of specified SBN (Shipped by Newegg) cancellation request. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/ordermgmt/sbnorder/cancellationresult/{ordernumber}?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
{ordernumber}
Yes
The order number
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
10.6.1. Request Body
Example: XML, Request
146
GET
https://api.newegg.com/marketplace/ordermgmt/sbnorder/cancellationresult/{ordernumber}?sellerid={
sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
GET
https://api.newegg.com/marketplace/ordermgmt/sbnorder/cancellationresult/{ordernumber}?sellerid={
sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
10.6.2. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of order confirmation is successful
SellerID
String
Your Seller ID
OperationType
String
Fixed value: GetSBNOrderCancellationResultResponse
ResponseDate
String
The date time of response (Pacific Standard Time)
RequestDate
String
The date time of request (Pacific Standard Time)
OrderNumber
Integer
The order number.
Result
String
Available values:
ResponseBody
NeweggAPIResponse
Response: true or false
Success
Failed
Processing
ErrorMessage
String
The error message if the request was failed.
Example: XML, Response
147
XSD
API Schema > OrderMgmt > GetSBNOrderCancellationResponse > GetSBNOrderCancellationResponse.xsd
true
GetSBNOrderCancellationResultResponse
A006
2/22/2012 16:37:20
2/22/2012 15:37:20
159243598
Failed
Order
void
was
not
successful
due
to
technical
issues
/
order
already
shipped.
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetSBNOrderCancellationResultResponse",
"SellerID": "A006",
"ResponseDate": "2/22/2012 16:37:20",
"ResponseBody": {
"RequestDate": "2/22/2012 15:37:20",
"OrderNumber": "159243598",
"Result": "Failed",
"ErrorMessage": "Order void was not successful due to technical issues / order already
shipped."
}
}
10.6.3. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
148
SO057
The order #: [order#] is not a valid Shipped by Newegg order. Please verify the order # then submit your request
again.
SO058
No void request found for order #:{order#}.
Example: XML, Response
SO002
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SO002",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
10.7. Get Additional Order Information
Retrieve the additional info for Newegg Global order including:
Additional order requirement for certain countries.
The original recipient information for orders shipped by NISP service.
The original recipient information inputted by international customers.
10.7.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?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
149
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
1000 per min per client
Description
IssueUser
No
String
Specify your eligible seller account (email address) here.
OperationType
Yes
String
Fixed value: GetAddOrderInfoRequest
PageIndex
No
Integer
Current page index
If left blank, will use 1 as default.
PageSize
No
Integer
Return records count in one page.
(Max is 100 per page)
If left blank, will use 100 as default.
No
Integer
The order number you would like to query.
Ignore other search conditions (request criteria) if order number is specified.
Status
No
Integer
OrderDownloaded
No
Integer
0: Unshipped
1: Partially Shipped
2: Shipped
3: Invoiced
4: Voided
5: All
If left blank, will return orders in Unshipped status
0: False(Default): include downloaded orders
1: True: do not include downloaded orders
Type
No
Integer
VoidSoon
No
Integer
OrderDateFrom
No
String
OrderDateTo
No
String
CountryCode
No
String
RequestBody
Format
RequestCriteria
Attribute
NeweggAPIRequest
Required?
OrderNumberList
10.7.2. Request Body
OrderNumber
0: All (Default)
1: SBN (Shipped by Newegg)
2: SBS (Shipped by Seller)
3: NISP
The order will be auto voided after 24 or 48 hours.
Available values:
24
48
Order Date From (Pacific Standard Time)
Please refer to the Acceptable Date Format
Order Date To (Pacific Standard Time)
Please refer to the Acceptable Date Format
The country for your orders. Only the ISO standard 3-digit codes are accepted.
To review the complete list of available values, please download the following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLibrary/Interna
tional%20Country%20Guide.pdf
Example: XML, Request
XSD
150
API Schema > OrderMgmt > GetAddOrderInfo > GetAddOrderInfoRequest.xsd
POST https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetAddOrderInfoRequest
1
10
159243598
41473642
0
1
2017-01-01 09:30:47
2017-12-17 09:30:47
0
BRA
Example: Json, Response
POST https://api.newegg.com/marketplace/ordermgmt/order/addorderinfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetAddOrderInfoRequest",
"RequestBody": {
"PageIndex": "1",
"PageSize": "10",
151
"RequestCriteria": {
"OrderNumberList": {
"OrderNumber": [
"159243598",
"41473642"
]
},
"Status": "1",
"Type": "1",
"OrderDateFrom": "2017-01-01 09:30:47",
"OrderDateTo": "2017-12-17 09:30:47",
"OrderDownloaded": 0,
"CountryCode":"BRA"
}
}
}
10.7.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get Additional Order Info is
successful
Your seller ID
OperationType
String
Fixed value: GetAddOrderInfoResponse
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageSize
Integer
How many records in a page.
PageIndex
Integer
Current page index
OrderNumber
Integer
Newegg Order number
RecipientIDType
String
A personal identity document that provided by customer. This
document may be used for customs clearance for certain countries.
Currently available values: CPF, CNPJ, Passport. It is required for
orders from Brazil.
RecipientIDNumber
string
The value of the ID associated with the document identified under
"ID Type"
NISP
Origi
nalInf
o
AddOrderInfoList
AddOrderInfo
String
PageInfo
SellerID
ResponseByody
NeweggAPIResponse
True or False
NISPOriFirstName
String
The First Name of the original recipient
152
NISPOriLastName
String
The Last Name of the original recipient
NISPOriCompanyName
String
The company name of the original recipient
NISPOriAddress1
String
The address line 1 of the original recipient
NISPOriAddress2
String
The address line 2 of the original recipient
NISPOriCity
String
The City of the original recipient
NISPOriState
String
The State of the original recipient
NISPOriZipCode
String
The Zipcode of the original recipient
NISPOriCountryCode
String
The destination country of the original recipient
NISPOriPhoneNumber
String
the contact phone number of the original recipient
OriginalFirstName
String
The First Name of the recipient, in the original format inputted by
customer
OriginalLastName
String
The Last Name of the recipient, in the original format inputted by
customer
OriginalCompanyName
String
The company name of the recipient, in the original format inputted
by customer
OriginalAddress1
String
The address line 1 of the recipient, in the original format inputted by
OriginalInputInfo
customer
OriginalAddress2
String
The address line 2 of the recipient, in the original format inputted
by customer
OriginalCity
String
The City of the recipient, in the original format inputted by
customer
OriginalState
String
The State of the recipient, in the original format inputted by
customer
OriginalZipCode
String
The Zipcode of the recipient, in the original format inputted by
customer
OriginalCountryCode
String
The destination country of the recipient, in the original format
inputted by customer
OriginalPhoneNumber
String
the contact phone number of the recipient, in the original format
inputted by customer
AddInfo1
String
Additional information may include further information related to
AddInfo2
String
Newegg Global orders or data that may providing additional
AddInfo3
String
information that are beneficial to your operation in Newegg
Marketplace. It is optional and currently no data is available. We
will notify sellers once they are available.
Memo
String
Other information.
ResponseDate
String
The response date
153
Example: XML, Response
XSD
API Schema > OrderMgmt > GetOrderInfo > GetAddOrderInfoResponse.xsd
true
A006
GetAddOrderInfoResponse
2
1
10
1
41473642
ID
511522198812036655
Guang
Li
149 Tianfu Blvd
Chengdu
Sichuan
64410
CHINA
13812345678
广
李
天府大道 149 号
成都
四川
64410
CHINA
13812345678
09/01/2018 16:51:03
Example: Json, Response
{
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetAddOrderInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "2",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"AddOrderInfoList": {
"AddOrderInfo": {
"OrderNumber": "41473642",
"RecipientIDType": "ID",
"RecipientIDNumber": "511522198812036655",
"NISPOriginalInfo": {
"NISPOriFirstName": "Guang",
"NISPOriLastName": "Li",
"NISPOriCompanyName": [],
"NISPOriAddress1": "149 Tianfu Blvd",
155
"NISPOriAddress2": [],
"NISPOriCity": "Chengdu",
"NISPOriState": "Sichuan",
"NISPOriZipCode": "64410",
"NISPOriCountryCode": "CHINA",
"NISPOriPhoneNumber": "13812345678"
},
"OriginalInputInfo": {
"OriginalFirstName": "广",
"OriginalLastName": "李",
"OriginalCompanyName": [],
"OriginalAddress1": "天府大道 149 号",
"OriginalAddress2": [],
"OriginalCity": "成都",
"OriginalState": "四川",
"OriginalZipCode": "64410",
"OriginalCountryCode": "CHINA",
"OriginalPhoneNumber": "13812345678"
},
"AddInfo1": [],
"AddInfo2": [],
"AddInfo3": []
}
}
},
"Memo": [],
"ResponseDate": "9/01/2018 16:51:03"
}
10.7.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
CE001
SellerID cannot be null or empty
156
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
11. Newegg Shipping Label Service
Newegg marketplace sellers can take advantage of discounted shipping rates by using the Newegg Shipping Label
Service for Newegg Marketplace orders.
To use Newegg Shipping Label Service:
1.
Submit a shipping request
2.
Retrieve the result of submitted shipping request
3.
Confirm a shipping request
4.
Void a shipping request (Optional)
5.
Request a packing list
6.
Request a shipping label
11.1. Submit Shipping Request
Submit the shipping request for your Newegg order to receive the estimation of shipping cost using Newegg Shipping
Label Service.
Please note that any unconfirmed shipping request will be void automatically within 15 days after submitting the request.
11.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingrequest?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
157
sellerid
Yes
Your seller ID on Newegg Marketplace
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
10 per min per client
Resource Information
11.1.2. Request Body
Attribute
OperationType
OrderNumber
Required
Forma
Description
?
t
Yes
String
Fixed value: SubmitShippingRequest
Yes
Intege
The order number
ShippingCarrierCode
Yes
Intege
Shipping carrier.
r
Shipment
RequestBody
NeweggAPIRequest
r
Available shipping carrier code:
100 – Newegg Partnered Carrier (UPS).
For more information, please refer to section 11.1.5:
Newegg Partnered Carrier- UPS.
200 – Newegg Partnered Carrier (FedEx).
For more information, please refer to section 11.1.6:
Newegg Partnered Carrier- FedEx.
158
ShippingServiceCode
No
Intege
Available shipping service code:
r
If ShippingCarrierCode = 100:
101 – UPS Ground
102 – UPS 3 Day Select
103 – UPS 2nd Day Air
104 – UPS Next Day Air Saver
105 - UPS Next Day Air
106 - UPS Worldwide Saver
If ShippingCarrierCode = 200:
201 – FedEx Ground
202 – FedEx Home Delivery
203 – FedEx Priority Overnight
204 – FedEx Express Saver
205 – FedEx 2Day
206 – FedEx Standard Overnight
207 – FedEx International Economy
Note: if left this blank, a default shipping service will be assigned
according to the shipping service that the customer purchased
on this order. The default shipping service mapping as below:
If ShippingCarrierCode = 100:
Newegg Order
Shipping Method
Standard Shipping (57 business days)
Expedited Shipping (35 business days)
Default Mapped Service
UPS Ground
UPS 3 Day Select
Two-Day Shipping
UPS 2nd Day Air
One-Day Shipping
UPS Next Day Air Saver
If ShippingCarrierCode = 200:
Newegg Order
Shipping Method
Standard Shipping
(5-7 business days)
Expedited Shipping
(3-5 business days)
Default Mapped Service
FedEx Ground
FedEx Express Saver
Two-Day Shipping
FedEx 2Day
One-Day Shipping
FedEx Standard Overnight
Note: For Newegg Premier orders, this field cannot be specified.
The default Service will be assigned automatically based on the
shipping service selected by customer while placing orders.
159
ShipFromFirstName
Yes
String
Contact person – first name
ShipFromLastName
Yes
String
Contact person – last name
ShipFromPhoneNumber
Yes
String
Contact person – contact phone number
ShipFromAddress1
Yes
String
Ship from address
* Shipping cost is calculated based on Ship from address. Please
fill in the correct information.
ShipFromAddress2
No
String
Ship from address 2nd line if any
* Shipping cost is calculated based on Ship from address. Please
fill in the correct information.
ShipFromCityName
Yes
String
Ship from city
* Shipping cost is calculated based on Ship from address. Please
fill in the correct information.
ShipFromStateCode
Yes
String
Ship from state, such as CA, FL, etc.
* Shipping cost is calculated based on Ship from address. Please
fill in the correct information.
ShpFromZipCode
Yes
String
Ship from zipcode, such as 91748, 91773, etc.
* Shipping cost is calculated based on Ship from address. Please
fill in the correct information.
ShipFromCountryCode
Yes
String
Ship from country code in 3-digit fromat
* Currenlty only USA is available.
* Shipping cost is calculated based on Ship from address. Please
fill in the correct information.
PackageWeight
Yes
Decim
Package weight, default unit: lb.
al
See Shipments Weight and Size Limitations for more
details.
PackageLength
Yes
Decim
Package length, default unit: inch
al
See Shipments Weight and Size Limitations for more
PackageHeight
Yes
Decim
Package height, default unit: inch
al
See Shipments Weight and Size Limitations for more
details.
PackageWidth
Yes
Decim
Package width, default unit: inch
al
See Shipments Weight and Size Limitations for more
t
Item
details.
ItemLis
Package
PackageList
details.
SellerPart
Yes
String
Seller part number.
Number
160
Quantity
Yes
Intege
Item quantity
r
Example: XML, Request
XSD
API Schema > ShippingLabel > SubmitShippingRequest > ShippingSubmitRequest.xsd
POST
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingrequest?sellerid={seller
id}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
SubmitShippingRequest
2135751360
100
101
John
Doe
6266171420
18045 Rowland Street
City Of Industry
CA
91748
USA
5
5.00
4.00
3.00
-
161
201307220000101
4
-
SARATEST0118
1
1.5
2.00
3.00
4.00
-
201307220000102
3
Example: Json, Request
POST
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingrequest?sellerid={seller
id}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "SubmitShippingRequest",
"RequestBody": {
"Shipment": {
"OrderNumber": "2135751360",
162
"ShippingCarrierCode": "100",
"ShippingServiceCode": "101",
"ShipFromFirstName": "Jon",
"ShipFromLastName": "Doe",
"ShipFromPhoneNumber": "6266171420",
"ShipFromAddress1": "18045 Rowland Street",
"ShipFromCityName": "City Of Industry",
"ShipFromStateCode": "CA",
"ShipFromZipCode": "91748",
"ShipFromCountryCode": "USA",
"PackageList": {
"Package": [
{
"PackageWeight": "5",
"PackageLength": "5.00",
"PackageHeight": "4.00",
"PackageWidth": "3.00",
"ItemList": {
"Item": [
{
"SellerPartNumber": "201307220000101",
"Quantity": "4"
},
{
"SellerPartNumber": "SARATEST0118",
"Quantity": "1"
}
]
}
},
{
"PackageWeight": "1.5",
"PackageLength": "2.00",
"PackageHeight": "3.00",
"PackageWidth": "4.00",
"ItemList": {
"Item": {
"SellerPartNumber": "201307220000102",
"Quantity": "3"
}
}
163
}
]
}
}
}
}
11.1.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is successful
OperationType
String
Fixed value: SubmitShippingResponse
SellerID
String
Your seller ID
RequestID
String
The Identifier of a submission
RequestDate
String
Request date.
RequestStatus
String
The status of the request submission.
ResponseBody
NeweggAPIResponse
True or False
ESTIMATING
Example: XML, Response
XSD
API Schema > ShippingLabel > SubmitShippingRequest > ShippingSubmitResponse.xsd
true
SubmitShippingResponse
A006
2PQCX3SPZ3QBF
12/06/2015 10:21:00
ESTIMATING
Example: Json, Response
164
{
"IsSuccess": "true",
"OperationType": "SubmitShippingResponse",
"SellerID": "A006",
"ResponseBody": {
"RequestID": "2PQCX3SPZ3QBF",
"RequestDate": "12/06/2015 10:21:00",
"RequestStatus": "ESTIMATING"
}
}
11.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SL001
Your request cannot be processed. The tem(s):{0} in order: [Order #] has been shipped or voided
SL002
No data found or this order does not belong to this seller
SL003
Only unshipped orders can submit a shipping request. The order status is currently {order status}
SL004
Only shipped by seller orders can submit a shipping request.
SL005
Seller Part #: {sellerpart#} must be shipped for its entire quantity on the order.
SL006
The field: [PackageWeight or PackageLength or PackageHeight or PackageWidth] is required when using Newegg
Partnered Carrier service (ShippingCarrierCode: 100).For more detail, please review Newegg API Development
Guide.
SL007
The value in the field: PackageWeight cannot exceed {Maximum package weight limit by Newegg Partnered
Carrier} lbs. ({Maximum package weight limit by Newegg Partnered Carrier}kg) when using Newegg Partnered
Carrier service (ShippingCarrierCode: {ShippingCarrierCode}). For more detail, please review Newegg API
Development Guide.
SL008
The value in the field: PackageLength cannot exceed {Maximum package length limit by Newegg Partnered
Carrier} inches ({Maximum package length limit by Newegg Partnered Carrier} cm) when using Newegg Partnered
Carrier service (ShippingCarrierCode: {ShippingCarrierCode}). For more detail, please review Newegg API
Development Guide.
SL009
Package size cannot exceed {Maximum package cubic size limit by Newegg Partnered Carrier}inches ({Maximum
package cubic size limit by Newegg Partnered Carrier} cm) in (Package Length + 2x Package Width + 2x Package
Height) when using Newegg Partnered Carrier service (ShippingCarrierCode: {ShippingCarrierCode}). For more
detail, please review Newegg API Development Guide.
SL010
Cannot submit the request because seller part number(s):{sellerpart#} does NOT belong to this order.
SL015
Cannot submit the request because currently only supports USA domestic transportation.Please revise the Ship
From or Ship To information and try again.
165
SL027
Invalid request. You are not able to use Newegg Shipping Label Service before sign up. Please visit Newegg Seller
Portal > Add-on Services > Newegg Shipping Label Service to sign up.
SL030
Invalid request. The ShippingServiceCode :{ shipping service code} you specified is not a recognized value for
ShippingCarrierCode :{ shipping carrier code}. Please review Newegg API Development Guide or schema for
correct information.
Example: XML, Response
SL001
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SL001",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
11.1.5. Newegg Partnered Carrier- UPS
Newegg partnered carriers offer deeply discounted rates, and the cost is billed to your account as a “Newegg Shipping
Label”. We will provide a shipping label that you can print and use with our partnered carriers. The rates apply to
shipments originating from the continental 50 U.S. states only (does not include Puerto Rico or APO/FPO addressed).
Please note this service is currently not available for International Sellers.
Shipment Measurement Guidelines
-
Shipments Weight and Size Limitations.*
Packages can be up to 150 lbs. (70 kg).
Packages can be up to 165 inches (419 cm) in (Length + 2x Width + 2x Height).
Packages can be up to 108 inches (270 cm) in Length.
*Packages with a large size-to-weight ratio require special pricing and dimensional weight calculations.
Example: A box measuring 34" x 34" x 34" exceeds the maximum dimensions. The length (34") plus 2x width (2 x 34")
and 2x height (2 x 34") equals 170".
166
-
Large Package
If packages Length plus 2x Width plus 2x Height exceeds 130 inches (330 cm), UPS applies a Large Package Surcharge.
Example: A box measuring 36” x 26” x 26” the length (36”) plus 2x width (2 x 26”) and 2x height (2 x 26”) equals 140”.
UPS will accept the box, but they may apply a Large Package Surcharge.
-
Dimensional Weight
If a package's volume is more than 5,184 cubic inches (3 cubic feet), UPS compares the dimensional weight (cubic inches
divided by 166) with the actual weight. If the dimensional weight is greater than actual weight, UPS uses the package's
dimensional weight as the billable weight.
Example: A package measuring 26" x 16" x 16" has a volume of 6,656 cubic inches. The dimensional weight equals 6,656
divided by 166 or 41 lbs. If the package's actual weight is 24 lbs., the dimensional weight may be used for the billable
weight.
-
Billable Weight
For large packages, UPS determines the billable weight by taking the package dimensions into account. For large
packages, if the dimensional weight is greater than the actual weight, UPS may use the dimensional weight instead of the
actual weight.
11.1.6. Newegg Partnered Carrier- FedEx
Newegg partnered carriers offer deeply discounted rates, and the cost is billed to your account as a “Newegg Shipping
Label Fee”. We will provide a shipping label that you can print and use with our partnered carriers. The rates apply to
shipments originating from the continental 50 U.S. states only (does not include Puerto Rico or APO/FPO addressed).
Please note this service is currently not available for International Sellers.
Shipment Measurement Guidelines
-
Shipments Weight and Size Limitations.*
Packages can be up to 150 lbs. (70 kg).
Packages can be up to 165 inches (419 cm) in (Length + 2x Width + 2x Height).
Packages with a large size-to-weight ratio require special pricing and dimensional weight
calculations.*Packages with a large size-to-weight ratio require special pricing and dimensional weight
calculations.
*: Packages that exceed weight and size limits may be refused by FedEx or at FedEx’s discretion of shipment and apply
an oversize surcharge.
Example: A box measuring 34" x 34" x 34" exceeds the maximum dimensions. The length (34") plus 2x width (2 x 34")
and 2x height (2 x 34") equals 170".
167
-
Large Package
If packages Length plus 2x Width plus 2x Height exceeds 130 inches (330 cm), FedEx applies an Oversize Surcharge.
Example: A box measuring 36” x 26” x 26” the length (36”) plus 2x width (2 x 26”) and 2x height (2 x 26”) equals 140”.
FedEx will accept the box, but they may apply an Oversize Surcharge.
-
Dimensional Weight
If the dimensional weight is greater than actual weight, FedEx uses the package's dimensional weight as the billable
weight.
Example: A package measuring 26" x 16" x 16" has a volume of 6,656 cubic inches. The dimensional weight equals
6,656 divided by 166 or 41 lbs. If the package's actual weight is 24 lbs, the dimensional weight may be used for the
billable weight.
-
Billable Weight
For large packages, FedEx determines the billable weight by taking the package dimensions into account. For large
packages, if the dimensional weight is greater than the actual weight, FedEx may use the dimensional weight instead of
the actual weight.
11.2. Get Request Detail
Retrieving the processing result including Shipping Request (section 11.1), Confirm Shipping Request (section 11.3), and
Void Shipping Request (section 11.4).
11.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingdetail?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
10 per min per client
Resource Information
11.2.2. Request Body
168
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed values:
GetShippingDetailRequest
RequestID
YES if no
String
The request ID
RequestID
RequestBody
NeweggAPIRequest
Attribute
is not
* This service does NOT support querying multiple request IDs.
available
OrderNumber
YES if no
String
The order number
RequestID
is not
available
Example: XML, Request
XSD
API Schema > ShippingLabel > GetShippingRequest > ShippingDetailRequest.xsd
PUT
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingdetail?sellerid={selleri
d}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetShippingDetailRequest
2PQBYWH4V68ZP
423423678
Example: Json, Request
PUT
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingdetail?sellerid={selleri
d}
Authorization: 720ddc067f4d115bd544aff46bc75634
169
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetShippingDetailRequest",
"RequestBody": {
"RequestID": "2PQBYWH4V68ZP",
"OrderNumber": "423423678"
}
}
11.2.3. Response Body
IsSuccess
Format
Description
String
Used to identify the operation is successful
True or False
SellerID
String
Your seller ID
OperationType
String
Fixed value: GetShippingDetailResponse
Integer
Related order number
RequestID
String
Shipping request ID
RequestDate
String
The date the shipping request was submitted
CustomerName
String
The order’s customer name.
CustomerPhoneNumber
String
The order’s shipping phone number
CustomerEmailAddress
String
The masked customer email address, you can reach to the customer
Request
OrderNumber
RequestList
ResponseBody
NeweggAPIResponse
Attribute
through this email address.
For example: gdv6l0viwo4l7j1d@marketplace.newegg.com
ShipToAddress1
String
The order will be shipped to address
ShipToAddress2
String
The order will be shipped to address line 2
ShipToCityName
String
The order will be shipped to city name
ShipToStateCode
String
The order will be shipped to state
ShipToZipCode
String
The order will be shipped to zip code
ShipToCountryCode
String
The order will be shipped to country.
Default values:
United States
170
ShippingCarrierCode
Integer
Shipping carrier.
Available shipping carrier code:
100 – Newegg Partnered Carrier (UPS). For more information,
please refer to section 11.1.5: Newegg Partnered Carrier- UPS.
200 – Newegg Partnered Carrier (FedEx). For more information,
please refer to section 11.1.6: Newegg Partnered Carrier- FedEx.
171
ShippingServiceCode
Integer
Available shipping service code:
If ShippingCarrierCode = 100:
101 – UPS Ground
102 – UPS 3 Day Select
103 – UPS 2nd Day Air
104 – UPS Next Day Air Saver
105 - UPS Next Day Air
106 - UPS Worldwide Saver
If ShippingCarrierCode = 200:
201 – FedEx Ground
202 – FedEx Home Delivery
203 – FedEx Priority Overnight
204 – FedEx Express Saver
205 – FedEx 2Day
206 – FedEx Standard Overnight
207 – FedEx International Economy
Note: if left this blank, a default shipping service will be assigned according
to the shipping service that the customer purchased on this order. The
default shipping service mapping as below:
If ShippingCarrierCode = 100:
Newegg Order
Shipping Method
Standard Shipping (57 business days)
Expedited Shipping (35 business days)
Default Mapped Service
UPS Ground
UPS 3 Day Select
Two-Day Shipping
UPS 2nd Day Air
One-Day Shipping
UPS Next Day Air Saver
If ShippingCarrierCode = 200:
Newegg Order
Shipping Method
Standard Shipping
(5-7 business days)
Expedited Shipping
(3-5 business days)
Default Mapped Service
FedEx Ground
FedEx Express Saver
Two-Day Shipping
FedEx 2Day
One-Day Shipping
FedEx Standard Overnight
NOTE: If the shipping request is for a Newegg Premier order, this field is
not able to specify and a cheapest shipping service will be assigned
172
automatically in terms of the shipping service that the customer purchased
on the order.
ShipmentStatus
String
Available shipment status:
ESTIMATING – you have successfully sent a request to estimate the
shipping cost but Newegg partnered carrier is in the process of the
estimation.
ESTIMATED – Newegg partnered carrier has completed shipping cost
estimation. You are able to confirm to ship the request.
ERROR_ESIMATING – An error encountered in the process of the
estimation.
CONFIRMING – you have successfully sent a request to confirm the
shipment but the confirmation process is not yet complete.
CONFIRMED – Your shipping has been confirmed. Note: You cannot void
the shipping request anymore.
ERROR_CONFIRMING – An error encountered in the process of confirming.
VOIDING – You have successfully sent a request to void a shipping request
but the voiding process has not yet complete.
VOIDED – The shipping request has confirmed to void, your account will
not be charged for the shipping cost.
ShipDate
String
The date when the shipping request confirmed
ErrorMessage
String
An error encountered in the process of the request.
Only has value when the ShipmentStatus = ERROR_ESTIMATING or
PartneredEstimate
ERROR_CONFIRMING
BillableWeight
Decima
The weight that the Newegg partnered carrier will bill to the shipment.
l
EstimatedDeliveryDay
String
The date that the Newegg partnered carrier will delivery the shipment.
EstimatedChargeAmoun
Decima
The amount that the Newegg partnered carrier will charge to the
t
l
shipment.
ShipFromFirstName
String
Contact person – first name
ShipFromLastName
String
Contact person – last name
ShipFromPhoneNumber
String
Contact person – contact phone number
ShipFromAddress1
String
Ship from address
ShipFromAddress2
String
Ship from address 2nd line if any
ShipFromCityName
String
Ship from city
ShipFromStateCode
String
Ship from state
ShpFromZipCode
String
Ship from zipcode
ShipFromCountryCode
String
Ship from country code in 3-digit fromat
* Currenlty the default value is USA.
173
SellerPart
Item
ItemList
Package
PackageList
TrackingNumber
String
Tracking number
String
Seller part number.
Integer
Item quantity
Number
Quantity
Example: XML, Response
XSD
API Schema > ShippingLabel > GetShippingRequest > ShippingDetailResponse.xsd
true
GetShippingDetailResponse
A006
2135751360
2PQBYWH4V68ZP
12/10/2015 14:38:17
WY SD
123-223-3223
gdv6l0viwo4l7j1d@marketplace.newegg.com
149 Kenwood Dr
Newcastle
WY
82701
UNITED STATES
100
101
CONFIRMED
12/25/2015
6.5
12/29/2015
21.94
174
Jon
Doe
6266171420
18045 Rowland Street
City Of Industry
CA
91748
USA
1Z8V016A0377769652
-
201307220000101
4
-
SARATEST0118
1
1Z8V016A0360430477
-
201307220000102
3
2PQBYWH4V68ZP
12/10/2015 14:38:17
WY SD
175
123-223-3223
gdv6l0viwo4l7j1d@marketplace.newegg.com
149 Kenwood Dr
Newcastle
WY
82701
UNITED STATES
100
101
CONFIRMED
12/25/2015
6.5
12/29/2015
21.94
Jon
Doe
6266171420
18045 Rowland Street
City Of Industry
CA
91748
USA
1Z8V016A0377769652
-
201307220000101
4
-
SARATEST0118
1
176
1Z8V016A0360430477
-
201307220000102
3
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetShippingDetailResponse",
"SellerID": "A006",
"ResponseBody": {
"OrderNumber": "2135751360",
"RequestList": {
"Request": [
{
"RequestID": "2PQBYWH4V68ZP",
"RequestDate": "12/10/2015 14:38:17",
"Shipment": {
"CustomerName": "WY SD",
"CustomerPhoneNumber": "123-223-3223",
"CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
"ShipToAddress1": "149 Kenwood Dr",
"ShipToCityName": "Newcastle",
"ShipToStateCode": "WY",
"ShipToZipCode": "82701",
"ShipToCountryCode": "UNITED STATES",
"ShippingCarrierCode": "100",
"ShippingServiceCode": "101",
177
"ShipmentStatus": "CONFIRMED",
"ShipDate": "12/25/2015",
"PartneredEstimate": {
"BillableWeight": "6.5",
"EstimatedDeliveryDay": "12/29/2015",
"EstimatedChargeAmount": "21.94"
},
"ShipFromFirstName": "Jon",
"ShipFromLastName": "Doe",
"ShipFromPhoneNumber": "6266171420",
"ShipFromAddress1": "18045 Rowland Street",
"ShipFromCityName": "City Of Industry",
"ShipFromStateCode": "CA",
"ShipFromZipCode": "91748",
"ShipFromCountryCode": "USA",
"PackageList": {
"Package": [
{
"TrackingNumber": "1Z8V016A0377769652",
"ItemList": {
"Item": [
{
"SellerPartNumber": "201307220000101",
"Quantity": "4"
},
{
"SellerPartNumber": "SARATEST0118",
"Quantity": "1"
}
]
}
},
{
"TrackingNumber": "1Z8V016A0360430477",
"ItemList": {
"Item": {
"SellerPartNumber": "201307220000102",
"Quantity": "3"
}
}
}
178
]
}
}
},
{
"RequestID": "2PQBYWH4V68ZP",
"RequestDate": "12/10/2015 14:38:17",
"Shipment": {
"CustomerName": "WY SD",
"CustomerPhoneNumber": "123-223-3223",
"CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
"ShipToAddress1": "149 Kenwood Dr",
"ShipToCityName": "Newcastle",
"ShipToStateCode": "WY",
"ShipToZipCode": "82701",
"ShipToCountryCode": "UNITED STATES",
"ShippingCarrierCode": "100",
"ShippingServiceCode": "101",
"ShipmentStatus": "CONFIRMED",
"ShipDate": "12/25/2015",
"PartneredEstimate": {
"BillableWeight": "6.5",
"EstimatedDeliveryDay": "12/29/2015",
"EstimatedChargeAmount": "21.94"
},
"ShipFromFirstName": "Jon",
"ShipFromLastName": "Doe",
"ShipFromPhoneNumber": "6266171420",
"ShipFromAddress1": "18045 Rowland Street",
"ShipFromCityName": "City Of Industry",
"ShipFromStateCode": "CA",
"ShipFromZipCode": "91748",
"ShipFromCountryCode": "USA",
"PackageList": {
"Package": [
{
"TrackingNumber": "1Z8V016A0377769652",
"ItemList": {
"Item": [
{
"SellerPartNumber": "201307220000101",
179
"Quantity": "4"
},
{
"SellerPartNumber": "SARATEST0118",
"Quantity": "1"
}
]
}
},
{
"TrackingNumber": "1Z8V016A0360430477",
"ItemList": {
"Item": {
"SellerPartNumber": "201307220000102",
"Quantity": "3"
}
}
}
]
}
}
}
]
}
}
}
11.2.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SL013
Cannot find shipping request:{[request ID]}
Example: XML, Response
SL001
180
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SL001",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
11.3. Confirm Shipping Request
Once a shipping estimate is avaiable, you must confirm it when you are ready to ship.
Please note: once a shipping request is confirmed, Newegg will continue to process the order and the status of order will
soon become “Shipped”. Also, the shipping information will be displayed in Order Detail under the customer’s My Account
section, and Newegg also send the customer an email notification with all of the shipping information.
Once a shipping request is confirmed, the revoke of the operation is not available.
11.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/shippingservice/shippinglabel/confirmshippingrequest?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
10 per min per client
Resource Information
11.3.2. Request Body
Fixed values:
t
String
s
Yes
e
Description
u
Format
q
Required?
e
R
I
P
g
g
e
A
w
OperationType
e
N
Attribute
181
RequestBody
RequestIDList
ConfirmShippingRequest
RequestID
Yes
String
The shipping request ID
Example: XML, Request
XSD
API Schema > ShippingLabel > ConfirmShippingRequest > ShippingComfirmRequest.xsd
POST
https://api.newegg.com/marketplace/shippingservice/shippinglabel/confirmshippingrequest?sellerid=
{sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
ConfirmShippingRequest
2PQBYWH4V68ZP
2PQCX3SPZ3QBF
Example: Json, Request
POST
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingrequest?sellerid={seller
id}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
182
"OperationType": "ConfirmShippingRequest",
"RequestBody": {
"RequestIDList":{
"RequestID": [
"2PQBYWH4V68ZP",
"2PQCX3SPZ3QBF"
]
}
}
}
11.3.3. Response Body
Attribute
Format
Description
IsSuccess
String
Used to identify the operation of Get feed status is successful
String
Fixed value: ConfirmShippingResponse
SellerID
String
Your seller ID
RequestID
String
The Identifier of a submission
RequestDate
String
Request date.
RequestStatus
String
The status of the request submission.
RequestIDList
OperationType
ResponseBody
NeweggAPIResponse
True or False
CONFIRMING
Example: XML, Response
XSD
API Schema > ShippingLabel > ConfirmShippingRequest > ShippingComfirmResponse.xsd
true
ConfirmShippingResponse
A006
2PQBYWH4V68ZP
2PQCX3SPZ3QBF
183
12/06/2015 10:21:00
CONFIRMING
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "ConfirmShippingResponse",
"SellerID": "A006",
"ResponseBody": {
"RequestIDList": {
"RequestID": [
"2PQBYWH4V68ZP",
"2PQCX3SPZ3QBF"
]
},
"RequestDate": "12/06/2015 10:21:00",
"RequestStatus": "CONFIRMING"
}
}
11.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SL014
This shpping request cannot be confirmed. The shipping request has not estimated, Please submit estimate
shipping cost request first.
SL017
Request {request ID} cannot be submitted because the shipping request has {confirmed | voided}. Please revise
the request list and submit again.
SL024
Invalid Request ID
Example: XML, Response
184
SL001
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SL001",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
11.4. Void Shipping Request
An unconfirmed shipping request can be void using this function.
11.4.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/shippingservice/shippinglabel/voidshippingrequest?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
10 per min per client
Resource Information
11.4.2. Request Body
est
equ
APIR
OperationType
egg
New
Attribute
Required?
Format
Description
Yes
String
Fixed values:
VoidShippingRequest
185
Yes
String
Shipping request ID
RequestIDList
RequestBody
RequestID
Example: XML, Request
XSD
API Schema > ShippingLabel > VoidShippingRequest > ShippingVoidRequest.xsd
POST
https://api.newegg.com/marketplace/shippingservice/shippinglabel/voidshippingrequest?sellerid={se
llerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
VoidShippingRequest
2PQBYWH4V68ZP
2PQCX3SPZ3QBF
Example: Json, Response
https://api.newegg.com/marketplace/shippingservice/shippinglabel/voidshippingrequest?sellerid={se
llerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "VoidShippingRequest",
"RequestBody": {
"RequestIDList": {
186
"RequestID": [
"2PQBYWH4V68ZP",
"2PQCX3SPZ3QBF"
]
}
}
}
11.4.3. Response Body
Attribute
Format
Description
IsSuccess
String
Used to identify the operation of Get feed status is successful
String
Fixed value: ConfirmShippingResponse
SellerID
String
Your seller ID
RequestID
String
The Identifier of a submission
RequestDate
String
Request date.
RequestStatus
String
The status of the request submission.
RequestIDList
OperationType
ResponseBody
NeweggAPIResponse
True or False
VOIDING
Example: XML, Response
XSD
API Schema > ShippingLabel > VoidShippingRequest > ShippingVoidResponse.xsd
true
VoidShippingResponse
A006
2PQBYWH4V68ZP
2PQCX3SPZ3QBF
12/06/2015 10:21:00
VOIDING
187
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "VoidShippingResponse",
"SellerID": "A006",
"ResponseBody": {
"RequestIDList": {
"RequestID": [
"2PQBYWH4V68ZP",
"2PQCX3SPZ3QBF"
]
},
"RequestDate": "12/06/2015 10:21:00",
"RequestStatus": "CONFIRMING"
}
}
11.4.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SL017
Request {request ID} cannot be submitted because the shipping request has {confirmed | voided}. Please revise
the request list and submit again.
Example: XML, Response
SL001
Order Number should be an integer (ranging from 1 to 2147483647)
188
Example: Json, Response
{
"Code": "SL001",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
11.5. Get Package List
When you are ready to ship an order, you can request a packge list using this function.
11.5.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/shippingservice/shippinglabel/packagelist?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
10 per min per client
Resource Information
11.5.2. Request Body
OperationType
Required?
Format
Description
Yes
String
Fixed values:
GetPackageListRequest
RequestID
YES if OrderNumber
String
The shipping request ID
String
The order number.
is not available
y
RequestBod
NeweggAPIRequest
Attribute
OrderNumber
YES if no RequestID
is not available
189
Example: XML, Request
XSD
API Schema > ShippingLabel > GetPackageList > GetPackageListRequest.xsd
PUT
https://api.newegg.com/marketplace/shippingservice/shippinglabel/packagelist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetPackageListRequest
2PQCX3SPZ3QBF
Example: Json, Request
PUT
https://api.newegg.com/marketplace/shippingservice/shippinglabel/packagelist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetPackageListRequest",
"RequestBody": {
"RequestID": "2PQCX3SPZ3QBF"
}
}
11.5.3. Response Body
nse
APIR
espo
IsSuccess
egg
New
Attribute
Format
Description
String
Used to identify the operation of Get feed status is successful
True or False
190
String
Fixed value: GetPackageListResponse
SellerID
String
Your seller ID
String
Related order number
String
The Identifier of a submission
String
The PDF document URL for package list
RequestID
File
pdfFileList
Request
OrderNumber
RquestList
ResponseBody
OperationType
Example: XML, Response
XSD
API Schema > ShippingLabel > GetPackageList > GetPackageListResponse.xsd
true
GetPackageListResponse
A006
423423678
2PQBYWH4V68ZP
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
2PQBYWH4V68ZP
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
191
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetPackageListResponse",
"SellerID": "A006",
"ResponseBody": {
"OrderNumber": "423423678",
"RequestList": {
"Request": [
{
"RequestID": "2PQBYWH4V68ZP",
"PdfFileList": {
"File": [
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf",
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf"
]
}
},
{
"RequestID": "2PQBYWH4V68ZP",
"PdfFileList": {
"File": [
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf",
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf"
]
}
}
]
}
}
}
192
11.5.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SL018
Invalid request. OrderNumber or RequestId is required.
Example: XML, Response
SL001
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SL001",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
11.6. Get Shipping Labels
When you are ready to ship an order, you can request a shipping label for a confirmed shipping request.
11.6.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippinglabels?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
193
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
10 per min per client
11.6.2. Request Body
OperationType
Required?
Format
Description
Yes
String
Fixed values:
GetShippingLabelRequest
RequestID
YES if OrderNumber is
String
The shipping request ID
String
The order number.
not available
y
RequestBod
NeweggAPIRequest
Attribute
OrderNumber
YES if no RequestID is
not available
Example: XML, Request
XSD
API Schema > ShippingLabel > GetShippingLabels > GetShippingLabelRequest.xsd
PUT
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippinglabels?sellerid={selleri
d}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetShippingLabelRequest
2PQCX3SPZ3QBF
Example: Json, Request
PUT
https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippinglabels?sellerid={selleri
d}
Authorization: 720ddc067f4d115bd544aff46bc75634
194
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetShippingLabelRequest",
"RequestBody": {
"RequestID": "2PQCX3SPZ3QBF"
}
}
11.6.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is successful
OperationType
String
Fixed value: GetShippingLabelResponse
SellerID
String
Your seller ID
String
Related order number.
String
The Identifier of a submission
String
The PDF document URL for printing package or shipping labels.
RequestID
File
pdfFileList
Request
OrderNumber
RquestList
ResponseBody
NeweggAPIResponse
True or False
Example: XML, Response
XSD
API Schema > ShippingLabel > GetShippingLabels > GetShippingLabelResponse.xsd
true
GetShippingLabelResponse
A006
423423678
195
2PQBYWH4V68ZP
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
2PQBYWH4V68ZP
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba4c7e-99c9-94025bc7577e.pdf
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetShippingLabelResponse",
"SellerID": "A006",
"ResponseBody": {
"OrderNumber": "423423678",
"RequestList": {
"Request": [
{
"RequestID": "2PQBYWH4V68ZP",
"PdfFileList": {
"File": [
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf",
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf"
]
}
196
},
{
"RequestID": "2PQBYWH4V68ZP",
"PdfFileList": {
"File": [
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf",
"http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c994025bc7577e.pdf"
]
}
}
]
}
}
}
11.6.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SL018
Invalid request. OrderNumber or RequestId is required.
Example: XML, Response
SL001
Order Number should be an integer (ranging from 1 to 2147483647)
Example: Json, Response
{
"Code": "SL001",
"Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
}
197
12. DataFeed Management
The Newegg DataFeed API lets you uploading item creation/update, item inventory and order ship notice to Newegg
Systems and return result in XML/Json format. You can also use the Newegg DataFeed API to get processing status
and report(s).
The process for submitting feeds is as follows:
1.
Submit an XML request using the SubmitFeed operation along with all required metadata, including a value from the
FeedType list. Current available data feed types:
Creating item list or updating existing item information.
Updating inventory
Updating price
Updating order shipping information.
Create orders with other platforms other than Newegg Marketplace. This is only available for SBN (Shipped by
Newegg) sellers.
2.
Batch submit/update Subscribe & Save items.
Submit/update volume discount items in batch.
Batch deal submission requests.
Batch mark Newegg Premier Items.
Adding warranty services for refurbished and used items.
Update CA Prop. 65 warning for items in batch.
Setting up tax type for items enabled for China in batch.
As with all submissions to Newegg Marketplace API, you must also include authentication information. The
SubmitFeed operation returns a RequestID, which you can use to periodically check the status of the feed using the
GetFeedsStatus operation.
3.
If Newegg Marketplace API is still processing a request, the RequestStatus element of theGetFeedsStatus operation
returns a status of IN_PROGRESS. If the processing is complete, a status of FINISHED is returned.
4.
When the feed processing is complete, you can use the GetFeedResult operation to receive a processing report that
describes which records in the feed were successful and which records generated errors.
5.
Analyze the processing report, correct any errors in the transmission, and resubmit the feed using the SubmitFeed
operation. Repeat the process until there are no errors in the processing report to complete your updates.
6.
Please download the XSD’s and XML sample files for different feed types from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip. You can also contact
Newegg Marketplace Integration team: Datafeeds@newegg.com for assistance.
198
12.1.
Submit Feed
12.1.1. Resource URL & Information
Resource URL
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 Request Type) and cannot contain any blank
spaces or line breaks.
Parameters
Name
Required?
Description
sellerId
Yes
Your seller ID on Newegg Marketplace
requesttype
Yes
The feed type which you want to submit to our system, which determines
the action you want to perform through datafeed systems.
Current support following types:
ITEM_DATA –
-
Batch creating item / update item / replace or append item image(s)
based on specified subcategories.
-
Batch item creation by matching the existing items in Newegg
catalog. The main intent of this approach is to let sellers listing an item
using ISBN, UPC, Manufacturer Part Number, or Newegg Item Number
without specifying sub-category related information. This helps sellers
creating the items more quickly.
-
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. Complete list of common fields listed in section 11.1.2
INVENTORY_DATA - Through this type you can batch update inventory for
Newegg International program.
PRICE_DATA - Through this type you can batch update price for additional
countries for Newegg International program.
ORDER_SHIP_NOTICE_DATA - Through this type you can batch ship order.
199
MULTICHANNEL_ORDER_DATA – Through this type you can batch creating
multi-channel orders that are not placed on Newegg.com, orders that will
be SBN (Shipped by Newegg).
ITEM_SUBSCRIPTION – Through this type you can batch adding or
removing Subscription & Save items.
VOLUME_DISCOUNT_DATA - Through this type you can batch
create/update/delete volume discount.
ITEM_PROMOTION_DATA - Through this type you can batch create item
promotion requests.
ITEM_PREMIER_MARK_DATA – Through this type you can batch add /
remove items for Newegg Premier Program
ITEM_WARRANTY_DATA – Adding Warranty Services for Items
ITEM_CAPROP65_DATA – Adding California’s Proposition 65 (“Prop
65”)Warnings for Items
ITEM_CHINATAXSETTING_DATA – Setting up tax type for items enabled for
China in batch.
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
POST
Required
XML, Json
XML, Json
Request Type
Rate Limited
Maximum Size of Request
ITEM_DATA
Max. 10 requests per min per
Max. 30,000 records per file and each file cannot exceed
client
20MB. Limit 30,000 records per hour.
PRICE_DATA
Max. 10 requests per min per
Max. 10,000 records per file. Limit 100,000 records per
ITEM_CHINATAXSETTING_DAT
client
hour.
INVENTORY_DATA
A
ORDER_SHIP_NOTICE_DATA
MULTICHANNEL_ORDER_DATA
ITEM_SUBSCRIPTION
VOLUME_DISCOUNT_DATA
Max. 100 requests per min per
client
Max. 10,000 records per file. Limit 30,000 records per hour.
ITEM_PROMOTION_DATA
200
ITEM_PREMIER_MARK_DATA
ITEM_WARRANTY_DATA
ITEM_CAPROP65_DATA
12.1.2. Request Body
ITEM_DATA (Create, Update Item Info)
There are several options available:
1.
Batch creating item / update item / replace or append image to item(s) based on different sub-categories. For each
subcategory, there’s a category structure schema that needs to be followed (different subcategory requires different property
input per item). You can download these schemas by logging into Seller Portal and select Manage Items -> Batch Item
Creation/Update -> The tab of Download File Template Batch -> Select “Batch Item Creation” from the drop-down options of
Action-> Select Extensible Markup Language (.XML) file format-> select the industry from the drop-down list.
2.
Batch item creation by matching the existing items in Newegg catalog. The main intent of this approach is to let sellers listing
an item using ISBN, UPC, Manufacturer Part Number, or Newegg Item Number without specifying sub-category related
information. This helps sellers creating the items more quickly.
3.
Batch updating the basic information for items without specifying item subcategory. This template can only be used to update
common fields (not subcategory specific fields).
CANNOT exceed 7,000 items or total file size cannot exceed 10 MB per request.
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
The following information provides Attribute Definitions and the corresponding XML example.
Batch creating item / update item / replace or append image to item(s) based on different sub-categories
DocumentVersion
Decimal
MessageType
String
SubCategoryID
Description
The identifier for the version of current
datafeed; assigned by Newegg
BatchItemCreation
Required
Y
Y
Identify the category specification. There is
d
e
Itemfee
Format
Messag
Attribute
String
only one category can be used for any single
Y
item.
201
NOTE: Once an item is created, this
Action
Specify the action you would like to perform.
-
Enter "Create Item" if you want to list a
new product that is not currently in your
item list.
-
Enter "Update Item" to 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)
-
Enter "Update/Append Image" to
upload additional image(s) of the
String
product or overwrite existing image(s).
-
Enter "Replace Image" to replace all of
N
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 ignored.
If no value was entered for this field, by
default the system will do the following:
-
If item currently does not exist in your
item list, we will treat it as if you
entered “Create Item”.
BasicInfo
Item
information cannot be updated.
A seller-defined unique identifier for an item.
An alphanumeric string, max 40 characters
SellerPartNumber
String
including space.
Y
NOTE: Once an item is created, this
information cannot be updated.
The manufacturer name for the item. You
must use a pre-defined value from our system
or request the addition of a new value from
Manufacturer
String
the
Content
Team
at
Y
mktp.content@newegg.com.
NOTE: Once an item is created, this
information cannot be updated.
202
ManufacturerPartNumberOrISBN
String
Manufacturer defined unique identifier for an
Required
item. An alphanumeric string, max 20
if item
characters including space.
NOTE: Once an item is created, this
information cannot be updated.
A unique Universal Product Code (UPC) (12
characters only) or European Article Number
UPC
String
(EAN)(13 characters only) for an item. A
numeric string, max 40 characters.
NOTE: Once an item is created, this
information cannot be updated.
UPC code
is not
provided
Required
if item
Manufact
urer Part
# / ISBN
is not
provided
If the item is a variant of another ("related")
item with its own seller part #, list the related
item's seller part # here. This is required for
RelatedSellerPartNumber
String
the variant item to display under a single
product page. An alphanumeric string, max
N
20 characters including space.
NOTE: Once an item is created, this
information cannot be updated.
The short, easily identifiable item name for
this item. It will be used as the main name for
WebsiteShortTitle
String
your product on all store pages, Sales Orders
Y
and receipts, so should not contain variables.
Maximum characters: 200.
Enter concise descriptions of selected
product features or functions which will be
listed by bullet point below the website
BulletDescription
String
short/long title on the product page.
N
Use separator “^^” to separate different
points. Maximum characters: 200, including
spaces and separators. NO HTML is allowed.
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
ProductDescription
String
family. (4000 character limit.)
Y
Accepted HTML for Product Description
fields.
Only ,, - ,
, ,
, , , , , ,
are allowed.
203
ItemDimension
ItemWeight
ItemLength
Decimal
Individual unit shipping length in inches
N
ItemWidth
Decimal
Individual unit shipping width in inches
N
ItemHeight
Decimal
Individual unit shipping height in inches
N
Decimal
Individual unit shipping weight in lb.
Y
Available values for Item Condition:
• New: This means the product will ship as
received by the manufacturer, sealed, with all
advertised
components,
and
with
the
manufacturer warranty.
• Refurbished: This means the product was
tested and repaired as required to meet the
standards of the refurbisher, which may or
may not be the original manufacturer. Any
exceptions to the condition of the item
outside the manufacturer’s information
should be provided in the listing, up to and
including warranty details.
The following values are only apply to U.S.
Marketplace:
• UsedLikeNew: This means that the product
ItemCondition
String
has been opened, possibly used but is in
N
perfect factory condition with no signs of
cosmetic or functional defect. Product
includes warranty, and accessories found
with the original product. Product may or
may not be in the original packaging.
Returned items with minor packaging defects
fall under this category.
• UsedVeryGood: This means that the
product has been opened, may show slight
signs of use and cosmetic blemish, and may
be missing minor accessories, but remain in
excellent condition. Product does not come
with warranty unless stated otherwise in
product description.
• UsedGood: This means that the product has
been used, may show clear signs of use and
may be missing minor accessories, but
204
remain in good condition. Product does not
come with warranty unless stated otherwise
in product description.
• UsedAcceptable: This means that the
product shows clear signs of use, cosmetic
defect, and may be missing minor accessories
and manual, but remain in working condition.
Product does not come with warranty unless
stated otherwise in product description.
Functionality issues beyond signs of use
should be disclosed in product description.
NOTE: Once an item is created, this
information cannot be updated.
Identify the package count of this product. All
products in a pack or set will have matching
PacksOrSets
Integer
item and condition.
Y
NOTE: Once an item is created, this
information cannot be updated.
ItemPackage
String
ShippingRestriction
String
Currency
String
Available value to identify the package of
product
Identify if there is any shipping restriction for
product
The form of money for all price related
elements. Default value: USD
N
Y
N
The default anufacturer's suggested retail
price for the product for the United States.
MSRP
Decimal
If you want to remove MSRP, input “0.00” or
N
‘0’ in this field. If null, no change to current
setting.
The default Minimum advertised price for the
United States.
If the Selling Price is below the defined MAP,
MAP
Decimal
the website will ask customer to add item to
shopping cart to see the item's price.
N
If you want to remove MAP, input “0.00” or
‘0’ in this field. If null, no change to current
setting.
Regardless the Selling Price and the value
CheckoutMAP
String
inputted in MAP field, if the Checkout MAP is
marked as True, then the website will ask
N
customer to add item to shopping cart AND
205
go to checkout page to see the item's price.
This is the default setting of the United of
states.
SellingPrice
Decimal
Shipping
String
The default selling price for the United States.
The default shipping charge setting for this
item for the United States.
Y
Y
The inventory quantity available for the only
warehouse location.
Inventory
Integer
NOTE: If multiple warehouses are available,
Please submit International Program- Update
Inventory
requests/feeds
to
Y
manage
inventory.
The ActivationMark's default setting is "True"
on all uploaded products for United States. All
ActivationMark
String
products must be activated to be visible on
N
Newegg.com United States. You may set it to
Enter the URL for this item's product images.
Image
ItemImages
"False" if you wish to deactivate your product.
All URLs must be a direct link to the actual
image. Image file must be (.jpg or .jpeg). An
alphanumeric
ImageUrl
String
string;
2000
characters
maximum in length.
Minimum image size: 640 pixels width and
Y
480 pixels height.
The maximum file size for each image is 5MB.
All files larger than the 5MB limit will fail to
process.
IsPrimary
Boolean
The identifier to specify the default image, if
multiple images will be uploaded.
N
Information related to the condition, not
including New or Refurbished, of the product
ConditionDetails
String
can be described here to help customer
understanding the product.
N
NOTE: This information only apply to U.S.
Marketplace
206
Image
UsedItemImages
Item images of your item to better describe
the characteristics of used condition. This
image(s) should not be images of a new item.
Enter the URL for the USED item's specified
product images. All URLs must be a direct link
to the actual image. Image file must be (.jpg
ImageUrl
String
or .jpeg)
Minimum image size: 640 pixels width and
N
480 pixels height.
The maximum file size for each image is 5MB.
All files larger than the 5MB limit will fail to
process.
NOTE: This information only apply to U.S.
Marketplace
The identifier to specify the default image, if
IsPrimary
Boolean
multiple images will be uploaded.
NOTE: This information only apply to U.S.
N
Warning
Marketplace
Prop65
String
Prop65Motherboard
String
Used if the product is subject to prop 65
regulations in California.
Used if the product is motherboard related
subject to prop 65 regulations in California.
N
N
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
CountryOfOrigin
String
following:
N
http://en.wikipedia.org/wiki/ISO_31661_alpha-3
Please note: this value is required if you
intend to sell your items globally through
Newegg.
Used if the product contains graphics or adult
OverAge18Verification
String
content that is inappropriate for person
N
under 18 years old.
207
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
ChokingHazard
String
product "contains" a small ball or marble
should not apply simultaneously with the
N
corresponding warning that a product "is" a
small ball or marble.
Please refer to Consumer product Safety
Improvement Act of 2008 (CPSIA) for more
information.
Section
containing
category-specific
information such as properties. Reference the
SubCategoryProperty
Vary
following XSDs to complete the Product Data
Y
section (only one category can be used for a
given item).
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > Itemfeed.xsd and sub-category.xsd
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
1.0
BatchItemCreation
13905
-
208
Create Item
JACKETEST0921001002
AMD
JACKETEST0921001002
Sick1111111
hello222222
4
5
6
3
1
New
OEM
Yes
USD
500
100
Free
100
True
http://10.1.24.143:4567/images/20.gif
No
Yes
Yes
Yes
Is a small ball
Yes
Is a marble
209
String
String
Male
Adult
Blood & Gore
Animals & Insects
1st Birthday
#10
String
String
String
-
Create Item
JACKETEST0921001003
AMD
JACKETEST0921001003
Sick1111111
hello222222
4
5
6
5
1
UsedGood
OEM
Yes
USD
500
210
100
Free
100
True
http://10.1.24.143:4567/images/20.gif
Works fine, almost like new, missing original plastics
cover.
http://10.1.24.143:4567/images/Used.gif
No
Yes
Yes
Yes
Is a small ball
Yes
Is a marble
String
String
Male
Adult
Blood & Gore
Animals & Insects
1st Birthday
#10
String
String
String
211
-
Create Item
JACKETEST0921001004
AMD
JACKETEST0921001004
Sick1111111
hello222222
4
5
6
3
1
New
OEM
Yes
USD
500
100
Free
100
True
http://10.1.24.143:4567/images/20.gif
No
Yes
USA
Yes
212
Yes
Is a small ball
Yes
Is a marble
String
String
Male
Adult
Blood & Gore
Animals & Insects
1st Birthday
#10
String
String
String
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": "1.0" },
"MessageType": "BatchItemCreation",
213
"Message": {
"Itemfeed": {
"SummaryInfo": { "SubCategoryID": "13905" },
"Item": [
{
"Action": "Create Item",
"BasicInfo": {
"SellerPartNumber": "JACKETEST0921001002",
"Manufacturer": "AMD",
"ManufacturerPartNumberOrISBN": "JACKETEST0921001002",
"WebsiteShortTitle": "Sick1111111",
"ProductDescription": "hello222222",
"ItemDimension": {
"ItemLength": "4",
"ItemWidth": "5",
"ItemHeight": "6"
},
"ItemWeight": "3",
"PacksOrSets": "1",
"ItemCondition": "New",
"ItemPackage": "OEM",
"ShippingRestriction": "Yes",
"Currency": "USD",
"MSRP": "500",
"SellingPrice": "100",
"Shipping": "Free",
"Inventory": "100",
"ActivationMark": "True",
"ItemImages": {
"Image": { "ImageUrl": "http://10.1.24.143:4567/images/20.gif" }
},
"Warning": {
"Prop65": "No",
"Prop65Motherboard": "Yes",
"OverAge18Verification": "Yes",
"ChokingHazard": {
"SmallParts": "Yes",
"SmallBall": "Is a small ball",
"Balloons": "Yes",
"Marble": "Is a marble"
}
214
}
},
"SubCategoryProperty": {
"CostumeAccessories": {
"CostumeAccBrand": "String",
"CostumeAccModel": "String",
"CostumeAccGender": "Male",
"CostumeAccAge": "Adult",
"CostumeAccType": "Blood & Gore",
"CostumeAccTheme": "Animals & Insects",
"CostumeAccOccasion": "1st Birthday",
"CostumeAccSize": "#10",
"CostumeAccColor": "String",
"CostumeAccMaterial": "String",
"CostumeAccCareInstructions": "String"
}
}
},
{
"Action": "Create Item",
"BasicInfo": {
"SellerPartNumber": "JACKETEST0921001003",
"Manufacturer": "AMD",
"ManufacturerPartNumberOrISBN": "JACKETEST0921001003",
"WebsiteShortTitle": "Sick1111111",
"ProductDescription": "hello222222",
"ItemDimension": {
"ItemLength": "4",
"ItemWidth": "5",
"ItemHeight": "6"
},
"ItemWeight": "5",
"PacksOrSets": "1",
"ItemCondition": "UsedGood",
"ItemPackage": "OEM",
"ShippingRestriction": "Yes",
"Currency": "USD",
"MSRP": "500",
"SellingPrice": "100",
"Shipping": "Free",
"Inventory": "100",
215
"ActivationMark": "True",
"ItemImages": {
"Image": { "ImageUrl": "http://10.1.24.143:4567/images/20.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",
"OverAge18Verification": "Yes",
"ChokingHazard": {
"SmallParts": "Yes",
"SmallBall": "Is a small ball",
"Balloons": "Yes",
"Marble": "Is a marble"
}
}
},
"SubCategoryProperty": {
"CostumeAccessories": {
"CostumeAccBrand": "String",
"CostumeAccModel": "String",
"CostumeAccGender": "Male",
"CostumeAccAge": "Adult",
"CostumeAccType": "Blood & Gore",
"CostumeAccTheme": "Animals & Insects",
"CostumeAccOccasion": "1st Birthday",
"CostumeAccSize": "#10",
"CostumeAccColor": "String",
"CostumeAccMaterial": "String",
"CostumeAccCareInstructions": "String"
}
}
},
{
"Action": "Create Item",
"BasicInfo": {
"SellerPartNumber": "JACKETEST0921001004",
"Manufacturer": "AMD",
216
"ManufacturerPartNumberOrISBN": "JACKETEST0921001004",
"WebsiteShortTitle": "Sick1111111",
"ProductDescription": "hello222222",
"ItemDimension": {
"ItemLength": "4",
"ItemWidth": "5",
"ItemHeight": "6"
},
"ItemWeight": "3",
"PacksOrSets": "1",
"ItemCondition": "New",
"ItemPackage": "OEM",
"ShippingRestriction": "Yes",
"Currency": "USD",
"MSRP": "500",
"SellingPrice": "100",
"Shipping": "Free",
"Inventory": "100",
"ActivationMark": "True",
"ItemImages": {
"Image": { "ImageUrl": "http://10.1.24.143:4567/images/20.gif" }
},
"Warning": {
"Prop65": "No",
"Prop65Motherboard": "Yes",
"CountryOfOrigin": "USA",
"OverAge18Verification": "Yes",
"ChokingHazard": {
"SmallParts": "Yes",
"SmallBall": "Is a small ball",
"Balloons": "Yes",
"Marble": "Is a marble"
}
}
},
"SubCategoryProperty": {
"CostumeAccessories": {
"CostumeAccBrand": "String",
"CostumeAccModel": "String",
"CostumeAccGender": "Male",
"CostumeAccAge": "Adult",
217
"CostumeAccType": "Blood & Gore",
"CostumeAccTheme": "Animals & Insects",
"CostumeAccOccasion": "1st Birthday",
"CostumeAccSize": "#10",
"CostumeAccColor": "String",
"CostumeAccMaterial": "String",
"CostumeAccCareInstructions": "String"
}
}
}
]
}
}
}
}
Batch item creation by matching the existing items in Newegg catalog
Attribute
Format
Description
Required
The identifier for the version of
DocumentVersion
Decimal
current datafeed; assigned by
Y
Newegg
String
BatchItemCreation
Y
A seller-defined unique identifier
BasicInfo
Item
Itemfeed
Message
MessageType
for an item. An alphanumeric
string,
SellerPartNumber
String
max
40
characters
including space
Y
NOTE: Once an item is created,
this
information
cannot
be
updated.
The manufacturer name for the
item. You must use a pre-defined
value from our system or request
Manufacturer
String
the addition of a new value from
the
Content
Team
at
Y
mktp.content@newegg.com.
NOTE: Once an item is created,
this
information
cannot
be
218
updated.
Manufacturer
identifier
ManufacturerPartNumberOrISBN
String
defined
for
an
unique
item.
An
alphanumeric string, max 20
Required if
characters including space.
item UPC is
NOTE: Once an item is created,
this
information
cannot
not provided
be
updated.
A unique Universal Product Code
(UPC) (12 characters only) or
European
Article
Number
(EAN)(13 characters only) for an
UPC
String
item. A numeric string, max 40
characters.
NOTE: Once an item is created,
this
information
cannot
be
Required if
item
Manufacturer
Part # / ISBN
is not
provided
updated.
Required if
neither UPC
NeweggItemNumber
String
Newegg’s unique identifier for an
item
or item
Manufacturer
Part # / ISBN
is not
provided
The form of money for all price
Currency
String
related elements. Default value:
N
USD
The
default
anufacturer's
suggested retail price for the
MSRP
Decimal
product for the United States.
If you want to remove MSRP,
N
input “0.00” or ‘0’ in this field. If
null, no change to current setting.
The default Minimum advertised
price for the United States.
If the Selling Price is below the
MAP
Decimal
defined MAP, the website will ask
customer to add item to shopping
N
cart to see the item's price.
If you want to remove MAP, input
“0.00” or ‘0’ in this field. If null, no
219
change to current setting. If the
Selling Price is below the defined
MAP,
the
website
will
ask
customer to add item to shopping
cart to see the item's price.
Regardless the Selling Price and
the value inputted in MAP field, if
the Checkout MAP is marked as
True, then the website will ask
CheckoutMAP
String
customer to add item to shopping
N
cart AND go to checkout page to
see the item's price. This is the
default setting of the United of
states.
SellingPrice
Decimal
The default selling price for the
United States.
The
Shipping
String
default
shipping
Y
charge
setting for this item for the United
Y
States.
The inventory quantity available
for the only warehouse location.
NOTE: If multiple warehouses are
Inventory
Integer
available,
Please
submit
Y
International Program- Update
Inventory
requests/feeds
to
manage inventory.
Available
values
for
Item
Condition:
• New: This means the product
will ship as received by the
manufacturer, sealed, with all
advertised components, and with
the manufacturer warranty.
ItemCondition
String
• Refurbished: This means the
Y
product was tested and repaired
as required to meet the standards
of the refurbisher, which may or
may
not
be
the
original
manufacturer. Any exceptions to
the condition of the item outside
the manufacturer’s information
220
should be provided in the listing,
up to and including warranty
details.
The following values are only
apply to U.S. Marketplace:
• UsedLikeNew: This means that
the product has been opened,
possibly used but is in perfect
factory condition with no signs of
cosmetic or functional defect.
Product includes warranty, and
accessories
found
with
the
original product. Product may or
may not be in the original
packaging. Returned items with
minor packaging defects fall
under this category.
• UsedVeryGood: This means
that the product
has been
opened, may show slight signs of
use and cosmetic blemish, and
may
be
accessories,
missing
but
minor
remain
in
excellent condition. Product does
not come with warranty unless
stated
otherwise
in
product
description.
• UsedGood: This means that the
product has been used, may show
clear signs of use and may be
missing minor accessories, but
remain
in
good
condition.
Product does not come with
warranty unless stated otherwise
in product description.
• UsedAcceptable: This means
that the product shows clear
signs of use, cosmetic defect, and
may be missing minor accessories
and manual, but remain in
221
working condition. Product does
not come with warranty unless
stated
otherwise
in
product
description. Functionality issues
beyond signs of use should be
disclosed in product description.
NOTE: Once an item is created,
this
information
cannot
be
updated.
Identify the package count of this
product. All products in a pack or
set will have matching item and
PacksOrSets
Integer
condition.
Y
NOTE: Once an item is created,
this
information
cannot
be
updated.
The
ActivationMark's
default
setting is "True" on all uploaded
products because all products
ActivationMark
String
must be activated to be visible on
N
Newegg websites. You may set it
to "False" if you wish to hide your
product.
Information
related
to
the
condition, not including New or
Refurbished, of the product can
ConditionDetails
String
be
described
customer
here
to
help
understanding
the
N
product.
NOTE: This information only
Item images of your item to
Image
UsedItemImages
apply to U.S. Marketplace
better
describe
the
characteristics of used condition.
This image(s) should not be
ImageUrl
String
images of a new item.
Enter the URL for the USED item's
N
specified product images. All
URLs must be a direct link to the
actual image. Image file must be
(.jpg or .jpeg)
222
Minimum image size: 640 pixels
width and 480 pixels height.
The maximum file size for each
image is 5MB. All files larger than
the 5MB limit will fail to process.
NOTE: This information only
apply to U.S. Marketplace
The identifier to specify the
default image, if multiple images
IsPrimary
Boolean
will be uploaded.
N
NOTE: This information only
apply to U.S. Marketplace
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ExistingFeed.xsd
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
2.0
BatchItemCreation
-
a006-test-008
Newegg
manu-008
123456789012
9SIAWE50389435
USD
223
99.99
True
9.99
Default
99
UsedGood
1
True
Works fine, almost like new, missing original plastics
cover
http://10.1.24.143:4567/images/Used.gif
-
a006-test-009
Newegg
manu-009
123456789012
9SIAWE50389434
USD
99.99
9.99
Default
99
New
1
True
-
224
a006-test-010
Newegg
manu-010
123456789012
9SIAWE50389432
USD
99.99
9.99
Default
99
New
True
1
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": "2.0" },
"MessageType": "BatchItemCreation",
"Message": {
"Itemfeed": [
{
"Item": [
{
"BasicInfo": {
"SellerPartNumber": "a006-test-008",
"Manufacturer": "Newegg",
225
"ManufacturerPartNumberOrISBN": "manu-008",
"UPC": "123456789012",
"NeweggItemNumber": "9SIAWE50389435",
"Currency": "USD",
"MSRP": "99.99",
"MAP": "5.00",
"CheckoutMAP": "True",
"SellingPrice": "9.99",
"Shipping": "Default",
"Inventory": "99",
"ItemCondition": "UsedGood",
"PacksOrSets": "1",
"ActivationMark": "True",
"ConditionDetails": " Works fine, almost like new, missing original plastics cover
",
"UsedItemImages": {
"Image": { "ImageUrl": "http://10.1.24.143:4567/images/Used.gif" }
}
}
},
{
"BasicInfo": {
"SellerPartNumber": "a006-test-009",
"Manufacturer": "Newegg",
"ManufacturerPartNumberOrISBN": "manu-009",
"UPC": "123456789012",
"NeweggItemNumber": "9SIAWE50389434",
"Currency": "USD",
"MSRP": "99.99",
"MAP": "5.00",
"SellingPrice": "9.99",
"Shipping": "Default",
"Inventory": "99",
"ItemCondition": "New",
"PacksOrSets": "1",
"ActivationMark": "True"
}
}
]
},
{
226
"Item": {
"BasicInfo": {
"SellerPartNumber": "a006-test-010",
"Manufacturer": "Newegg",
"ManufacturerPartNumberOrISBN": "manu-010",
"UPC": "123456789012",
"NeweggItemNumber": "9SIAWE50389432",
"Currency": "USD",
"MSRP": "99.99",
"MAP": "5.00",
"SellingPrice": "9.99",
"Shipping": "Default",
"Inventory": "99",
"ItemCondition": "New",
"ActivationMark": "True",
"PacksOrSets": "1"
}
}
}
]
}
}
}
Batch updating the basic information for items without specifying item subcategory
Decimal
MessageType
String
Item
DocumentVersion
Itemfeed
Format
Message
Attribute
Description
The identifier for the version of current datafeed;
assigned by Newegg
BatchItemCreation
Require
d
Y
Y
Specify the action you would like to perform.
Action
String
Enter "Update Item" to update the
information of a product already in your item
list (does not include updating of pricing fields:
Y
Currency, MSRP, MAP, Selling Price, Shipping,
Inventory and Activation Mark)
227
-
Enter "Update/Append Image" to upload
additional image(s) of the product or overwrite
existing image(s).
-
Enter "Replace Image" to 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,
A seller-defined unique identifier for an item. An
SellerPartNumber
String
alphanumeric string, max 40 characters including
Y
space
The short, easily identifiable item name for this
item. It will be used as the main name for your
WebsiteShortTitle
String
product on all store pages, Sales Orders and
N
receipts, so should not contain variables. Maximum
characters: 200.
Enter concise descriptions of selected product
features or functions which will be listed by bullet
point below the website short/long title on the
BulletDescription
String
product page.
An alphanumeric string. Use separator “^^” to
N
separate different points. Maximum characters:
200, including spaces and separators. NO HTML is
allowed.
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
ProductDescription
String
items in product family. (4000 character limit.)
N
Accepted HTML for Product Description fields.
Only ,, - ,
, , , , ,
, , , are allowed.
ItemDimension
BasicInfo
including Selling Price, will be ignored.
ItemLength
Decimal
Individual unit shipping length in inches
N
ItemWidth
Decimal
Individual unit shipping width in inches
N
ItemHeight
Decimal
Individual unit shipping height in inches
N
Decimal
Individual unit shipping weight in lb.
Y
ItemWeight
The ActivationMark's default setting is "True" on all
ActivationMark
String
uploaded products because all products must be
N
activated to be visible on Newegg websites. You may
228
set it to "False" if you wish to deactivate your
Enter the URL for this item's product images.
Image
ItemImages
product.
All
URLs must be a direct link to the actual image. Image
file must be (.jpg or .jpeg). An alphanumeric string;
ImageUrl
String
2000 characters maximum in length.
Minimum image size: 640 pixels width and 480
N
pixels height.
The maximum file size for each image is 5MB. All
files larger than the 5MB limit will fail to process.
IsPrimary
Boolean
The identifier to specify the default image, if
multiple images will be uploaded.
N
Information related to the condition, not including
New or Refurbished, of the product can be
ConditionDetails
String
described here to help customer understanding the
product.
N
NOTE: This information only apply to U.S.
Item images of your item to better describe the
Image
UsedItemImages
Marketplace
characteristics of used condition. This image(s)
should not be images of a new item.
Enter the URL for the USED item's specified product
images. All URLs must be a direct link to the actual
ImageUrl
String
image. Image file must be (.jpg or .jpeg)
Minimum image size: 640 pixels width and 480
N
pixels height.
The maximum file size for each image is 5MB. All
files larger than the 5MB limit will fail to process.
NOTE: This information only apply to U.S.
Marketplace
The identifier to specify the default image, if
IsPrimary
Boolean
multiple images will be uploaded.
NOTE: This information only apply to U.S.
N
Warning
Marketplace
Prop65
String
Prop65Motherboard
String
CountryOfOrigin
String
Used if the product is subject to prop 65 regulations
in California.
Used if the product is motherboard related subject
to prop 65 regulations in California.
Country of Origin is the country of manufacture/
production of your items. Newegg only accept ISO
N
N
N
229
standard three-letter codes for the various countries
of the world. For complete list, please refer to the
following: http://en.wikipedia.org/wiki/ISO_31661_alpha-3
Please note: this value is required if you intend to
sell your items globally through Newegg.
Used if the product contains graphics or adult
OverAge18Verification
String
content that is inappropriate for person under 18
N
years old.
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
ChokingHazard
String
small
ball
or
marble
should
not
apply
N
simultaneously with the corresponding warning
that a product "is" a small ball or marble.
Please
refer
to
Consumer
product
Safety
Improvement Act of 2008 (CPSIA) for more
information.
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ItemUpdate.xsd
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
3.0
BatchItemCreation
-
230
Update Item
A006Leon_Test_001
Test for Leon
Test for Leon
2.0
2.0
2.0
2.0
False
url
True
Works fine, almost like new, missing original plastics cover
http://10.1.24.143:4567/images/Used.gif
No
Yes
USA
No
Yes
Is a small ball
Yes
Contains a marble
-
231
Update Item
A006Leon_Test_002
Test for Leon
Test for Leon
2.0
2.0
2.0
2.0
False
url
True
No
Yes
No
Yes
Is a small ball
Yes
Contains a marble
-
Update Item
A006Leon_Test_003
Test for Leon
Test for Leon
2.0
232
2.0
2.0
2.0
False
url
True
No
Yes
No
Yes
Is a small ball
Yes
Contains a marble
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" },
233
"MessageType": "BatchItemCreation",
"Message": {
"Itemfeed": {
"Item": [
{
"Action": "Update Item",
"BasicInfo": {
"SellerPartNumber": "A006Leon_Test_001",
"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": "url",
"IsPrimary": "True"
}
},
"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"
}
}
}
},
234
{
"Action": "Update Item",
"BasicInfo": {
"SellerPartNumber": "A006Leon_Test_002",
"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": "url",
"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",
235
"ItemHeight": "2.0"
},
"ItemWeight": "2.0",
"ActivationMark": "False",
"ItemImages": {
"Image": {
"ImageUrl": "url",
"IsPrimary": "True"
}
},
"Warning": {
"Prop65": "No",
"Prop65Motherboard": "Yes",
"OverAge18Verification": "No",
"ChokingHazard": {
"SmallParts": "Yes",
"SmallBall": "Is a small ball",
"Balloons": "Yes",
"Marble": "Contains a marble"
}
}
}
}
]
}
}
}
}
INVENTORY_DATA
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
Attribute
Format
Description
Required
DocumentVersion
Decimal
2.0
Y
MessageType
String
Inventory
Y
236
Item
Inventory
Message
SellerPartNumber
String
NeweggItemNumber
String
A seller-defined unique identifier for an item. An alphanumeric
string, max 40 characters including space
Newegg’s unique identifier for an item
Y
N
The ISO standard 3-digit codes of the country where your
warehouse is located. Please download the following to review
WarehouseLocation
String
details:
http://promotions.newegg.com/marketplace/sellers/resourceLibra
Y
ry/International%20Country%20Guide.pdf
NOTE: Submissions with incorrect values will error-out.
FulfillmentOption
String
Inventory
Integer
Available value:
Seller
Inventory quantity in seller’s warehouse.
N
Y
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > InventoryUpdate.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=INVENTORY_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
2.0
Inventory
-
a006-test-001
9SIAWE50008504
USA
237
Seller
200
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=INVENTORY_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"-xsi:noNamespaceSchemaLocation": "BatchInventoryUpdate.xsd",
"Header": { "DocumentVersion": "2.0" },
"MessageType": "Inventory",
"Message": {
"Inventory": {
"Item": {
"SellerPartNumber": "a006-test-001",
"NeweggItemNumber": "9SIAWE50008504",
"WarehouseLocation": "USA",
"FulfillmentOption": "Seller",
"Inventory": "200"
}
}
}
}
}
238
PRICE_DATA
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
DocumentVersion
Decimal
2.0
Y
MessageType
String
Price
Y
Item
Description
Inventory
Format
Message
Attribute
SellerPartNumb
er
NeweggItemNu
mber
String
String
Required
A seller-defined unique identifier for an item. An alphanumeric
string, max 40 characters including space
Newegg’s unique identifier for an item
Y
N
The target country you will be selling your items to. Only the ISO
standard 3-digit codes are accepted.
To review the complete list of available values, please download
the following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLibr
CountryCode
String
ary/International%20Country%20Guide.pdf
Y
NOTE: Item price must be submitted with the correct currency code
based on ship-to destination country code. Submissions with
incorrect combinations will error-out.
The currency is to identify the Selling Price, MSRP, 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
Currency
String
the
following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLib
rary/International%20Country%20Guide.pdf
Y
NOTE: Correct currency code must be submitted based on ship-to
destination country code. Submissions with incorrect combinations
will error-out.
239
Manufacturer's suggested retail price for the product.
MSRP
Decimal
If you want to remove MSRP, input “0.00” or ‘0’ in this field. If null,
N
no change to current setting.
Minimum advertised price.
If the Selling Price is below the defined MAP, the website will ask
MAP
Decimal
customer to add item to shopping cart to see the item's price.
N
If you want to remove MAP, input “0.00” or ‘0’ in this field. If null,
no change to current setting.
Regardless the Selling Price and the value inputted in MAP field, if
CheckoutMAP
String
the Checkout MAP is marked as True, then the website will ask
customer to add item to shopping cart AND go to checkout page to
N
see the item's price.
SellingPrice
Decimal
The selling price
N
Shipping
String
The shipping charge setting for this item.
N
True: Activate item
ActivationMark
String
False: Deactivate item
Null = Ignore this action, no change to current item
N
active/deactivate setting
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > PriceUpdate.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=PRICE_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
2.0
Price
-
240
a006-test-001
9SIAWE50008504
USA
USD
100.00
True
100.00
default
True
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=PRICE_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"-xsi:noNamespaceSchemaLocation": "NeweggEnvelop.xsd",
"Header": { "DocumentVersion": "2.0" },
"MessageType": "Price",
"Message": {
"Price": {
"Item": {
"SellerPartNumber": "a006-test-001",
241
"NeweggItemNumber": "9SIAWE50008504",
"CountryCode": "USA",
"Currency": "USD",
"MSRP": "100.00",
"MAP": "9.99",
"CheckoutMAP": "True",
"SellingPrice": "100.00",
"Shipping": "default",
"ActivationMark": "True"
}
}
}
}
}
ORDER_SHIP_NOTICE_DATA
ORDER_SHIP_NOTICE_DATA feed allows you to update shipment of one or all items in an order. When an order has been
completely fulfilled, mean that all the items are fulfilled, the order process is completed.
Please review the following example and the possible shipment options you can assign for each feed:
Order XYZ has item A (5 units) and item B (1 unit)
Single package contains 5 units of item A and 1 unit of item B with one tracking number.
Single package contains either 5 units of item A or 1 unit of item B with one tracking number.
Mutile packages: one package contains 5 units of item A with one tracking number. The other package contains 1
unit of item B with another tracking number.
Multiple package: one package contains 2 units of item A with one tracking number. Another package contains 3
units of item A with another tracking number. The other package contains 1 unit of item B with another tracking
number.
Multiple package, 1 package contains 2 units of item A with one tracking number. The other package contains 3
units of item A and 1 unit of item B with another tracking number.
You cannot submit a request for partial shipment as following: Single package contains 2 units of item A with
one tracking number.
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip.
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
242
Decimal
MessageType
String
ShipNotice
Y
OrderNumber
String
Newegg’s unique identifier for an order
Y
ation
Item
SellerPartNumber
String
A seller-defined unique identifier for an item.
Y
NeweggItemNumber
String
Newegg’s unique identifier for an item
N
ShippedQuantity
Integer
Number of units the item was shipped
Y
Message
ItemInform
DocumentVersion
Package
Format
ShipNotice
Attribute
Description
The identifier for the version of current datafeed;
assigned by Newegg
Required
Y
The shipping carrier of this package when seller
ships the package.
Acceptable values:
UPS
ActualShippingCarrier
String
UPS MI
Y
FedEx
USPS
DHL
Other
ActualShippingMethod
String
TrackingNumber
String
The shipping method of this package when seller
ships the package. Example: UPS Ground
The tracking number of this package
Y
Y
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ShipNotice.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ORDER_SHIP_NOTICE_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1.0
ShipNotice
243
11006035
-
data_MP_329_00976
9SIAWES000CY64
1
-
data_MP_329_00975
9SIAWES000CY58
2
-
data_MP_329_00974
9SIAWES000CY53
1
-
data_MP_32900973
9SIAWES000CY49
1
-
data_MP_32900972
9SIAWES000CY45
2
UPS
UPS Ground
20110922002
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ORDER_SHIP_NOTICE_DATA
244
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ShipNotice",
"Message": {
"ShipNotice": {
"Package": {
"OrderNumber": "11006035",
"ItemInformation": {
"Item": [
{
"SellerPartNumber": "data_MP_329_00976",
"NeweggItemNumber": "9SIAWES000CY64",
"ShippedQuantity": "1"
},
{
"SellerPartNumber": "data_MP_329_00975",
"NeweggItemNumber": "9SIAWES000CY58",
"ShippedQuantity": "2"
},
{
"SellerPartNumber": "data_MP_329_00974",
"NeweggItemNumber": "9SIAWES000CY53",
"ShippedQuantity": "1"
},
{
"SellerPartNumber": "data_MP_32900973",
"NeweggItemNumber": "9SIAWES000CY49",
"ShippedQuantity": "1"
},
{
"SellerPartNumber": "data_MP_32900972",
"NeweggItemNumber": "9SIAWES000CY45",
"ShippedQuantity": "2"
}
]
245
},
"ActualShippingCarrier": "UPS",
"ActualShippingMethod": "UPS Ground",
"TrackingNumber": "20110922002"
}
}
}
}
}
MULTICHANNEL_ORDER_DATA
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
Element Name
Description
Required
OrderDate
The date when the order was placed
Y
SalesChannel
A label assigned by the seller to identify the sales channel.
This helps to distinguish orders with identical Order ID but from different sales
channels.
Y
SellerOrderID
An identifier for the order, assigned by the seller
Y
ShippingMethod
Order's shipping method
Y
ShipToFirstName
Ship to recipient's First Name
Y
ShipToLastName
Ship to recipient's Last Name
Y
ShipToCompany
Ship to company name
N
Ship to address line 1
ShipToAddressLine1
NOTE: SBN (Shipped by Newegg) service will only accept shipments to a valid
Y
street address. We do not deliver to P.O. Box.
Ship to address line 2
ShipToAddressLine2
NOTE: SBN (Shipped by Newegg) service will only accept shipments to a valid
N
street address. We do not deliver to P.O. Box.
ShipToCity
Ship to City
Y
ShipToState
Ship to State
Y
ShipToPostalCode
Ship to Zip code
Y
246
ShipToCountry
Ship to Country - For now, Newegg Marketplace is only limited to United States. If
left blank will default to USA
N
ShipToPhoneNumber
Ship to Person's phone number
Y
SellerPartNumber
The seller part # that was assigned to this item.
Y
NeweggItemNumber
The Newegg Item # for this item
N
Quantity
The number of units for the particular item in the order.
Y
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > MultiChannelOrder.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=MULTICHANNEL_ORDER_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1.0
MultiChannelOrderCreation
05/30/2013
3rd channel
2153930
Expedited Shipping (3-5 business days)
Carol
Chaste
248 River Trace Ct
McDonough
GA
30253
USA
247
770-898-1921
-
PTV3000-100NAS
10
-
CTB-212312S
20
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=MultiChannel_Order_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "MultiChannelOrderCreation",
"Message": {
"MultiChannelOrder": {
"Order": {
"OrderDate": "05/30/2013",
"SalesChannel": "3rd channel",
"SellerOrderID": "2153930",
"ShippingMethod": "Expedited Shipping (3-5 business days)",
"ShipToFirstName": "Carol",
"ShipToLastName": "Chaste",
"ShipToAddressLine1": "248 River Trace Ct",
248
"ShipToCity": "McDonough",
"ShipToState": "GA",
"ShipToPostalCode": "30253",
"ShipToCountry": "USA",
"ShipToPhoneNumber": "770-898-1921",
"ItemList": {
"Item": [
{
"SellerPartNumber": "PTV3000-100NAS",
"Quantity": "10"
},
{
"SellerPartNumber": "CTB-212312S",
"Quantity": "20"
}
]
}
}
}
}
}
ITEM_SUBSCRIPTION
Subscribe and 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 your item list, all listed items will be automatically join/leave all the ongoing Newegg
subscription programs.
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
DocumentVersion
Decimal
MessageType
String
sage
Item
Format
Mes
Attribute
SellerPartNumber
String
Description
The identifier for the version of current
datafeed; assigned by Newegg
Subscription
Identify the category specification. There
is only one category can be used for any
Required
Y
Y
Y
249
single item.
Specify the action you would like to
perform.
-
Enter "Add" if you want to add the
item as a subscription & save
product.
Action
String
-
Enter "Remove" to change the item
from a Subscription & Save item to a
Y
normal product.
If no value was entered for this field, by
default the system will treat it as “Add”.
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ItemSubscription.xsd
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
1.0
Subscription
-
JACKETEST0921001004
Add
-
JACKETEST0921001003
Remove
250
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"
}
]
}
}
}
VOLUME_DISCOUNT_DATA (Create, Update, Delete Volume Discount)
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
Attribute
Format
Description
Require
251
d
MessageType
String
VolumeDiscountList
ItemVolumeDiscountInfo
Decimal
Message
DocumentVersion
The identifier for the version of current
datafeed; assigned by Newegg
VolumeDiscount
Y
Y
A seller-defined unique identifier for an item. An
SellerPartNumber
String
alphanumeric
string,
max
40
characters
Y
including space
NeweggItemNumber
String
Newegg’s unique identifier for an item
N
Two actions are available:
True: Add / Update
VolumeActivation
String
False: Remove.
The default setting is "True". You may set it to
Y
"False" if you wish to remove the existing
Tier
DiscountSetting
volume discount.
Priority
int
Set the tier for the volume discount.
Y
Quantity
int
Set the quantity for the tier's volume discount.
Y
SellingPrice
Decimal
Set the unit price for the tier's volume discount.
Y
EnableFreeShipping
Set a shipping method for the tier's volume
Decimal
discount. The acceptable shipping method:
0:Default
Y
1:Free.
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > VolumeDiscount.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=VOLUME_DISCOU
NT_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
252
Lisa123
9SIA0060004762
True
1
10
9999.99
0
2
20
8888.99
0
3
30
7777.99
0
789
012
True
1
10
9999.99
0
123
253
True
1
10
9999.99
1
456
True
1
10
9999.99
0
B0369008
9SIA0060002417
False
B0369008
False
9SIA0060002417
False
345
False
678
254
False
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=VOLUME_DISCOU
NT_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"Header": {
"DocumentVersion": ""
},
"MessageType": "",
"Message": {
"VolumeDiscountList": {
"ItemVolumeDiscountInfo": [
{
"SellerPartNumber": "Lisa123",
"NeweggItemNumber": "9SIA0060004762",
"VolumeActivation": "True",
"DiscountSetting": {
"Tier": [
{
"Priority": "1",
"Quantity": "10",
"SellingPrice": "9999.99",
"EnableFreeShipping": "0"
},
{
"Priority": "2",
"Quantity": "20",
255
"SellingPrice": "8888.99",
"EnableFreeShipping": "0"
},
{
"Priority": "3",
"Quantity": "30",
"SellingPrice": "7777.99",
"EnableFreeShipping": "0"
}
]
}
},
{
"SellerPartNumber": "789",
"NeweggItemNumber": "012",
"VolumeActivation": "True",
"DiscountSetting": {
"Tier": {
"Priority": "1",
"Quantity": "10",
"SellingPrice": "9999.99",
"EnableFreeShipping": "0"
}
}
},
{
"SellerPartNumber": "123",
"VolumeActivation": "True",
"DiscountSetting": {
"Tier": {
"Priority": "1",
"Quantity": "10",
"SellingPrice": "9999.99",
"EnableFreeShipping": "1"
}
}
},
{
"NeweggItemNumber": "456",
"VolumeActivation": "True",
"DiscountSetting": {
256
"Tier": {
"Priority": "1",
"Quantity": "10",
"SellingPrice": "9999.99",
"EnableFreeShipping": "0"
}
}
},
{
"SellerPartNumber": "B0369008",
"NeweggItemNumber": "9SIA0060002417",
"VolumeActivation": "False"
},
{
"SellerPartNumber": "B0369008",
"VolumeActivation": "False"
},
{
"NeweggItemNumber": "9SIA0060002417",
"VolumeActivation": "False"
},
{
"SellerPartNumber": "345",
"VolumeActivation": "False"
},
{
"NeweggItemNumber": "678",
"VolumeActivation": "False"
}
]
}
}
}
}
ITEM_PROMOTION_DATA
Newegg marketplace offers a lot of promotion strategies to help sellers increase their sales, in order to better organize the deals,
seller is able to batch submit the requests to our deal center. Our promotion team will review the request and find the best place
where the promotion could be seen by customers.
257
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
Format
DocumentVersion
Decimal
MessageType
String
Description
The identifier for the version of current
datafeed; assigned by Newegg
ItemPromotion
Required
Y
Y
This Tab ID is NOT required. If you left this
Item
Message
Attribute
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.
TabID
Integer
N
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
(http://www.newegg.com/marketplace/deals).
Also you can find the Tab's information on
Seller Portal -> Manage Promotion -> Submit
Deals page.
SellerPartNumber
String
The seller part # is the SKU number assigned to
this item by seller.
Y
N (Yes if
NeweggItemNumber
String
The Newegg Item # for this item
SellerPartNumber
is not provided)
The manufacturer’s suggested retail price
PromoMSRP
Decimal
(MSRP) or list price for the item during the
N
promotion.
PromoSellingPrice
Decimal
The actual price at which the item is offered for
the promotion.
Y
The shipping setting for the item during the
PromoShipping
String
promotion, the available two options are
Y
default and free
The date when the promotion will be starting.
PromoStartDate
Datetime
Format: mm/dd/yyyy. The default time is
Y
12:00:00 AM.
258
The date when the promotion will be end.
PromoEndDate
Datetime
Format: mm/dd/yyyy. The default time is
Y
11:59:00 PM
The maximum quantity this item can be
purchased by a customer
LimitQty
Integer
within a 48 hour time period.
N
If left empty, there will be no quantity
limitation.
The maximum quantity that can be sold for this
item during this promotion period. Please note
that once the promotion schedule has started,
MaxQty
Integer
this value cannot be updated.
N
If left empty, there will be no quantity
limitation.
The minimum inventory level. The level below
which inventory can never drop 24 hours prior
to promotion start time. The 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
MinInventory
Integer
after promotion start time. For urgent
N
inventory adjustment please contact Newegg
Marketplace
Integration
team:
Datafeeds@newegg.com for assistance.
The default value is 0. This field is usable only
when "Inventory Locked" = true.
If set with Yes, any inventory update via
datafeeds / API / seller portal will not be
processed if request to update inventory less
than
Inventory Locked
String
the value in "Min Inventory”. For urgent
inventory adjustment please contact Newegg
Marketplace
Integration
N
team:
Datafeeds@newegg.com for assistance.
The default is No.
Note
String
The additional message or memo you want to
create with this request. 200 characters limit.
N
259
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ItemPromotion.xsd
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
1.0
ItemPromotion
-
1234567
9SI600185746359
290.99
190.99
Free
07/27/2014
08/01/2014
20
1000
0
No
This is a promotion for Back to School
-
1234567
9SI600185746359
290.99
190.99
Free
07/27/2014
08/10/2014
20
260
1000
0
No
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",
261
"PromoShipping": "Free",
"PromoStartDate": "07/27/2014",
"PromoEndDate": "08/10/2014",
"LimitQty": "20",
"MaxQty": "1000",
"MinInventory": "0",
"InventoryLocked": "No"
}
]
}
}
}
ITEM_PREMIER_MARK_DATA
Sellers who are qualified to participate in the program of Newegg Premier Order Fulfilled by Seller will be able to identify qualified
products using this function.
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
DocumentVersion
Decimal
MessageType
String
Item
Format
Message
Attribute
SellerPartNumber
String
Description
The identifier for the version of current
datafeed; assigned by Newegg
BatchPremierMarkUpdate
A seller-defined unique identifier for an
item.
Required
Y
Y
Y
TRUE – Enroll this item in Newegg
PremierMark
String
Premier Program.
FALSE – Remove this item from Newegg
Y
Premier Program
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > PremierItemMark.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_PREMIER_MARK_DATA
262
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1.0
BatchPremierMarkUpdate
-
JACKETEST0921001004
FALSE
-
JACKETEST0921001003
TRUE
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=
ITEM_PREMIER_MARK_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "1.0" },
"MessageType": "BatchPremierMarkUpdate",
"Message": {
"Item": [
{
"SellerPartNumber": "JACKETEST0921001004",
"PremierMark": "FALSE"
},
263
{
"SellerPartNumber": "JACKETEST0921001003",
"PremierMark": "TRUE"
}
]
}
}
}
ITEM_WARRANTY_DATA
Specifying warranty services on both refurbished and used items selling on Newegg Marketplace.
By submitting this template, you will be able to specify certain time period, 90 days for example, for the warranties on Parts and
Labor.
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
Datafeeds@newegg.com for assistance.
DocumentVersion
Decimal
MessageType
String
Item
Format
Message
Attribute
SellerPartNumber
String
NeweggItemNumber
String
Description
The identifier for the version of current
datafeed; assigned by Newegg
BatchThirdPartyWarrantyUpdate
A seller-defined unique identifier for an
item.
Newegg’s unique identifier for an item
Required
Y
Y
Y
N
• ISO standard 3-digit codes of the
countries for Newegg international
program. Currently available values for
Newegg.com:
USA (Default)
CountryCode
String
AUS -
Australia
GBR - United Kingdom
N
IND - India
IRL - Ireland
NLD - Netherlands
NZL - New Zealand
POL - Poland
264
SGP - Singapore
• Newegg.ca: CAN (Default)
• Neweggbusiness.com: USB (Default)
The period of day is available for the
WarrantyDayCountParts
Integer
warranty coverage of parts.
Y
Any existing value can be removed by
using 0.
The period of day is available for the
WarrantyDayCountLabor
Integer
warranty coverage of service labor.
Y
Any existing value can be removed by
using 0.
WarrantyProvidedBy
SupportPhone
SupportEmail
String
String
String
The name of warranty service provider.
Y
Maximum characters: 200.
Service phone # of warranty service provider
Y
Maximum characters: 40.
Email address of warranty service provider
Y
Maximum characters: 100.
Support URL of warranty service provider if
SupportURL
String
available.
N
Maximum characters: 250.
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ThirdPartyWarranty.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_WARRANTY_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1.0
BatchThirdPartyWarrantyUpdate
-
321321654
SIA00F3427624
265
USA
30
30
Newegg
626-100-1000
example@newegg.com
http://www.newegg.com
-
321321655
SIA00F3427625
USA
30
30
Newegg
626-100-1000
example@newegg.com
http://www.newegg.com
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=
ITEM_PREMIER_MARK_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "1.0" },
"MessageType": "BatchThirdPartyWarrantyUpdate",
"Message": {
"Item": [
{
"SellerPartNumber": "321321654",
"NeweggItemNumber": "SIA00F3427624",
"CountryCode": "USA",
266
"WarrantyDayCountParts": "30",
"WarrantyDayCountLabor": "30",
"WarrantyProvidedBy": "Newegg",
"SupportPhone": "626-100-1000",
"SupportEmail": "example@newegg.com",
"SupportURL": "http://www.newegg.com"
},
{
"SellerPartNumber": "321321655",
"NeweggItemNumber": "SIA00F3427625",
"CountryCode": "USA",
"WarrantyDayCountParts": "30",
"WarrantyDayCountLabor": "30",
"WarrantyProvidedBy": "Newegg",
"SupportPhone": "626-100-1000",
"SupportEmail": "example@newegg.com",
"SupportURL": "http://www.newegg.com"
}
]
}
}
}
ITEM_CAPROP65_DATA
By submitting this template, you will be able to set the California’s Proposition 65 (“Prop 65”) warning for the items sold on Newegg
Marketplace.
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
datafeeds@newegg.com for assistance.
Decimal
MessageType
String
d
Item
DocumentVersion
e
ItemFee
Format
Messag
Attribute
SellerPartNumber
String
Description
The identifier for the version of current
datafeed; assigned by Newegg
AddingCAProp65
A seller-defined unique identifier for an
item.
Required
Y
Y
Y if
NeweggItemNumber
not provided.
267
Y if
NeweggItemNumber
String
Newegg’s unique identifier for an item
SellerPartNumber
not provided.
Available values are from 103 to 119.
Please review the Side-by-side mapping
WarningType_ID
String
list of the Proposition 65 Warning Type
and Newegg Warning Code for the
Y
deteails of each Warning Type and
related Warng Type ID.
List the chemical name(s) the product
include to cause cancer.
Multiple values separated by commas.
ChemicalName_Carcinogen
String
Max Length : 600
N
Visit:
https://oehha.ca.gov/proposition-65 for
more information.
List the chemical name(s) the product
include to cause birth defects or other
ChemicalName_ReproductiveToxic
ant
reproductive harm.
String
Multiple values separated by commas.
N
Max Length : 600
Visit: https://oehha.ca.gov/proposition65 for more information.
List the chemical name(s) the product
include to cause both cancer and birth
defects or other reproductive harm.
ChemicalName_Both
String
Multiple values separated by commas.
N
Max Length : 600
Visit: https://oehha.ca.gov/proposition65 for more information.
Side-by-side mapping list of the Proposition 65 Warning Type and Newegg Warning Code
Proposition 65
Warning Type
Newegg
Warning
Type ID
CONSUMER PRODUCTS
(For exposures to listed
carcinogens - Long-Form)
Warning Will Be Displayed
103
WARNING: This product can expose you to chemicals including [name of one or more
chemicals], which is/are known to the State of California to cause cancer. For more
information go to www.P65Warnings.ca.gov .
268
CONSUMER PRODUCTS
(For exposures to listed
104
WARNING: Cancer - www.P65Warnings.ca.gov .
carcinogens - Short-Form)
CONSUMER PRODUCTS
(For exposures to listed
reproductive toxicants -
105
WARNING: This product can expose you to chemicals including [name of one or more
chemicals], which is/are known to the State of California to cause birth defects or other
reproductive harm. For more information go to www.P65Warnings.ca.gov.
Long-Form)
CONSUMER PRODUCTS
(For exposures to listed
reproductive toxicants -
106
WARNING: Reproductive Harm - www.P65Warnings.ca.gov .
Short-Form)
CONSUMER PRODUCTS
WARNING: This product can expose you to chemicals including [name of one or more
chemicals], which is/are known to the State of California to cause cancer, and [name of
(For exposures to both
listed
carcinogens
and
107
one or more chemicals], which is/are known to the State of California to cause birth
reproductive toxicants -
defects
or
other
reproductive
Long-Form)
www.P65Warnings.ca.gov
harm.
For
more
information
go
to
CONSUMER PRODUCTS
(For exposures to both
listed
carcinogens
and
108
WARNING: Cancer and Reproductive Harm - www.P65Warnings.ca.gov .
reproductive toxicants Short-Form)
CONSUMER PRODUCTS
(For
exposures
to
a
chemical that is listed as
both a carcinogen and a
reproductive
toxicant
109
-
WARNING: This product can expose you to chemicals including [name of one or more
chemicals], which is/are known to the State of California to cause cancer and birth defects
or other reproductive harm. For more information go to
www.P65Warnings.ca.gov
Long-Form)
FOOD
(For exposure to a listed
110
WARNING: Consuming this product can expose you to chemicals including [name of
one or more chemicals], which is/are known to the State of California to cause cancer. For
carcinogen)
more information go to www.P65Warnings.ca.gov/food .
FOOD
WARNING: Consuming this product can expose you to chemicals including [name of
one or more chemicals], which is/are known to the State of California to cause birth
(For exposure to a listed
111
reproductive toxicant)
(For exposure to both listed
reproductive toxicants)
or
other
reproductive
harm.
For
more
information
go
to
www.P65Warnings.ca.gov/food .
WARNING: Consuming this product can expose you to chemicals including [name of
one or more chemicals], which is/are known to the State of California to cause cancer and
FOOD
carcinogens
defects
and
112
[name of one or more chemicals], which is/are known to the State of California to cause
birth
defects
or
other
reproductive
harm.
For
more
information
go
to
www.P65Warnings.ca.gov/food .
269
FOOD
(For exposure to a chemical
that is listed as both a
carcinogen
and
113
a
birth
defects
or
other
reproductive
harm.
For
more
information
go
to
www.P65Warnings.ca.gov/food .
reproductive toxicant)
ALCOHOLIC BEVERAGES
WARNING: Consuming this product can expose you to chemicals including [name of
one or more chemicals], which is/are known to the State of California to cause cancer and
114
WARNING: Drinking distilled spirits, beer, coolers, wine and other alcoholic
beverages may increase cancer risk, and, during pregnancy, can cause birth defects. For
more information go to www.p65warnings.ca.gov/products/alcoholic-beverages
WARNING: Breathing diesel engine exhaust exposes you to chemicals known to the
State of California to cause cancer and birth defects or other reproductive harm.
• Always start and operate the engine in a well-ventilated area.
DIESEL ENGINES
115
• If in an enclosed area, vent the exhaust to the outside.
• Do not modify or tamper with the exhaust system.
• Do not idle the engine except as necessary.
For more information, go to www.p65warnings.ca.gov/products/diesel .
FURNITURE
116
WARNING: This product can expose you to chemicals including [name of one or more
chemicals], which is/are known to the State of California to cause cancer or birth defects
or
other
reproductive
harm.
For
more
information
go
to
www.P65Warnings.ca.gov/furniture .
WARNING: Operating, servicing and maintaining a recreational marine vessel can
expose you to chemicals including engine exhaust, carbon monoxide, phthalates, and
RECREATIONAL
MARINE
VESSELS
117
lead, which are known to the State of California to cause cancer and birth defects or other
reproductive harm. To minimize exposure, avoid breathing exhaust, service your vessel in
a well-ventilated area and wear gloves or wash your hands frequently when servicing this
vessel. For more information go to www.P65warnings.ca.gov/marine .
WARNING: Operating, servicing and maintaining a passenger vehicle or off-highway
motor vehicle can expose you to chemicals including engine exhaust, carbon monoxide,
phthalates, and lead, which are known to the State of California to cause cancer and birth
VEHICLES
118
defects or other reproductive harm. To minimize exposure, avoid breathing exhaust, do
not idle the engine except as necessary, service your vehicle in a well-ventilated area and
wear gloves or wash your hands frequently when servicing your vehicle. For more
information go to www.P65Warnings.ca.gov/passenger-vehicle .
WOOD DUST (TOOLS)
119
WARNING: Drilling, sawing, sanding or machining wood products can expose you to
wood dust, a substance known to the State of California to cause cancer. Avoid inhaling
wood dust or use a dust mask or other safeguards for personal protection. For more
information go to www.P65Warnings.ca.gov/wood .
For the background on the Proposition 65 warnings: https://www.p65warnings.ca.gov/new-proposition-65-warnings
For information about Proposition 65 and businesses: https://oehha.ca.gov/proposition-65/businesses-and-proposition-65
For information about chemicals listed under Proposition 65: https://oehha.ca.gov/proposition-65/chemicals
270
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > AddingCA_Prop65.xsd
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_CAPROP65_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
4.0
AddingCAProp65
-
a006-test-001
9SIAWE50008504
103
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype= ITEM_CAPROP65_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "4.0" },
271
"MessageType": "AddingCAProp65",
"Message": {
"Itemfeed": {
"Item": {
"SellerPartNumber": "a006-test-001",
"NeweggItemNumber": "9SIAWE50008504",
"WarningType_ID": "103",
"ChemicalName_Carcinogen": "Acetaldehyde, Acetamide"
}
}
}
}
}
ITEM_CHINATAXSETTING_DATA
By submitting this template, you will be able to set the tax type for the items sold for China.
For schema, please download the XSD’s and XML sample files from
https://sellerportal.newegg.com/Guideline/Newegg_Marketplace_API_DeveloperGuide.zip
The following information provides element definitions. You can also contact Newegg Marketplace Integration team:
datafeeds@newegg.com for assistance.
DocumentVersion
Decimal
1.0
Y
MessageType
String
BatchItemChinaTaxSetting
Y
Item
Description
ChinaTaxSetting
Format
Message
Attribute
SellerPartNumber
String
A seller-defined unique identifier for an
item.
Required
Y if
NeweggItemNumber
not provided.
Y if
NeweggItemNumber
String
Newegg’s unique identifier for an item
SellerPartNumber
not provided.
Identify the tax and duty rules for items
shipped to China by seller directly. Available
values:
TaxDutyType
String
Default: Follow the account
Y
level setting
DDU: Deliver Duties Unpaid. No
duty or tax will be added to orders.
272
Customers are responsible for
additional duties and taxes during
the customs clearance.
DDP: Deliver Duties Paid. Duties
and taxes will be collected while
customers placing orders. Sellers
are responsible to pay all duties
and taxes directly. Collected
amount will be remit to sellers
along with regular payment
transactions.
ATI: All tax included. All duties and
taxes are included in item’s selling
price. No duty or tax will be added
to orders. Sellers are responsible
to pay all duties and taxes directly.
Identify the order import type for calculating
the correct tax amount for items shipping to
China by Seller (SBS). Available values:
Default: Follow the account
level setting
EE: Taxes will be calculated as
personal shipments. Recipient’s
ImportType
photo ID number and the copy of
String
ID will be provided for processing
Y
orders.
EEP: Taxes will be calculated as
business to customer direct
shipments, known as Cross-Border
e-Commerce. Payment holder’s
photo ID number will be provided
for processing orders.
Example: XML, Request
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ItemChinaTaxSetting.xsd
273
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ITEM_CHINATAXSETTING_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
1.0
ItemChinaTaxSetting
-
a006-test-001
9SIAWE50008504
Default
EEP
Example: Json, Request
POST
https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=PRICE_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
274
"-xsi:noNamespaceSchemaLocation": "NeweggEnvelop.xsd",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ItemChinaTaxSetting",
"Message": {
"ChinaTaxSetting": {
"Item": {
"SellerPartNumber": "a006-test-001",
"NeweggItemNumber": "9SIAWE50008504",
"TaxDutyType": "Default",
"ImportType": "EEP"
}
}
}
}
}
12.1.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of submitting
datafeed is successful
OperationType
String
Fixed value: SubmitFeedResponse
SellerID
String
Your seller ID
RequestId
String
The Identifier of a request
RequestType
String
ITEM_DATA
INVENTORY_AND_PRICE_DATA
INVENTORY_DATA
ResponseInfo
ResponseList
PRICE_DATA
ResponseBody
NeweggAPIResponse
True or False
ITEM_COUNTRY_RESTRICTION_DATA
ORDER_SHIP_NOTICE_DATA
MULTICHANNEL_ORDER_DATA
ITEM_SUBSCRIPTION
VOLUME_DISCOUNT_DATA
ITEM_PROMOTION_DATA
ITEM_PREMIER_MARK_DATA
ITEM_WARRANTY_DATA
ITEM_CAPROP65_DATA
ITEM_CHINATAXSETTING_DATA
275
RequestDate
String
The date when the feed was submitted. (Pacific
Standard Time)
RequestStatus
String
The status of the feed submission.
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
Memo
String
Additional Information
Example: XML, Response
XSD
API Schema > DataFeedMgmt > DataFeedSchema > SubmitFeedResponse.xsd
true
SubmitFeedResponse
A006
2291326430
ITEM_DATA
2/16/2012 12:29:19
SUBMITTED
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "SubmitFeedResponse",
"ResponseBody": {
"ResponseList": [{
276
"RequestDate": "2\/22\/2012 17:24:35",
"RequestId": "2PQCX3CMQ82MK",
"RequestStatus": "SUBMITTED",
"RequestType": "ITEM_DATA"
}]
},
"SellerID": "A006"
}
12.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
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
DF003
The MaxCount (maximum request records) CANNOT be over 30000
Example: Json, Response
{
"Code": "DF003",
"Message": "The MaxCount (maximum request records) CANNOT be over 30000"
}
12.2.
Get Feed Status
277
Get the status of specified feed request by specified query conditions.
12.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/datafeedmgmt/feeds/status?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
12.2.2. Request Body
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here.
OperationType
Yes
String
Fixed value: GetFeedStatusRequest
No
String
A list of feed Task ID, other condition will be ignored if specify
RequestIDList
Attribute
RequestID
an ID in the list
No
String
ITEM_DATA
INVENTORY_DATA
PRICE_DATA
ITEM_COUNTRY_RESTRICTION_DATA
RequestTypeList
GetRequestStatus
INVENTORY_AND_PRICE_DATA
RequestBody
NeweggAPIRequest
RequestType
ORDER_SHIP_NOTICE_DATA
MULTICHANNEL_ORDER_DATA
ITEM_SUBSCRIPTION
VOLUME_DISCOUNT_DATA
ITEM_PROMOTION_DATA
ITEM_PREMIER_MARK_DATA
ITEM_WARRANTY_DATA
ITEM_CAPROP65_DATA
ITEM_CHINATAXSETTING_DATA
278
MaxCount
No
Integer
The maximum return records. Default is 100. If you specified
over than 100, the system still return 100 records.
RequestStatus
No
String
The status of the feed submission.
Available values:
ALL (Default)
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
RequestDateFrom
No
DateTime
Search by request date range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
RequestDateTo
No
DateTime
Search by request date range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
Example: XML, Request
XSD
API Schema > DataFeedMgmt > GetFeedStatus > GetFeedStatusRequest.xsd
PUT https://api.newegg.com/marketplace/datafeedmgmt/feeds/status?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetFeedStatusRequest
2PQCX3SPZ3QBF
100
ALL
Example: Json, Request
279
PUT https://api.newegg.com/marketplace/datafeedmgmt/feeds/status?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetFeedStatusRequest",
"RequestBody": {
"GetRequestStatus": {
"RequestIDList": { "RequestID": "2PQCX3SPZ3QBF" },
"MaxCount": "100",
"RequestStatus": "ALL"
}
}
}
12.2.3. Response Body
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
True or False
SellerID
String
Your seller ID
String
The Identifier of a request
ep
R
s
o
ep
n
s
o
s
p
n
e
o
s
B
n
eo
s
Ld
ei
y
sI
RequestId
o
Fixed value: GetFeedStatusResponse
nt
f
String
e
R
s
OperationType
R
NeweggAPIResponse
Attribute
280
RequestType
String
ITEM_DATA
INVENTORY_AND_PRICE_DATA
INVENTORY_DATA
PRICE_DATA
ITEM_COUNTRY_RESTRICTION_DATA
ORDER_SHIP_NOTICE_DATA
MULTICHANNEL_ORDER_DATA
ITEM_SUBSCRIPTION
VOLUME_DISCOUNT_DATA
ITEM_PROMOTION_DATA
ITEM_PREMIER_MARK_DATA
ITEM_WARRANTY_DATA
ITEM_CAPROP65_DATA
ITEM_CHINATAXSETTING_DATA
RequestDate
String
The date when the feed was submitted. (Pacific Standard
Time)
RequestStatus
String
The status of the feed submission.
Available values:
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
Memo
String
Detailed error information
Example: XML, Response
XSD
API Schema > DataFeedMgmt > GetFeedStatus > GetFeedStatusResponse.xsd
true
GetFeedStatusResponse
A006
2PQCX3SPZ3QBF
ITEM_DATA
2/22/2012 17:25:10
FINISHED
281
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "GetFeedStatusResponse",
"ResponseBody": {
"ResponseList": [{
"RequestDate": "2\/22\/2012 17:25:10",
"RequestId": "2PQCX3SPZ3QBF",
"RequestStatus": "FINISHED",
"RequestType": "ITEM_DATA"
}]
},
"SellerID": "A006"
}
12.2.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
CE001
SellerID cannot be null or empty
Example: Json, Response
{
282
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
12.3.
Get Feed Result
When your datafeed status is finished, you can use this interface to get the processing report.
12.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/datafeedmgmt/feeds/result/{Requestid}?sellerid={sellerid}
Note: Please make sure your request URL is all in lower case (except for Seller ID and Request ID) and cannot contain any blank spaces
or line breaks.
Parameters
Name
Required?
Description
sellerId
Yes
Your seller ID on Newegg Marketplace
{Requestid}
Yes
The request ID of the submitted feed request
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
12.3.2. Request Body
Example: XML, Request
GET https://api.newegg.com/marketplace/datafeedmgmt/feeds/result/{Requestid}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
GET https://api.newegg.com/marketplace/datafeedmgmt/feeds/result/{Requestid}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
283
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
12.3.3. Response Body
The following information provides element definitions for processing report
Attribute
Description
The identifier for the version of current datafeed; assigned
DocumentVersion
by Newegg
Y
ProcessingReport
Y
OrginalMessageName
Available value to identify processed message
Y
OriginalMessageType
Available value to identify processed message
Y
ProcessedStamp
The time stamp for processed message. Time format:
8/12/2010
9:32:33 PM
Y
StatusCode
Available value to identify message processing status
Y
ProcessedCount
Identify the total processed records.
N
SuccessCount
Identify the total successfully processed records.
N
WithErrorCount
Identify the total error processed records.
N
Error and warning information, available as the following
Result
ProcessingReport
MessageType
Message
Required
components:
SellerPartNumber
AdditionalInfo
ManufacturePartNumber
NeweggItemNumber
N
UPC
OrderNumber
ErrorList
TrackingNumber
ErrorDescription
Identify the reason of an error
N
ITEM_DATA
Example: XML, Response
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ProcessingReport.xsd
284
1.0
ProcessingReport
APIAutoFile.xml
ProcessReport
2
1
1
3910117
XAUB2511-100PAS
294
Error(s). Process failed.
SellerPart # - Item(s) does not exist.
Example: Json, Response
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "APIAutoFile.xml",
"StatusCode": "ProcessReport",
"ProcessingSummary": {
"ProcessedCount": "2",
"SuccessCount": "1",
"WithErrorCount": "1"
},
"Result": {
"AdditionalInfo": {
"SellerOrderID": "3910117",
"SellerPartNumber": "XAUB2511-100PAS"
},
"ErrorList": {
"Error": [
{ "ErrorDescription": "Error(s). Process failed." },
{ "ErrorDescription": "SellerPart # - Item(s) does not exist." }
]
}
}
}
}
}
}
295
ITEM_SUBSCRIPTION
Example: XML, Response
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ProcessingReport.xsd
1.0
ProcessingReport
Subscription
ProcessReport
Subscription
6/25/2014 1:50:02 AM,PST
2
1
1
JACKETEST0921001003
SellerPartNumber
296
Example: Json, Response
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "1.0" },
"MessageType": " Subscription",
"Message": {
"ProcessingReport": {
"OriginalMessageName": " Subscription",
"StatusCode": "ProcessReport",
"ProcessingSummary": {
"ProcessedCount": "2",
"SuccessCount": "1",
"WithErrorCount": "1"
},
"Result": {
"AdditionalInfo": {
"SellerPartNumber": "JACKETEST0921001003"
},
"ErrorList": {
"Error": [
{ "ErrorDescription": "SellerPart # - Item(s) does not exist." }
]
}
}
}
}
}
}
VOLUME_DISCOUNT_DATA
Example: XML, Response
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ProcessingReport.xsd
297
1.0
ProcessingReport
ProcessReport
VolumeDiscount
6/12/2014 10:29:38 AM,PST
2
1
1
Example: Json, Response
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "VolumeDiscountTest.xml",
"StatusCode": "ProcessReport",
"OriginalMessageType": "VolumeDiscount",
"ProcessedStamp": "6/12/2014 10:29:38,PST",
298
"ProcessingSummary": {
"ProcessedCount": "2",
"SuccessCount": "1",
"WithErrorCount": "1"
},
"Result": {
"AdditionalInfo": {
"SellerPartNumber": "phy_3890_USA_9SI_5",
"ItemNumber": "9SIA0060004809"
},
"ErrorList": { "ErrorDescription": "SellerItemNumber: '9SIA0060004809', Country Code:
'USA' and Company Code: '1003' has no Volume Discount Setting." }
}
}
}
}
}
ITEM_PROMOTION_DATA
Example: XML, Response
XSD
API Schema > DataFeedMgmt > DataFeedSchema > ProcessingReport.xsd
1.0
ProcessingReport
ProcessReport
ItemPromotion
6/12/2014 10:29:38 AM,PST
2
1
299
1
Example: Json, Response
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "ItemPromotion.xml",
"StatusCode": "ProcessReport",
"OriginalMessageType": "ItemPromotion",
"ProcessedStamp": "6/12/2014 10:29:38 AM,PST",
"ProcessingSummary": {
"ProcessedCount": "2",
"SuccessCount": "1",
"WithErrorCount": "1"
},
"Result": {
"AdditionalInfo": {
"SellerPartNumber": "phy_3890_USA_9SI_5",
"ItemNumber": "9SIA0060004809"
},
"ErrorList": {"ErrorDescription": "SellerItemNumber: '9SIA0060004809', Promo End Date
must be after Promo Start Date."}
300
}
}
}
}
}
ITEM_PREMIER_MARK_DATA
Example: XML, Response
1.0
ProcessingReport
ProcessReport
ItemPremierMark
6/12/2014 10:29:38 AM,PST
2
1
1
301
Example: Json, Response
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "ItemPremierMark.xml",
"StatusCode": "ProcessReport",
"OriginalMessageType": "ItemPremierMark",
"ProcessedStamp": "6/12/2014 10:29:38 AM,PST",
"ProcessingSummary": {
"ProcessedCount": "2",
"SuccessCount": "1",
"WithErrorCount": "1"
},
"Result": {
"AdditionalInfo": {
"SellerPartNumber": "phy_3890_USA_9SI_5",
"ItemNumber": "9SIA0060004809"
},
"ErrorList": {" You have not enrolled Newegg Premier Program. Please request to enroll
Newegg Premier Program from Seller Portal."}
}
}
}
}
}
ITEM_WARRANTY_DATA
Example: XML, Response
1.0
302
ProcessingReport
ProcessReport
BatchThirdPartyWarrantyUpdate
6/12/2014 10:29:38 AM,PST
2
1
1
Example: Json, Response
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "ItemWarranty.xml",
"StatusCode": "ProcessReport",
"OriginalMessageType": "BatchThirdPartyWarrantyUpdate",
"ProcessedStamp": "6/12/2014 10:29:38 AM,PST",
"ProcessingSummary": {
"ProcessedCount": "2",
303
"SuccessCount": "1",
"WithErrorCount": "1"
},
"Result": {
"AdditionalInfo": {
"SellerPartNumber": "phy_3890_USA_9SI_5",
"ItemNumber": "9SIA0060004809"
},
"ErrorList": {"SellerPart # - Item(s) does not exist."}
}
}
}
}
}
ITEM_CAPROP65_DATA
Example: XML, Response
1.0
ProcessingReport
ProcessReport
AddingCAProp65
06/15/2018 9:08:17 AM,PST
71
67
4
304
Example: Json, Response
{
"NeweggEnvelope": {
"-xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "APIAutoFile.xml",
"StatusCode": "ProcessReport",
"OriginalMessageType": "AddingCAProp65",
"ProcessedStamp": "06/15/2018 9:08:17 AM,PST",
"ProcessingSummary": {
"ProcessedCount": "71",
"SuccessCount": "67",
"WithErrorCount": "4"
},
"Result": {
"AdditionalInfo": {
"SellerPartNumber": "CC1965",
"NeweggItemNumber": "9SI1234",
"WarningType_ID": "103"
},
"ErrorList": {
"ErrorDescription": [
"ChemicalName_Carcinogen is required for WarningType_ID 103.",
"System Error Sample."
]
}
}
}
305
}
}
}
ITEM_CHINATAXSETTING_DATA
Example: XML, Response
1.0
ProcessingReport
APIAutoFile.xml
ProcessReport
ItemChinaTaxSetting
2/7/2012 5:10:00 AM,PST
7
7
0
Example: Json, Response
{
"NeweggEnvelope": {
"Header": { "DocumentVersion": "1.0" },
"MessageType": "ProcessingReport",
"Message": {
"ProcessingReport": {
"OriginalMessageName": "APIAutoFile.xml",
"StatusCode": "ProcessReport",
"OriginalMessageType": "ItemChinaTaxSetting",
"ProcessedStamp": "2/7/2012 5:10:00 AM,PST",
"ProcessingSummary": {
306
"ProcessedCount": "7",
"SuccessCount": "7",
"WithErrorCount": "0"
}
}
}
}
}
12.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
DF004
Unfortunately, we are unable to process your request at this time. We apologize for the inconvenience. Please
try again later.
DF005
Your feed was not submitted successfully (Feed Request ID: [{0}]). Please resubmit your feed again.
DF006
The requestID cannot be null.
DF007
Invalid RequestID.
DF010
Data feed request processing failed:{0}
Available values:
a. FileContentError (mapped error message: Incorrect data feed format or template)
b. No record (mapped error message: request with no record specified.)
Example: XML, Response
DF006
Invalid RequestID
Example: Json, Response
{
"Code": "DF006",
307
"Message": "Invalid RequestID"
}
308
13. RMA Management
The following sections describe how to create, retrieve and update RMA (refund and replacement), as well as how to
issue a courtesy refund.
RMA (Return Merchandise Authorization) is a return transaction that seller would expect a return shipment from customer
in exchange for refund or replacement. However, the functions allow you to issue refund even if a return shipment is not
received (mark auto receive, see details below). *RMA refund will result in commission refund to seller.
Simple RMA flow goes as follows:
Issue RMA -> Receive RMA -> Process Refund / Replacement. Replacement will appear as a new order in order list.
If Auto Received marked as yes:
Issue RMA -> Process Refund (not applicable to RMA Replacement type). Please consult with Newegg Integration team
for details of how auto-receiving a RMA works.
Courtesy Refund is a refund transaction that seller would not expect a return shipment from customer. It is normally a
refund for reasons such as Pricing Error. NOTE: please make sure that the courtesy refund should not be used as regular
refund. *Courtesy refund will NOT result in commission refund to seller.
13.1. Submit RMA
Issue a Refund or Replacement RMA for an invoiced order.
13.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={sellerid}&version={versionno}
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
version
No
Available version numbers: 307
Authentication?
Request Formats
Resource Information
HTTP Method
Response Formats
Rate Limited?
309
POST
Required
XML, Json
XML, Json
30 per min per client
13.1.2. Request Body
Attribute
IssueUser
Required?
Format
Description
No
String
The RMA issuer’s registered Seller Portal email
address. System will only accept Seller’s
registered Seller Portal email addresses. If left
blank, default value will be Seller ID.
OperationType
RMAType
Yes
String
Fixed value: IssueRMARequest
Yes
Integer
Available values:
1: Replacement
2: Refund
For Courtesy Refund, please refer to Issue
SourceSONumber
Yes
Integer
The order number which the RMA is issued for.
SellerRMANumber
No
String
Seller RMA #.
An alphanumeric string, max 50 characters.
IssueRMA
NeweggAPIRequest
RequestBody
Courtesy Refund section (click here)
Note: only available for version=307
DiffShippedByPartyActio
Yes if:
n
Integer
The RMA replacement Order you are submitting
RMA type =
currently has items Shipped by Seller and
Replacement
Shipped by Newegg. In order to process the
The original order
RMA replacement request, please choose one
has items
of the following actions:
currently fulfilled
1: Convert to Refund with Restocking Fee
by SBS and SBN.
2: Convert to Refund without Restocking Fee
3: Split into Two RMAs
AutoReceiveMark
No
Integer
This mark is used to:
-
Receive the RMA automatically once the
RMA has been created successfully. Seller
would not need to “receive” RMA as a
separate action to proceed with refund.
Otherwise, seller will need to “receive”
310
RMA after RMA created to proceed with
refund.
-
Auto match with existing open RMA’s for
the same order.
Available values:
0: Don’t receive the RMA automatically
(default). Do not proceed with refund until RMA
is marked as received.
1: Receive the RMA automatically after RMA
creation and proceed with refund.
Restriction: Currently this mark only applies to
the order shipped by seller and is only available
for RMA type = refund.
Note: If the RMA didn’t create successfully, the
RMA will not be automatically received, even if
you specified the mark as 1.
Note: if you are not sure how to use this, please
consult with Datafeeds@newegg.com.
RMANote
No
SellerPartNu
Yes
String
Comment for this RMA. Max 4000 character(s).
String
The seller part number of the item, used to
mber
ReturnQuant
identify the item
Yes
Integer
The return quantity of each item in this RMA
ReturnUnitPr
Yes if
Decimal
The return unit price of each item in refund
ice
RMA
RMA. How much refund will be issued per unit
type =
of this item.
Refun
NOTE: All amounts are set in U.S. Dollars (USD).
RMA Transaction
RMA Transaction List
ity
d
RefundShippi
Yes if
Decimal
The shipping amount of refund of each item in
ngPrice
RMA
this RMA
type =
NOTE: All amounts are set in U.S. Dollars (USD).
Refun
d
311
RMAReason
Yes
Integer
The replacement/refund reason of each item in
this RMA.
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: No longer needed
5: Not match what we show
6: Ordered wrong item
7: Sent wrong item
8: Unsatisfied
Example: XML, RMA Refund Request
XSD
API Schema > RMAManagement > RMA > SubmitRMA > SubmitRMARequest.xsd
POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
IssueRMARequest
2
123456789
E12345678
1
This is a test RMA
test001
1
1.00
312
1.00
2
Example: Json, RMA Refund Request
POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "IssueRMARequest",
"RequestBody": {
"IssueRMA": {
"RMAType": "2",
"SourceSONumber": "123456789",
“SellerRMANumber”:”E12345678”,
"AutoReceiveMark": "1",
"RMANote": "This is a test RMA",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "test001",
"ReturnQuantity": "1",
"ReturnUnitPrice": "1.00",
"RefundShippingPrice": "1.00",
"RMAReason": "2"
}
}
}
}
}
313
Example: XML, RMA Replacement Request
XSD
API Schema > RMAManagement > RMA > SubmitRMA > SubmitRMARequest.xsd
POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma/sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
test@newegg.com
IssueRMARequest
1
123456789
E12345678
1
This is a test RMA
test001
1
2
Example: Json, RMA Replacement Request
POST https://api.newegg.com/marketplace/servicemgmt/rma/newrma/sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "IssueRMARequest",
314
"RequestBody": {
"IssueRMA": {
"RMAType": "1",
"SourceSONumber": "123456789",
“SellerRMANumber”:”E12345678”,
"RMAShipMethod": "1",
"RMANote": "This is a test RMA",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "test001",
"ReturnQuantity": "1",
"RMAReason": "2"
}
}
}
}
}
13.1.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Submit RMA is
successful. Returns true or false.
OperationType
String
Fixed value: IssueRMAResponse
SellerID
String
Your seller ID
RMANumber
Integer
RMA number
RMAType
Integer
1.
Replacement
2.
Refund
RMATypeDescription
String
Replacement for RMAType value 1.
Refund for RMAType value 2.
SellerRMANumber
String
Seller RMA #.
IssueUser
RMAInfo
RMAInfoList
Note: only available for version = 307
ResponseBody
NeweggAPIResponse
An alphanumeric string, max 50 characters.
String
RMA Issue User or Seller ID (if RMA Issue User
was not specified when RMA was created).
RMADate
String
Date of RMA(Pacific Standard Time)
RMAStatus
Integer
6.
Processing
315
RMAStatusDescription
String
Processing (default)
RMAShipMethod
Integer
The ship method if the RMA type =
Replacement:
1: Super Saver(7-14 business days)
2: Standard Shipping(5-7 business days)
3: Expedited Shipping(3-5 business days)
4: Two-Day Shipping(2 business days)
5: One-Day Shipping(Next day)
6: International Economy Shipping(8-15 business
days)
7: International Standard Shipping(5-7 business
days)
8: International Expedited Shipping(3-5 business
days)
9: International Two-Day Shipping(2 business
days)
10: APO/FPO – Military ONLY
11: Newegg Premier 3 Days
12: Newegg Premier 2 Days
13: Newegg Premier Next Day
If RMA type = Refund, this element will be blank.
NOTE: Newegg will apply the same ship method
used by order.
316
RMAShipMethodDescription
String
The ship method if the RMA type =
Replacement:
Super Saver(7-14 business days)for status code:
1
Standard Shipping(5-7 business days) for status
code: 2
Expedited Shipping(3-5 business days) for status
code: 3
Two-Day Shipping(2 business days)for status
code: 4
One-Day Shipping(Next day)for status code: 5
International Economy Shipping(8-15 business
days)for status code: 6
International Standard Shipping(5-7 business
days)for status code: 7
International Expedited Shipping (3-5 business
days)for status code: 8
International Two-Day Shipping(2 business
days) for status code :9
APO/FPO – Military ONLY for status code:10
Newegg Premier 3 Days for status code:11
Newegg Premier 2 Days for status code:12
Newegg Premier Next Day for status code:13
If RMA type = Refund, this element will be blank.
NOTE: Newegg will apply the same ship method
used by order.
OrderNumber
Integer
Order Number of the RMA requested order
OrderDate
String
Order Date(Pacific Standard Time)
InvoiceNumber
Integer
Invoice Number of the order RMA requested
order
OrderAmount
Decimal
Order Amount
NOTE: All amounts are set in U.S. Dollars (USD).
AvailableRefundAmount
Decimal
Available Refund Amount
NOTE: All amounts are set in U.S. Dollars (USD).
RMAProcessedBy
String
Newegg or Seller
RMAReceiveDate
String
RMA shipment received date
RMANote
String
The comment in this RMA
PriorRefundAmount
Decimal
Previous Refund Amount if any
NOTE: All amounts are set in U.S. Dollars (USD).
317
CustomerName
String
Customer Name
CustomerPhoneNumber
String
Customer Phone Number
CustomerEmailAddress
String
The masked customer email address, you can
reach to the customer through this email address.
For example:
gdv6l0viwo4l7j1d@marketplace.newegg.com
ShipToAddress1
String
The order will be ship to address1
ShipToAddress2
String
The order’s ship to address2
ShipToCityName
String
The order’s ship to cityName
ShipToStateCode
String
The order’s ship to state code
ShipToZipCode
String
The order’s ship to zip code
ShipToCountryCode
String
The order’s ship to countrycode.
E.g. UNITED STATES
ShipToLastName
String
The ship to LastName
ShipToFirstName
String
The ship to FirstName
ShipToCompany
String
The order’s ship to company
SellerPartNumber
String
The seller part number to identify a SKU
MfrPartNumber
String
Manufacturer Part Number
NeweggItemNumber
String
Newegg Item Number
Description
String
Item Description
UnitPrice
decimal
Item’s price
RMATransaction
RMATransactionList
NOTE: All amounts are set in U.S. Dollars (USD).
ReturnQuantity
Integer
The return quantity of each SKU in this RMA
ReturnUnitPrice
decimal
If RMA type = Refund: The return unit price of
each item in refund RMA. How much refund will
be issued per unit of this item. If RMA type =
replacement, this element will be blank.
NOTE: All amounts are set in U.S. Dollars (USD).
RefundShippingPrice
decimal
If RMA type = Refund: The shipping amount of
refund of each item in this RMA. If RMA type =
replacement, this element will be blank.
NOTE: All amounts are set in U.S. Dollars (USD).
ShippedBy
Integer
If RMA type = Replacement:
Indicates if shipped by Newegg.
0: Shipped by seller
1: Shipped by Newegg
318
RMAReason
Integer
The replacement/refund reason of each SKU in
this RMA.
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: No longer needed
5: Not match what we show
6: Ordered wrong item
7: Sent wrong item
8: Unsatisfied
9: Other Reason {0}
RMAReasonDescription
String
The replacement/refund reason of each SKU in
this RMA.
Carrier damage for status code: 1
Defective for status code: 2
Incompatible for status code: 3
No longer needed for status code: 4
Not match what we show for status code: 5
Ordered wrong item for status code: 6
Sent wrong item for status code: 7
Unsatisfied for status code: 8
Other Reason {0} for status code: 9
Memo
String
Additional messages
ResponseDate
String
Response date
Example: XML, Response
XSD
API Schema > RMAManagement > RMA > SubmitRMA > SubmitRMAResponse.xsd
true
IssueRMAResponse
A006
2012-02-22 20:59:50
319
20103389
2
Refund
A004
2012-02-22
6
Processing
41473422
2012-01-11
82868509
15.00
12000
newegg
This is a test RMA
2.00
abc Roosevelt
626-271-9700
gdv6l0viwo4l7j1d@marketplace.newegg.com
1941 E. Cedar Loop Drive
9A
South Weber
UT
884405
Roosevelt
abc
201112310900
201112310900
9SIA0040286987
ICYTEST201112310900
600.00
1
1.00
1.00
2
Defective
320
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "IssueRMAResponse",
"SellerID": "A006",
"ResponseDate": "2012-02-22 20:59:50",
"ResponseBody": {
"RMAInfo": {
"RMANumber": "20103389",
"RMAType": "2",
"RMATypeDescription": "Refund",
"IssueUser": "A004",
"RMADate": "2012-02-22",
"RMAStatus": "6",
"RMAStatusDescription": "Processing",
"OrderNumber": "41473422",
"OrderDate": "2012-01-11",
"InvoiceNumber": "82868509",
"OrderAmount": "15.00",
"AvailableRefundAmount": "12000",
"RMANote": "This is a test RMA",
"PriorRefundAmount": "2.00",
"CustomerName": "abc Roosevelt",
"CustomerPhoneNumber": "626-271-9700",
"CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
"ShipToAddress1": "1941 E. Cedar Loop Drive",
"ShipToAddress2": "9A",
"ShipToCityName": "South Weber",
"ShipToStateCode": "UT",
"ShipToZipCode": "884405",
"ShipToLastName":"Roosevelt",
"ShipToFirstName":"abc",
"RMATransactionList": {
"RMATransaction": {
321
"SellerPartNumber": "201112310900",
"MfrPartNumber": "201112310900",
"NeweggItemNumber": "9SIA0040286987",
"Description": "ICYTEST201112310900",
"UnitPrice": "600.00",
"ReturnQuantity": "1",
"ReturnUnitPrice": "1.00",
"RefundShippingPrice": "1.00",
"RMAReason": "2",
"RMAReasonDescription": "Defective"
}
}
}
}
}
13.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SE001
Invalid SellerPartNumber
SE003
OrderNumber is required
SE004
Cannot issue RMA because the order has not been invoiced.
SE005
ShipMethodCode is required when RMAType is replacement
SE006
RMATransaction is required in RMATransactionList
SE007
ReasonCode is required
SE008
Return Qty must be greater than zero
SE009
[Seller Part #] Return Qty has to be equal to or less than Max Return Qty - Prior Returned Qty, currently the
available return qty = {0}.
SE010
Refund per Qty must be greater than zero.
SE011
{Seller Part #} refund price per Qty cannot be greater than item unit price, which = {0.00}.
SE012
Order Shipping Refund cannot be greater than Order Shipping Charge, which = {0.00}.
SE013
Replacement RMA Order Qty cannot be greater than item available inventory.
SE014
Item(s) has two fulfillment channels. Please use DiffShippedByPartyAction field to resolve this issue.
SE020
The following item(s) must return with the current item(s) since they are in a same Combo or Auto Add to Cart
promotion :{ Seller Part # List}.
SE021
The item’s ReturnUnitPrice cannot be greater than the item’s order’s UnitPrice, which = {0.00}.
SE023
Total refund amount cannot exceed total order amount, which = {0.00}.
322
SE024
Item does not exist.
SE025
Cannot issue RMA because the order type is invalid.
SE026
Cannot issue RMA because the order is a replacement order.
SE027
Cannot issue RMA because the order has been voided.
SE031
Auto Receive is not available for order returns processed by Newegg.
SE032
Cannot issue RMA as Auto Receive because the RMA type is not refund.
SE034
Refund cannot exceed order total minus previous refunded amount[{0}]
SE035
This seller account currently does not support the selected shipping method {0}. Please setup this shipping
setting in Seller Portal or select another shipping method.
SE036
The item:{seller part #} unit product refund cannot be less than {minimum refund amount} per account
restocking fee setting: {seller restocking fee rate }
SE038
International seller covered by Newegg Buy-out policy cannot request return or refund directly. Please
contact MarketplaceSupport@newegg.com for assistance.
SE039
This item is not eligible for {refund |replacement}
SE040
This seller RMA number must be a text of number and/or letters.
Example: XML, Response
SE004
Cannot issue RMA because the order has not been invoiced
Example: Json, Response
{
"Code": "SE004",
"Message": "Cannot issue RMA because the order has not been invoiced"
}
13.2.
Update RMA
Receive, Edit, Reject or Void an existing RMA.
323
13.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}&version={versionno}
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
version
No
Available version numbers: 307
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
30 per min per client
Resource Information
13.2.2. Request Body
Edit RMA
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email
address) here.
Only choose from seller account existing login
(email)
Yes
String
Fixed value: EditRMARequest
RMANumber
Yes
integer
RMA Number
RMAType
Yes
integer
Available values:
1: Replacement
2: Refund
SellerRMANumber
No
String
EditRMAInfo
Seller RMA #.
An alphanumeric string, max 50 characters.
Note: only available for version=307
RMANote
No
String
The comment in this RMA
Max 4000 character(s).
SellerPartNumber
Yes
String
Seller Part Number
ReturnQuantity
Yes
integer
The return quantity of each SKU in this RMA
Tran
RMA
sacti
Tran
onLi
sacti
st
on
RMA
RequestBody
NeweggAPIRequest
OperationType
324
ReturnUnitPrice
Yes if
decimal
Refund
The return unit price of each SKU in refund RMA
NOTE: All amounts are set in U.S. Dollars (USD).
type
RefundShippingPric
Yes if
e
Refund
this RMA
type
NOTE: All amounts are set in U.S. Dollars (USD).
RMAReason
Yes
decimal
integer
The shipping amount of refund of each SKU in
The replacement/refund reason of each SKU in
this RMA.
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: No longer needed
5: Not match what we show
6: Ordered wrong item
7: Sent wrong item
8: Unsatisfied
Example: XML, Edit RMA
XSD
API Schema > RMAManagement > RMA > UpdateRMA > UpdateRMARequest.xsd
API Schema > RMAManagement > RMA > UpdateRMA > _UpdateRMA > _RMAEdit.xsd
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
EditRMARequest
38875640
2
your note here
Ben_item_12
325
1
200
10
5
Example: Json, Edit RMA
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "EditRMARequest",
"RequestBody": {
"EditRMAInfo": {
"RMANumber": "38875640",
"RMAType": "2",
“SellerRMANumber”:”E12345678”,
"RMANote": "your note here",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "Ben_item_12",
"ReturnQuantity": "1",
"ReturnUnitPrice": "200",
"RefundShippingPrice": "10",
"RMAReason": "5"
}
}
}
}
}
326
Reject RMA
Attribute
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here.
OperationType
Yes
String
Fixed value: RejectRMARequest
RMANumber
Yes
Integer
RMA Number
RejectReason
Yes
Integer
The reason you reject this RMA
Available values:
1: Remove/Missing Serial Number/Graffiti
2: Warranty Expired
3: Physical Damage
4: Item Missing/Parts Missing
5: Wrong Item Returned
ShipCarrier
Yes
Integer
Which carrier you want to use.
Available values:
3: DHL
4: USPS
5: Other
OtherShipCarrier
Yes when
String
The actual ship carrier if the ship carrier type is specified as
ShipCarrier
other.
= Other
Max 10 character(s).
Only apply on Other ShipCarrier.
ShipService
Yes
String
Which ship service you want to use
Max 50 character(s).
TrackingNumber
Yes
String
The tracking # of shipment(s).
TrackingNumberList
RejectRMAInfo
2: FedEx
RequestBody
NeweggAPIRequest
1: UPS
327
Example: XML, Reject RMA
XSD
API Schema > RMAManagement > RMA > UpdateRMA > UpdateRMARequest.xsd
API Schema > RMAManagement > RMA > UpdateRMA > _UpdateRMA > _RMAReject.xsd
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
RejectRMARequest
38863380
3
5
other
Ground
123123123123
Example: Json, Reject RMA
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "RejectRMARequest",
"RequestBody": {
"RejectRMAInfo": {
"RMANumber": "38863380",
328
"RejectReason": "3",
"ShipCarrier": "5",
"OtherShipCarrier": "other",
"ShipService": "Ground",
"TrackingNumberList": { "TrackingNumber": "123123123123" }
}
}
}
Void RMA
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email address) here.
VoidRMAInfo
OperationType
RequestBody
NeweggAPIRequest
Only choose from seller account existing login (email).
Yes
String
Fixed value: VoidRMARequest
RMANumber
Yes
Integer
RMA Number
VoidReason
Yes
String
The reason you void this RMA.
Max 1000 character(s).
Example: XML, Void RMA
XSD
API Schema > RMAManagement > RMA > UpdateRMA > UpdateRMARequest.xsd
API Schema > RMAManagement > RMA > UpdateRMA > _UpdateRMA > _RMAVoid.xsd
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
VoidRMARequest
38875600
329
Customer Requested
Example: Json, Void RMA
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "VoidRMARequest",
"RequestBody": {
"VoidRMAInfo": {
"RMANumber": "38875600",
"VoidReason": "Customer Requested"
}
}
}
Receive RMA
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email address) here.
ReceiveRMAInfo
OperationType
RequestBody
NeweggAPIRequest
Only choose from seller account existing login (email).
RMANumber
Yes
String
Fixed value: ReceiveRMARequest
Yes
Integer
RMA Number
Example: XML, Receive RMA
XSD
API Schema > RMAManagement > RMA > UpdateRMA > UpdateRMARequest.xsd
330
API Schema > RMAManagement > RMA > UpdateRMA > _UpdateRMA > _RMAReceive.xsd
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
ReceiveRMARequest
38873480
Example: Json, Receive RMA
POST https://api.newegg.com/marketplace/servicemgmt/rma/updaterma?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "ReceiveRMARequest",
"RequestBody": {
"ReceiveRMAInfo": { "RMANumber": "38873480" }
}
}
331
13.2.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify if the current operation is successful.
Returns true or false.
OperationType
String
EditRMAResponse
RejectRMAResponse
VoidRMAResponse
ReceiveRMAResponse
SellerID
String
Your seller ID
Memo
String
Additional messages
ResponseDate
String
Response date (Pacific Standard Time)
RMANumber
Integer
RMA number
RMAType
Integer
Available values:
1: Replacement
2: Refund
RMATypeDescription
String
Replacement for status code: 1
NeweggAPIResponse
Refund for status code: 2
SourceSONumber
Integer
The relevant SO number of the RMA
SellerRMANumber
String
Seller RMA #.
Note: only available for version=307
RMAInfo
ResponseBody
An alphanumeric string, max 50 characters.
IssueUser
String
RMA Issue User or Seller ID (if RMA Issue User was not
specified when RMA was created).
RMAShipMethod
Integer
The ship method if you want issue a replacement RMA.
1: Super Saver(7-14 business days)
2: Standard Shipping(5-7 business days)
3: Expedited Shipping(3-5 business days)
4: Two-Day Shipping(2 business days)
5: One-Day Shipping(Next day)
6: International Economy Shipping(8-15 business days)
7: International Standard Shipping(5-7 business days)
8: International Expedited Shipping(3-5 business days)
9: International Two-Day Shipping(2 business days)
10: APO/FPO – Military ONLY
11: Newegg Premier 3 Days
12: Newegg Premier 2 Days
332
13: Newegg Premier Next Day
If RMA = Refund, then this element will appear blank.
NOTE: Newegg will apply the same ship method used
by order.
RMAShipMethodDescription
String
Super Saver(7-14 business days)for status code: 1
Standard Shipping(5-7 business days) for status code: 2
Expedited Shipping(3-5 business days) for status code:
3
Two-Day Shipping(2 business days)for status code: 4
One-Day Shipping(Next day)for status code: 5
International Economy Shipping(8-15 business days)for
status code: 6
International Standard Shipping(5-7 business days)for
status code: 7
International Expedited Shipping (3-5 business days)for
status code: 8
International Two-Day Shipping(2 business days) for
status code :9
APO/FPO – Military ONLY for status code:10
Newegg Premier 3 Days for status code:11
Newegg Premier 2 Days for status code:12
Newegg Premier Next Day for status code:13
If RMA = Refund, then this element will appear blank.
NOTE: Newegg will apply the same ship method used
by order.
RMATransaction
RMATransactionList
RMANote
String
The comment in this RMA
SellerPartNumber
String
The seller part number to identify a SKU
ReturnQuantity
Integer
The return quantity of each SKU in this RMA
ReturnUnitPrice
Decimal
The return unit price of each SKU in refund RMA.
If RMA = Replacement, then this element will appear
blank.
NOTE: All amounts are set in U.S. Dollars (USD).
RefundShippingPrice
Decimal
The shipping amount of refund of each SKU in this
RMA. If RMA = Replacement, then this element will
appear blank.
NOTE: All amounts are set in U.S. Dollars (USD).
RMAReason
Integer
The replacement/refund reason of each SKU in this
RMA.
333
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: No longer needed
5: Not match what we show
6: Ordered wrong item
7: Sent wrong item
8: Unsatisfied
9: Other Reason {0}
RMAReasonDescription
String
Carrier damage for status code: 1
Defective for status code: 2
Incompatible for status code: 3
No longer needed for status code: 4
Not match what we show for status code: 5
Ordered wrong item for status code: 6
Sent wrong item for status code: 7
Unsatisfied for status code: 8
Other Reason {0} for status code: 9
Example: XML, Response
XSD
API Schema > RMAManagement > RMA > UpdateRMA > UpdateRMAResponse.xsd
true
EditRMAResponse
A006
2011-09-28 09:02:00
38875640
2
Refund
88219202
E12345678
334
your note here
test@newegg.com
Ben_item_12
1
200.00
10.00
1
Carrier damage
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "EditRMAResponse",
"SellerID": "A006",
"ResponseDate": "2011-09-28 09:02:00",
"ResponseBody": {
"RMAInfo": {
"RMANumber": "38875640",
"RMAType": "2",
"RMATypeDescription": "Refund",
"SourceSONumber": "88219202",
“SellerRMANumber”:”E12345678”,
"RMANote": "your note here",
"IssueUser": "test@newegg.com",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "Ben_item_12",
"ReturnQuantity": "1",
"ReturnUnitPrice": "200.00",
"RefundShippingPrice": "10.00",
"RMAReason": "1",
335
"RMAReasonDescription": "Carrier damage"
}
}
}
}
}
13.2.4. Request Failure Errors
Edit RMA
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SE001
Invalid SellerPartNumber
SE004
Cannot issue RMA because the order has not been invoiced.
SE005
ShipMethodCode is required when RMAType is replacement
SE006
RMATransaction is required
SE009
[Seller Part #] Return Qty has to be equal to or less than Max Return Qty - Prior Returned Qty, currently the
available return qty = {0}.
SE010
Refund per Qty must be greater than zero.
SE011
{Seller Part #} refund price per Qty cannot be greater than item unit price, which = {0.00}.
SE012
Order Shipping Refund cannot be greater than Order Shipping Charge, which = {0.00}.
SE013
Replacement RMA Order Qty cannot be greater than item available inventory, which = {0.00}.
SE014
Items have two shipped channels.
SE017
RMANumber is required
SE020
The following item(s) must return with the current item(s) since they are in a same Combo or Auto Add to Cart
promotion:{0}.
SE021
The item’s ReturnUnitPrice cannot be greater than the item’s order’s UnitPrice, which = {0.00}.
SE023
Total refund amount cannot exceed total order amount, which = {0.00}.
SE024
Item does not exist
SE028
Can’t update because RMA was not open
SE029
Can’t update because RMA type = advanced. Please contact Newegg Marketplace Support.
SE034
This seller account currently does not support the selected shipping method {0}. Please setup this shipping
setting in Seller Portal or select another shipping method.
SE035
Refund cannot exceed order total minus previous refunded amount[{0}]
336
SE038
International seller covered by Newegg Buy-out policy cannot request return or refund directly. Please
contact MarketplaceSupport@newegg.com for assistance.
SE040
This seller RMA number must be a text of number and/or letters.
Reject RMA
Error Code
Description
SE001
Invalid SellerPartNumber
SE015
TrackingNumber is required.
SE016
TrackingNumber already exists.
SE017
RMANumber is required
SE028
Can’t update because RMA was not open
SE029
Can’t update because RMA type = advanced. Please contact Newegg Marketplace Support.
SE030
Can't update because international seller processing by Newegg
Void RMA
Error Code
Description
SE017
RMANumber is required
SE028
Can’t update because RMA was not open
SE029
Can’t update because RMA type = advanced. Please contact Newegg Marketplace Support.
SE030
Can't update because international seller processing by Newegg
Receive RMA
Error Code
Description
SE014
Items have two shipped channels.
SE017
RMANumber is required
SE028
Can’t update because RMA was not open
SE029
Can’t update because RMA type = advanced. Please contact Newegg Marketplace Support.
SE030
Can't update because international seller processing by Newegg
Example: XML, Response
SE004
337
Cannot issue RMA because the order has not been invoiced
Example: Json, Response
{
"Code": "SE004",
"Message": "Cannot issue RMA because the order has not been invoiced"
}
13.3. Get RMA Info
Get RMA info by specified query conditions.
13.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/servicemgmt/rma/rmainfo?sellerid={sellerid}&version={versionno}
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
version
No
Available Version Numbers
307. Response includes the Seller’s own RMA # for reference.
309. Response includes:
Seller’s own RMA # for reference.
The replacement order # for related RMA.
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
30 per min per client
13.3.2. Request Body
338
Attribute
IssueUser
Required?
Format
Description
No
string
Specify your eligible seller account (email address) here.
Only choose from seller account existing login (email)
OperationType
PageSize
Yes
String
Fixed value: GetRMAInfoRequest
No
Integer
How many records in a page. (Max is 100 per page)
If left blank, will use 1 as default.
PageIndex
No
Integer
Current page index. Default is 1.
If left blank, will use 100 as default.
KeywordsType
No
Integer
Available values:
1: RMANumber
2: OrderNumber
3: CustomerName
4: SellerRMANumber (Note: only available for
NeweggAPIRequest
version=307)
KeywordsValue
No
String
The keywords value of the specified type
Status
No
Integer
Available values:
0: All (Default)
1: Open
2: Received
3: Rejected
4: Voided
5: Closed
6: Processing
RMADateFrom
No
String
Search RMA by date range.
(Pacific Standard Time)
Please refer to the Acceptable Date Format
RMADateTo
No
String
Search RMA by date range.
(Pacific Standard Time)
Please refer to the Acceptable Date Format
RMAType
No
Integer
Available values:
0: All (Default)
1: Replacement
2: Refund
ProcessedBy
No
Integer
Available values:
0: All (Default)
1: Seller
339
2: Newegg
Example: XML, Request
XSD
API Schema > RMAManagement > RMA > GetRMAInfo > RMAInfoRequest.xsd
PUT https://api.newegg.com/marketplace/servicemgmt/rma/rmainfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetRMAInfoRequest
1
10
1
2135422
0
2012-01-11
2012-01-12
0
0
Example: Json, Request
PUT https://api.newegg.com/marketplace/servicemgmt/rma/rmainfo?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
340
Accept: application/json
{
"OperationType": "GetRMAInfoRequest",
"RequestBody": {
"PageInfo": {
"PageIndex": "1",
"PageSize": "10"
},
"KeywordsType": "1",
"KeywordsValue": "2135422",
"Status": "0",
"RMADateFrom": "2012-01-11",
"RMADateTo": "2012-01-12",
"RMAType": "0",
"ProcessedBy": "0"
}
}
341
13.3.3. Response Body
Attribute
Format
Description
Available
Ver.#
IsSuccess
String
Used to identify the operation of Submit
All
RMA is successful. Returns true or false.
String
Fixed value: IssueRMAResponse
All
SellerID
String
Your seller ID
All
TotalCount
Integer
How many record(s) for you request
All
TotalPageCount
Integer
How many page(s) return
All
PageIndex
Integer
Current page index. (Default is 1)
All
PageSize
Integer
How many record(s) in a page. (Max 100
All
PageInfo
OperationType
per page)
RMANumber
Integer
RMA number
All
RMAType
Integer
Available values:
All
1: Replacement
RMATypeDescription
String
Replacement for type value: 1
All
Refund for type value: 2
SellerRMANumber
String
Seller RMA #.
307,
309
An
alphanumeric
string,
max
50
RMAInfo
characters.
RMAInfoList
ResponseBody
NeweggAPIResponse
2: Refund
Note: available for version=307 and 309
ReplacementOrderNumber
String
The Order Number of the replacement
309
order.
After confirming the return item is
received, Newegg will create a
replacement order for you to process.
Note: available for RMA type:
Replacement (RMAType value= 1) and
the request version=309
IssueUser
String
RMA Issue User or Seller ID (if RMA Issue
All
User was not specified when RMA was
created).
RMADate
String
Date of RMA(Pacific Standard Time)
All
342
RMAStatus
Integer
Available values:
All
1: Open
2: Received
3: Rejected
4: Voided
5: Closed
6: Processing
RMAStatusDescription
String
Available values:
All
Open for status code: 1
Received for status code: 2
Rejected for status code: 3
Voided for status code: 4
Closed for status code: 5
Processing for status code: 6
RMAShipMethod
Integer
The ship method if the RMA type =
All
Replacement:
1: Super Saver(7-14 business days)
2: Standard Shipping(5-7 business days)
3: Expedited Shipping(3-5 business days)
4: Two-Day Shipping(2 business days)
5: One-Day Shipping(Next day)
6: International Economy Shipping(8-15
business days)
7: International Standard Shipping(5-7
business days)
8: International Expedited Shipping(3-5
business days)
9: International Two-Day Shipping(2
business days)
10: APO/FPO – Military ONLY
11: Newegg Premier 3 Days
12: Newegg Premier 2 Days
13: Newegg Premier Next Day
If RMA = Refund, then this element will
appear blank.
343
RMAShipMethodDescription
String
The ship method if the RMA type =
All
Replacement:
Super Saver(7-14 business days)for status
code: 1
Standard Shipping(5-7 business days) for
status code: 2
Expedited Shipping(3-5 business days) for
status code: 3
Two-Day Shipping(2 business days)for
status code: 4
One-Day Shipping(Next day)for status
code: 5
International Economy Shipping(8-15
business days)for status code: 6
International Standard Shipping(5-7
business days)for status code: 7
International Expedited Shipping (3-5
business days)for status code: 8
International Two-Day Shipping(2
business days) for status code :9
APO/FPO – Military ONLY for status
code:10
Newegg Premier 3 Days for status
code:11
Newegg Premier 2 Days for status
code:12
Newegg Premier Next Day for status
code:13
If RMA = Refund, then this element will
appear blank.
OrderNumber
Integer
Order Number of the RMA requested
All
OrderDate
String
Order Date(Pacific Standard Time)
All
InvoiceNumber
Integer
Invoice Number of the order RMA
All
requested.
OrderAmount
Decima
Order Amount
l
NOTE: All amounts are set in U.S. Dollars
All
(USD).
AvailableRefundAmount
Decima
Available Refund Amount
l
NOTE: All amounts are set in U.S. Dollars
All
(USD).
344
RMAProcessedBy
String
Newegg or Seller
All
RMAReceiveDate
String
RMA shipment received date
All
RMANote
String
RMA note
All
PriorRefundAmount
Decima
Order Prior Refund Amount
All
l
NOTE: All amounts are set in U.S. Dollars
(USD).
CustomerName
String
Customer Name
All
CustomerPhoneNumber
String
Customer Phone Number
All
CustomerEmailAddress
String
The masked customer email address, you
All
can reach to the customer through this
email address.
For example:
gdv6l0viwo4l7j1d@marketplace.newegg.
com
ShipToAddress1
String
The order’s ship to address line 1
All
ShipToAddress2
String
The order’s ship to address line 2
All
ShipToCityName
String
The order’s ship to city name
All
ShipToStateCode
String
The order’s ship to state code
All
(abbreviated)
ShipToZipCode
String
The order’s ship to zip code
All
ShipToCountryCode
String
The order’s ship to country.
All
E.g. UNITED STATES
The ship to Last Name
All
ShipToFirstName
String
The ship to First Name
All
ShipToCompany
String
The order’s ship to company name
All
SellerPartNumber
String
Seller Part Number
All
MfrPartNumber
String
Manufacturer Part Number
All
NeweggItemNumber
String
Newegg Item Number
All
Description
String
Item Description
All
UnitPrice
decima
Item’s Unit Price
All
l
NOTE: All amounts are set in U.S. Dollars
RMATransaction
String
RMATransactionList
ShipToLastName
(USD).
ReturnQuantity
Integer
The return quantity of each SKU in this
All
RMA
345
ReturnUnitPrice
decima
If RMA type = Refund: The return unit
l
price of each item in refund RMA. How
All
much refund will be issued per unit of this
item. If RMA = Replacement, then this
element will appear blank.
NOTE: All amounts are set in U.S. Dollars
(USD).
RefundShippingPrice
decima
If RMA type = Refund: The shipping
l
amount of refund of each item in this
All
RMA. If RMA = Replacement, then this
element will appear blank.
NOTE: All amounts are set in U.S. Dollars
(USD).
ShippedBy
Integer
If RMA type = Replacement:
All
Indicates if shipped by Newegg.
0: Shipped by seller
1: Shipped by Newegg
If RMA = Refund, then this element will
appear blank.
RMAReason
Integer
The replacement/refund reason of each
All
SKU in this RMA.
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: No longer needed
5: Not match what we show
6: Ordered wrong item
7: Sent wrong item
8: Unsatisfied
9: Other Reason {0}
346
RMAReasonDescriptio
String
n
The replacement/refund reason of each
All
SKU in this RMA.
Available values:
Carrier damage for status code: 1
Defective for status code: 2
Incompatible for status code: 3
No longer needed for status code: 4
Not match what we show for status
code: 5
Ordered wrong item for status code: 6
Sent wrong item for status code: 7
Unsatisfied for status code: 8
Other Reason {0} for status code: 9
Memo
String
Additional messages
All
ResponseDate
String
Response date
All
Example: XML, Response
XSD
API Schema > RMAManagement > RMA > GetRMAInfo > RMAInfoResponse.xsd
true
GetRMAInfo
A006
05/16/2013 14:57:25
1
1
1
50
53424440
2
347
Refund
E12345678
A006
12/19/2012 00:06:30
5
Closed
153985075
12/18/2012 23:00:09
95843690
3.99
0.00
Seller
01/09/2013 18:40:28
0.00
Fiona Test
626-271-1420
cq2sw1pler2vt958m@marketplace.newegg.com
17708 Rowland St
Rowland Heights
CA
91748-1119
UNITED STATES
Test
Fiona
nz-tst-123
nz-tst-123
9SIA0060BB9157
Nazi Power Flag
3.99
1
3.99
0.00
4
348
No longer needed
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetRMAInfo",
"SellerID": "A006",
"ResponseDate": "05/16/2013 14:57:25",
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageIndex": "1",
"PageSize": "50"
},
"RMAInfoList": {
"RMAInfo": {
"RMANumber": "53424440",
"RMAType": "2",
"RMATypeDescription": "Refund",
“SellerRMANumber”:”E12345678”,
"IssueUser": "A006",
"RMADate": "12/19/2012 00:06:30",
"RMAStatus": "5",
"RMAStatusDescription": "Closed",
"OrderNumber": "153985075",
"OrderDate": "12/18/2012 23:00:09",
"InvoiceNumber": "95843690",
"OrderAmount": "3.99",
"AvailableRefundAmount": "0.00",
"RMAProcessedBy": "Seller",
"RMAReceiveDate": "01/09/2013 18:40:28",
"PriorRefundAmount": "0.00",
"CustomerName": "Fiona Test",
349
"CustomerPhoneNumber": "626-271-1420",
"CustomerEmailAddress": "cq2sw1pler2vt958m@marketplace.newegg.com",
"ShipToAddress1": "17708 Rowland St",
"ShipToCityName": "Rowland Heights",
"ShipToStateCode": "CA",
"ShipToZipCode": "91748-1119",
"ShipToCountryCode": "UNITED STATES",
"ShipToLastName": "Test",
"ShipToFirstName": "Fiona",
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "nz-tst-123",
"MfrPartNumber": "nz-tst-123",
"NeweggItemNumber": "9SIA0060BB9157",
"Description": "Nazi Power Flag",
"UnitPrice": "3.99",
"ReturnQuantity": "1",
"ReturnUnitPrice": "3.99",
"RefundShippingPrice": "0.00",
"RMAReason": "4",
"RMAReasonDescription": "No longer needed"
}
}
}
}
}
}
13.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
CE001
SellerID cannot be null or empty
350
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
13.4. Issue Courtesy Refund
Submit a Courtesy Refund Request. Use this function when it is simply to issue the customer a courtesy refund that does
not require RMA shipment returned to seller. This function is a request and will need user to use Get Request Status
(listed in the next section) to receive update about the status of the Courtesy Refund creation. Please note that
commission will not be refunded for refunds issued as courtesy refund.
13.4.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/new?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
30 per min per client
Resource Information
13.4.2. Request Body
Attribute
Requir
Format
Description
String
Specify your eligible seller account (email address) here.
est
equ
APIR
IssueUser
egg
New
ed?
No
Only choose from seller account existing login (email)
351
OperationType
SourceSONumbe
Yes
String
Fixed value: IssueCourtesyRefund
Yes
Integer
Order Number which you wish to issue a courtesy refund for.
Yes
Integer
Available values for refund reason:
r
RefundReason
1: Negative customer feedback
IssueCourtesyRefund
RequestBody
2: Pricing error
3: Wrong item information
4: Shipping delay
5: Package not received
6: Customer Courtesy
TotalRefundAmo
Yes
Decimal
The total amount need to refund.
unt
The total refund amount cannot exceed order amount or order
amount minus previously refunded amount.
NOTE: All amounts are set in U.S. Dollars (USD).
NoteToCustomer
No
String
The note of this courtesy refund to customer.
Max 500 character(s).
Example: XML, Request
XSD
API Schema > RMAManagement > RMA > CourtesyRefund > IssueCourtesyRefund > IssueCRRequest.xsd
POST https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/new?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
IssueCourtesyRefund
11007735
1
2.01
this is a test note
352
Example: Json, Request
POST https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/new?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "IssueCourtesyRefund",
"RequestBody": {
"IssueCourtesyRefund": {
"SourceSONumber": "11007735",
"RefundReason": "1",
"TotalRefundAmount": "2.01",
"NoteToCustomer": "this is a test note"
}
}
}
13.4.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify if the operation of Issue Courtesy Refund is
Fixed value: CourtesyRefundResponse
SellerID
String
Your Seller ID
RequestID
String
The request ID
RequestDate
String
The date when the request was submitted. (Pacific Standard
ResponseInfo
String
ResponseList
OperationType
ResponseBody
NeweggAPIResponse
successful. Returns true or false
Memo
Time)
RequestSatus
String
The status of the request submission.
SUBMITTED
String
Additional information
Example: XML, Response
353
XSD
API Schema > RMAManagement > RMA > CourtesyRefund > IssueCourtesyRefund > IssueCRResponse.xsd
true
CourtesyRefundResponse
A006
cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8
2/17/2012 19:15:00
SUBMITTED
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "CourtesyRefundResponse",
"SellerID": "A006",
"ResponseBody": {
"ResponseList": {
"ResponseInfo": {
"RequestId": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
"RequestDate": "2/17/2012 19:15:00",
"RequestStatus": "SUBMITTED"
}
}
}
}
13.4.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
354
Error Code
Description
SE004
Cannot issue RMA because the order has not been invoiced.
SE019
Item total refund amount must be greater than 0.
SE023
Total refund amount CANNOT exceed total order amount.
SE025
Invalid order type.
SE026
Can't issue because of replacement order.
SE027
Can't issue because order was voided.
SE033
Invalid order number.
SE038
International seller covered by Newegg Buy-out policy cannot request return or refund directly. Please
contact MarketplaceSupport@newegg.com for assistance.
Example: XML, Response
CE001
SellerID cannot be null or empty
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
13.5. Get Courtesy Refund Request Status
Get the status of specified courtesy refund request by specified query conditions.
13.5.1. Resource URL & Information
Resource URL
355
https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
30 per min per client
Resource Information
13.5.2. Request Body
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email address) here.
Only choose from seller account existing login (email)
RequestID
MaxCount
Yes
String
Fixed value: GetCourtesyRefundStatusRequest
No
String
Courtesy refund Request ID. Other condition(s) will be
ignored Issue courtesy refund Request ID is specified.
No
Integer
The maximum return records. Default is 100. If you specified
GetRequestStatus
over than 100, the system still return 100 records.
RequestBody
NeweggAPIRequest
RequestIDList
OperationType
RequestStatus
No
String
The available values of the status of the request submission.
ALL (Default)
SUBMITTED
IN_PROGRESS
FINISHED
FAILED
CANCELLED
RequestDateFrom
No
String
Search by Courtesy Refund Date. (Pacific Standard Time)
Please refer to the Acceptable Date Format
RequestDateTo
No
String
Search by Courtesy Refund Date. (Pacific Standard Time)
Please refer to the Acceptable Date Format
Example: XML, Request
356
XSD
API Schema > RMAManagement > RMA > CourtesyRefund > GetCourtesyRefundStatus > GetCRStatusRequest.xsd
PUT
https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetCourtesyRefundStatusRequest
cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8
100
ALL
Example: Json, Request
PUT
https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetCourtesyRefundStatusRequest",
"RequestBody": {
"GetRequestStatus": {
"RequestIDList": {
357
"RequestID": [
"cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8"
]
},
"MaxCount": "100",
"RequestStatus": "ALL"
}
}
}
13.5.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get Courtesy Refund
Request Status is successful. Returns true or false.
OperationType
String
Fixed value: GetCourtesyRefundRequestStatusResponse
SellerID
String
Seller ID
RequestId
string
The identifier of a request
RequestType
string
The value is fixed, will always be “COURTESYREFUND”
RequestDate
String
The date when the request was submitted. (Pacific
Standard Time)
RequestStatus
String
The available values of the status of the request
submitted:
SUBMITTED
IN_PROGRESS
FAILED
Response Info
CANCELLED
Note: If you received the request status = ‘FAILED’,
please refer to the detailed reason in the
[ProcessMemo] field.
If you received the request status = ‘FINISHED’, the
courtesy refund info will be displayed.
ProcessMemo
String
If status = failed, detailed error message(s) will be
CourtesyRefundID
String
Refund Transaction ID
SONumber
Integer
Order Number
SOAmount
Decimal
Order Amount
InvoiceNumber
Integer
Order Invoice Number
Refund Info
Courtesy
displayed here.
Result
Response List
Response Body
FINISHED
358
RefundAmount
Decimal
Refund Amount
ReasonCode
Integer
Available values:
1: Negative customer feedback
2: Pricing error
3: Wrong item information
4: Shipping delay
5: Package not received
6: Customer Courtesy
Reason
String
Available values:
Negative customer feedback for reason code: 1
Pricing error for reason code: 2
Wrong item information for reason code: 3
Shipping delay for reason code: 4
Package not received for reason code: 5
Customer Courtesy for reason code: 6
NoteToCustomer
String
Note to Customer
Status
String
The available values of the courtesy refund status:
1: Open
2: Close
3: Void
IsNeweggRefund
String
Specify the refund issued by Newegg Customer Service
agent.
Returns true or false.
InUserName
String
Courtesy refund creator
InDate
String
Courtesy refund create date(Pacific Standard Time)
EditUserName
String
Last Edit User
EditDate
String
Last Edit Date(Pacific Standard Time) (Pacific Standard
Time)
Memo
String
Additional messages
Example: XML, Response
XSD
API Schema > RMAManagement > RMA > CourtesyRefund > GetCourtesyRefundStatus > GetCRStatusResponse.xsd
true
GetCourtesyRefundRequestStatusResponse
A006
359
cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8
COURTESYREFUND
2012-03-07 12:37:09
FINISHED
cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8
164878278
1.00
84724946
1.00
1
Negative Customer Feedback
this is a test note
Close
false
A006
2012-03-07 12:38:00
EDI
2012-03-07 13:07:02
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"OperationType": "GetCourtesyRefundRequestStatusResponse",
"SellerID": "A006",
"ResponseBody": {
"ResponseList": {
"ResponseInfo": {
"RequestId": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
360
"RequestType": "COURTESYREFUND",
"RequestDate": "2012-03-07 12:37:09",
"RequestStatus": "FINISHED",
"Result": {
"CourtesyRefundInfo": {
"CourtesyRefundID": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
"SONumber": "164878278",
"SOAmount": "1.00",
"InvoiceNumber": "84724946",
"RefundAmount": "1.00",
"ReasonCode": "1",
"Reason": "Negative Customer Feedback",
"NoteToCustomer": "this is a test note",
"Status": "Close",
"IsNeweggRefund": "false",
"InUserName": "A006",
"InDate": "2012-03-07 12:38:00",
"EditUserName": "EDI",
"EditDate": "2012-03-07 13:07:02"
}
}
}
}
}
}
}
13.5.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
CE001
SellerID cannot be null or empty
361
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
13.6. Get Courtesy Refund Info
Get the specified courtesy refund information by specified query conditions.
13.6.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
30 per min per client
Resource Information
13.6.2. Request Body
NeweggAPIRequest
Attribute
IssueUser
Required?
Format
Description
No
String
Specify your eligible seller account (email address) here.
Only choose from seller account existing login (email)
OperationType
PageIndex
Yes
String
Fixed value: GetCourtesyRefundInfo
No
Integer
Current page index
If left blank, will use 1 as default.
362
PageSize
No
Integer
Return records count in one page.
(Max is 100 per page)
If left blank, will use 100 as default.
KeywordsType
No
Integer
Available values:
0: All (default)
1: CourtesyRefundID
2: OrderNumber
3: CustomerName
KeywordsValue
No
String
The keywords value of the specified type. If the type is 0,
ignore this field.
Status
No
Integer
Available values:
0: All(Default)
1: Open
2: Void
3: Close
DateFrom
No
String
Search by Courtesy Refund Date. (Pacific Standard Time)
Please refer to the Acceptable Date Format
DateTo
No
String
Search by Courtesy Refund Date. (Pacific Standard Time)
Please refer to the Acceptable Date Format
Example: XML, Request
XSD
API Schema > RMAManagement > RMA > CourtesyRefund > GetGetCourtesyRefundInfo > GetCRInfoRequest.xsd
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetCourtesyRefundInfo
1
10
0
363
0
2001-12-17 09:30:47
2011-12-17 12:30:47
Example: Json, Request
PUT https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetCourtesyRefundInfo",
"RequestBody": {
"PageInfo": {
"PageIndex": "1",
"PageSize": "10"
},
"KeywordsType": "0",
"Status": "0",
"DateFrom": "2001-12-17 09:30:47",
"DateTo": "2011-12-17 12:30:47"
}
}
13.6.3. Response Body
Attribute
Description
String
Used to identify the operation of Get Courtesy Refund Info
Request is successful. Returns true or false.
OperationType
String
Fixed value: GetCourtesyRefundResponse
SellerID
String
SellerID
ResponseDate
String
The date when the request was submitted. (Pacific
onse
Page
Body
Info
Standard Time)
Resp
NeweggAPIResponse
IsSuccess
Format
TotalCount
Integer
How many records
TotalPageCount
Integer
How many pages return
364
PageSize
Integer
How many records in a page
PageIndex
Integer
Current page index
CourtesyRefundID
String
Refund Transaction ID
SONumber
Integer
Order Number
SOAmount
Decimal
Order Amount
NOTE: All amounts are set in U.S. Dollars (USD).
InvoiceNumber
Integer
Order Invoice Number
RefundAmount
Decimal
Refund Amount
NOTE: All amounts are set in U.S. Dollars (USD).
ReasonCode
Integer
Available values:
1: Negative customer feedback
2: Pricing error
3: Wrong item information
4: Shipping delay
6: Customer Courtesy
courtesyrefundInfo
courtesyrefundInfoList
5: Package not received
Reason
String
Available values:
Negative customer feedback for reason code: 1
Pricing error for reason code: 2
Wrong item information for reason code: 3
Shipping delay for reason code: 4
Package not received for reason code: 5
Customer Courtesy for reason code: 6
NoteToCustomer
String
Additional Memo to customer.
Status
String
The available values for courtesy refund status:
1: Open
2: Close
3: Void
IsNeweggRefund
String
This is a refund issued by Newegg Customer Service agent.
Returns true or false.
InUserName
String
Refund Creator
InDate
String
Refund Create Date(Pacific Standard Time)
EditUserName
String
Last Edit User
EditDate
String
Last Edit Date(Pacific Standard Time) (Pacific Standard
Time)
Example: XML, Reponses
XSD
API Schema > RMAManagement > RMA > CourtesyRefund > GetGetCourtesyRefundInfo > GetCRInfoResponse.xsd
365
true
GetCourtesyRefundResponse
A006
2012-02-17 15:12:00
1
1
10
1
8a9501f2-495a-4b4f-b921-966a40969aa8
88251262
890.40
48799955
2.01
1
Negative Customer Feedback
This is a test note
Close
false
A006
2012-02-17 12:10:00
A006
2012-02-17 12:10:00
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
366
"OperationType": "GetCourtesyRefundResponse",
"SellerID": "A006",
"ResponseDate": "2012-02-17 15:12:00",
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageSize": "1",
"PageIndex": "10"
},
"CourtesyRefundInfoList": {
"CourtesyrefundInfo": {
"CourtesyRefundID": "8a9501f2-495a-4b4f-b921-966a40969aa8",
"SONumber": "88251262",
"SOAmount": "890.40",
"InvoiceNumber": "48799955",
"RefundAmount": "2.01",
"ReasonCode": "1",
"Reason": "Negative Customer Feedback",
"NoteToCustomer": "This is a test note",
"Status": "Close",
"IsNeweggRefund": "false",
"InUserName": "A006",
"InDate": "2012-02-17 12:10:00",
"EditUserName": "EDI",
"EditDate": "2012-02-17 12:10:00"
}
}
}
}
}
13.6.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Example: XML, Response
367
CE001
SellerID cannot be null or empty
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
368
14. Report Management
You can submit API requests to generate business reports.
Steps to Request and Retrieve a report:
Step 1- Submit a report request using the SubmitReportRequest operation. This is a request to Newegg
Marketplace API to generate a specific report.
Step 2- Submit a request using Get Report Status service to get a list of report requests’ ID and status. Newegg
Marketplace API returns a Request ID and status for every report requested. When the status of a report request
is “FINISHED”, you can use the Get Report Result service to retrieve the report.
Step 3- Submit a request using the Get Report Result service to receive a specific report. Depending on the
report type, a XML format report will be returned or an URL of the report will be provided for you to download the
file.
14.1. Submit Report Request
The following types of Business Report are available:
Order List Report
Settlement Summary Report
Settlement Transaction Report
RMA List Report
Item Lookup Report
Daily Inventory Report
Daily Price Report
Newegg Premier Item Report
California’s Proposition 65 Warning Report
Tax Setting Report for Items Enabled for China
14.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}&version={versionno}
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
369
Available Version Number: 310
Related Function:
Daily Inventory Report
Version
No
Daily Price Report
NOTE: Compress multiple files, 40,000 records per file, into a zip formatted
single package. If your report will include 40,000 or more records, please
apply this version to avoid error.
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
30 per min per client
14.1.2. Request Body
Order List Report
Attribute
IssueUser
Required?
Format
Description
No
string
Specify your eligible seller account (email address)
here
OperationType
Yes
string
Fixed value: OrderListReportRequest
RequestType
Yes
string
ORDER_LIST_REPORT
KeywordsType
Yes
Integer
Available values:
0:All
1: OrderNumber
3: CustomerName
OrderReportCriteria
4: SellerPartNumber
RequestBody
NeweggAPIRequest
2: InvoiceNumber
5: NeweggItemNumber
6: CustomerPhoneNumber
7: TitleDescription
8: Manufacturer
9: SellerOrderNumber
NOTE: 9: SellerOrderNumber is designed for sellers
using SBN (Shipped by Newegg) to fulfill multichannel orders.
KeywordsValue
No
string
The keywords value of the specified type. If the type
is 0, ignore this field
Status
Yes
Integer
Available values:
0: Unshipped
370
1: Partially Shipped
2: Shipped
3: Invoiced
4: Voided
Type
No
Integer
Available values:
0: All (Default)
1: SBN
2: SBS
3: Multi-Channel
OrderDateFrom
No
string
Search by Order Date Range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
OrderDateTo
No
string
Search by Order Date Range.
(Pacific Standard
Time)
Please refer to the Acceptable Date Format
VoidSoon
No
Integer
the order will be auto void after 24 or 48 hours
Available values:
24
48
OrderDownloaded
No
string
false(Default): include those downloaded orders
true: don’t include those downloaded orders
CountryCode
No
String
The country for your orders. Only the ISO standard
3-digit codes are accepted.
To review the complete list of available values,
please download the following:
https://promotions.newegg.com/Marketplace/Selle
rs/resourceLibrary/International%20Country%20Gui
de.pdf
PremierOrder
No
Integer
0: All (Default)
1: Premier Order Only
2: No Premier Order
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > OrderListRequest.xsd
371
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
OrderListReportRequest
ORDER_LIST_REPORT
0
4
0
2011-12-07
2012-12-30
false
USA
1
372
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "OrderListReportRequest",
"RequestBody": {
"OrderReportCriteria": {
"RequestType": "ORDER_LIST_REPORT",
"KeywordsType": "0",
"Status": "4",
"Type": "0",
"OrderDateFrom": "2011-12-07",
"OrderDateTo": "2012-12-30",
"OrderDownloaded": "false",
"CountryCode":”USA",
"PremierOrder":"1"
}
}
}
Settlement Summary Report
Attribute
Requir
Format
Description
string
Specify your eligible seller account (email address) here
OperationType
Yes
string
Fixed value: SettlementSummaryReportRequest
RequestType
Yes
string
SETTLEMENT_SUMMARY_REPORT
DateFrom
Yes
String
Date Range beginning(Pacific Standard Time)
ReportCriteria
No
SettlementSummary
IssueUser
RequestBody
NeweggAPIRequest
ed?
Please refer to the Acceptable Date Format
DateTo
Yes
String
Date Range end(Pacific Standard Time)
Please refer to the Acceptable Date Format
373
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > SettlementSummaryRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
SettlementSummaryReportRequest
SETTLEMENT_SUMMARY_REPORT
2011-12-01
2011-12-30
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "SettlementSummaryReportRequest",
"RequestBody": {
"SettlementSummaryReportCriteria": {
"RequestType": "SETTLEMENT_SUMMARY_REPORT",
"DateFrom": "2011-12-01",
"DateTo": "2011-12-30"
}
}
}
374
Settlement Transaction Report
Attribute
Required?
Format
Description
IssueUser
No
string
Specify your eligible seller account (email address) here
OperationType
Yes
string
Fixed value: SettlementTransactionReportRequest
RequestType
Yes
string
SETTLEMENT_TRANSACTION_REPORT
OrderNumber
No
Integer
Order number
TransactionType
No
Integer
Available values:
0: All (Default)
1: Order
2: Refund
3: CreditRequest
4: Chargeback
5: MonthlyFee
SettlementTransactionReportCriteria
RequestBody
NeweggAPIRequest
6: FulfillByNeweggFee
7: Multi-ChannelFee
8: RMAProcessingFee
9: Tax & Duty
10:StorageFee
11:RMABuyoutFee
12:AdjustmentFee
13:MonthlyFeeByCC
14:SBNInboundFee
15:MerchandisingFee
16:NeweggPremierFee
17:NeweggShippingLabelFee
18:ReturnAndDisposalFee
19:NeweggRelabelingFee
SettlementDateFrom
No
String
Search by Settlement Date Range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
SettlementDateTo
No
String
Search by Settlement Date Range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
SettlementDate
No
String
Search by Settlement Date. (Pacific Standard Time)
Please refer to the Acceptable Date Format
SettlementID
No
Integer
The settlement transaction ID
375
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > SettlementTransactionRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
SettlementTransactionReportRequest
SETTLEMENT_TRANSACTION_REPORT
1
2011-02-21
2012-02-22
2/23/2012
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "SettlementTransactionReportRequest",
"RequestBody": {
"SettlementTransactionReportCriteria": {
"RequestType": "SETTLEMENT_TRANSACTION_REPORT",
376
"TransactionType": "1",
"SettlementDateFrom": "2011-02-21",
"SettlementDateTo": "2012-02-22",
"SettlementDate":"2/23/2012"
}
}
}
RMA List Report
Attribute
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed value: RMAListReportRequest
RequestType
Yes
String
RMA_LIST_REPORT
KeywordsType
No
Integer
Available values:
0: All (default)
1: RMANumber
2: OrderNumber
3: CustomerName
4: SellerRMANumber
RMAListReportCriteria
RequestBody
NeweggAPIRequest
keywordsValue
No
String
The keywords value of the specified type. If the type is 0, ignore this
field.
Status
No
Integer
Available values:
0: All (Default)
1: Open
2: Received
3: Rejected
4: Voided
5: Closed
6: Processing
RMADateFrom
Yes
String
Search by RMA Date Range.
(Pacific Standard Time)
Please refer to the Acceptable Date Format
RMADateTo
Yes
String
Search by RMA Date Range.
(Pacific Standard Time)
Please refer to the Acceptable Date Format
377
RMAType
No
Integer
Available values:
0: All (Default)
1: Replacement
2: Refund
ProcessedBy
No
Integer
Available values:
0: All (Default)
1: Seller
2: Newegg
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > RMAListRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
RMAListReportRequest
RMA_LIST_REPORT
0
4
2011-12-17
2011-12-30
0
0
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
378
Content-Type: application/json
Accept: application/json
{
"OperationType": "RMAListReportRequest",
"RequestBody": {
"RMAListReportCriteria": {
"RequestType": "RMA_LIST_REPORT",
"KeywordsType": "0",
"Status": "4",
"RMADateFrom": "2011-12-17",
"RMADateTo": "2011-12-30",
"RMAType": "0",
"ProcessedBy": "0"
}
}
}
Item Lookup Report
Attribute
OperationType
UPC
Required?
Format
Description
Yes
String
Fixed value: ItemLookupRequest
No
String
The UPC code
Integer
Available values:
(Yes, if
Condition
No
1: New
Item
RequestCriteria
provided)
RequestBody
NeweggAPIRequest
ManufacturerPartNumber is not
2: Refurbished
3: Used – Like New
4: Used – Very Good
5: Used – Good
6: Used – Acceptable
ManufacturerName
No
String
The manufacturer name
(Yes, if UPC is not provided)
379
ManufacturerPartN
No
umber
(Yes, if UPC is not provided)
PacksOrSets
No
Integer
The manufacturer part number
Integer
Identify the package count of this product.
Please note: all products in a pack or set will
have matching item and condition.
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > ItemLookupRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
ItemLookupRequest
-
20140711101111
1
q-see
canmfpn20140711101
1
-
20140711101111
1
q-see
canmfpn20140711101
-
1
q-see
canmfpn20140711101
4
380
-
q-see
canmfpn20140711101
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "ItemLookupRequest",
"RequestBody": {
"RequestCriteria": {
"Item": [
{
"UPC": "20140711101111",
"Condition": "1",
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101"
},
{
"UPC": "20140711101111",
"Condition": "1",
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101"
},
{
"Condition": "1",
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101"
},
{
381
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101"
}
]
}
}
}
Daily Inventory Report
Attribute
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed value: InternationalInventoryReportRequest
No
Integer
Available values:
FulfillType
0: All
1: Fulfill by Seller
WarehouseLocation
No
String
WarehouseList
DailyInventoryReportCriteria
RequestBody
NeweggAPIRequest
2: Fulfill by Newegg
The ISO standard 3-digit codes of the country where your
warehouse is located. Please download the following to review
details:
http://promotions.newegg.com/marketplace/sellers/resourceLi
brary/International%20Country%20Guide.pdf
If left blank, default value will be All.
RequestType
Yes
String
INTERNATIONAL_INVENTORY_REPORT
FileType
No
String
Default FileType is txt. If you do not set the FileType, our system
will auto generate file for you in .txt file format.
Currently only support the following file formats:
CSV
XLS
TXT
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > InternationalInventoryReportRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
382
Content-Type: application/xml
Accept: application/xml
InternationalInventoryReportRequest
0
USA
AUS
INTERNATIONAL_INVENTORY_REPORT
XLS
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "InternationalInventoryReportRequest",
"RequestBody": {
"DailyInventoryReportCriteria": {
"FulfillType": "0",
"WarehouseList": {
"WarehouseLocation": [
"USA",
"AUS"
]
},
"RequestType": "INTERNATIONAL_INVENTORY_REPORT",
"FileType": "XLS"
}
383
}
}
Daily Price Report
Attribute
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed value: InternationalPriceReportRequest
No
String
The ISO standard 3-digit codes of the country where your
CountryCode
CountryList
DailyPriceReportCriteria
RequestBody
NeweggAPIRequest
warehouse is located. Please download the following to review
details:
http://promotions.newegg.com/marketplace/sellers/resourceLi
brary/International%20Country%20Guide.pdf
If left blank, default value will be All.
RequestType
Yes
String
INTERNATIONAL_PRICE_REPORT
FileType
No
String
Default FileType is txt. If you do not set the FileType, our system
will auto generate file for you in .txt file format.
Currently only support the following file formats:
CSV
XLS
TXT
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > InternationalPriceReportRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
InternationalPriceReportRequest
384
USA
AUS
INTERNATIONAL_PRICE_REPORT
XLS
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "InternationalPriceReportRequest",
"RequestBody": {
"DailyPriceReportCriteria": {
"CountryList": {
"CountryCode": [
"USA",
"AUS"
]
},
"RequestType": "INTERNATIONAL_PRICE_REPORT",
"FileType": "XLS"
}
}
}
Newegg Premier Item Report
t
s
Specify your eligible seller account (email address) here
e
String
u
No
q
Description
e
Format
R
Required?
I
P
A
g
e
g
w
IssueUser
e
N
Attribute
385
OperationType
Subcate
Yes
String
Fixed value: PremierItemReportRequest
No
Integer
The subcategory ID. You can get the ID from section 14.2 Get
PremierItemReportCriteria
RequestBody
goryID
Premier
Subcategory Status
No
Integer
Mark
0 – All
1 – Return premier item only (Default)
2 – Return no premier item only
Request
Yes
String
PREMIER_ITEM_REPORT
No
String
Default FileType is txt. If you do not set the FileType, our system will auto
Type
FileType
generate file for you in .txt file format.
Currently only support the following file formats:
CSV
XLS
TXT
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > PremierItemRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
PremierItemReportRequest
134
1
PREMIER_ITEM_REPORT
XLS
Example: Json, Request
386
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "PremierItemReportRequest",
"RequestBody": {
"PremierItemReportCriteria": {
"SubcategoryID": "0",
“PremierMark”:”1”,
"RequestType": "PREMIER_ITEM_REPORT",
"FileType": "XLS"
}
}
}
California’s Proposition 65 Warning Report
NeweggAPIRequest
Attribute
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed value: CAProp65ReportRequest
RequestType
Yes
String
CAPROP65_REPORT
FileType
No
String
Default FileType is txt. If you do not set the FileType, our system
will auto generate file for you in .txt file format.
Currently only support the following file formats:
CSV
XLS
TXT
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > CAProp65ReportRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
387
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
CAProp65ReportRequest
CAPROP65_REPORT
XLS
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "CAProp65ReportRequest",
"RequestBody": {
"ItemCAProp65ReportCriteria": {
"RequestType": "CAPROP65_REPORT",
"FileType": "XLS"
}
}
}
Attribute
NeweggAPIR
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
equest
Tax Setting Report for Items Enabled for China
Yes
String
Fixed value: ItemChinaTaxSettingReportRequest
RequestType
Yes
String
ITEM_CHINATAXSETTING_REPORT
FileType
No
String
Default FileType is txt. If you do not set the FileType, our system
OperationType
388
will auto generate file for you in .txt file format.
Currently only support the following file formats:
CSV
XLS
TXT
Example: XML, Request
XSD
API Schema > ReportMgmt > SubmitReport > ItemChinaTaxSettingReportRequest.xsd
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
ItemChinaTaxSettingReportRequest
ITEM_CHINATAXSETTING_REPORT
XLS
Example: Json, Request
POST https://api.newegg.com/marketplace/reportmgmt/report/submitrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "ItemChinaTaxSettingReportRequest",
"RequestBody": {
"ItemChinaTaxSettingReportCriteria": {
"RequestType": "ITEM_CHINATAXSETTING_REPORT",
389
"FileType": "XLS"
}
}
}
14.1.3. Response Body
Attribute
Format
Description
IsSuccess
String
Used to identify if the operation is successful. Returns true or false.
OperationType
String
Fixed values:
OrderListReportResponse
SettlementSummaryReportResponse
SettlementTransactionReportResponse
DailyInventoryReportResponse
RMAListReportResponse
ItemLookupReportResponse
InternationalInventoryReportResponse
InternationalPriceReportResponse
PremierItemReportResponse
CAProp65ReportResponse
ItemChinaTaxSettingReportResponse
SellerID
String
Your Seller ID
RequestId
String
The Identifier of a submission
RequestType
String
ORDER_LIST_REPORT
SETTLEMENT_SUMMARY_REPORT
SETTLEMENT_TRANSACTION_REPORT
RMA_LIST_REPORT
ResponseInfo
ResponseList
ResponseBody
DAILY_INVENTORY_REPORT
ITEM_LOOKUP
INTERNATIONAL_INVENTORY_REPORT
INTERNATIONAL_PRICE_REPORT
PREMIER_ITEM_REPORT
CAPROP65 _REPORT
ITEM_CHINATAXSETTING_REPORT
RequestDate
String
The date when the feed was submitted. (Pacific Standard Time)
RequestSatus
String
The status of the submission.
Default is SUBMITTED
390
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > SubmitReport > SubmitReportResponse.xsd
true
ItemLookupReportResponse
a001
270Z8Y3SYIGQV
ITEM_LOOKUP
07/12/2014 11:02:35
SUBMITTED
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "ItemLookupReportResponse",
"SellerID": "a001",
"ResponseBody": {
"ResponseList": [
{
"RequestId": "270Z8Y3SYIGQV",
"RequestType": "ITEM_LOOKUP",
"RequestDate": "07/12/2014 11:34:57",
"RequestStatus": "SUBMITTED"
}
]
}
391
}
14.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
RP010
Invalid Order Number.
RP018
Invalid Settlement Date
RP019
The requestID cannot be null or empty.
RP020
We are unable to process your request because one of the following search criteria is required: SettlementID,
SettlementDate, or SettlementDateFrom and SettlementDateTo
RP021
Maximum item lookup cannot exceed 1000 for each request.
RP022
Daily Inventory Report does not support multiple warehouse locations. For multiple warehouse locations, please
use International Program – Daily Inventory Report.
Example: XML, Response
RP018
Invalid Settlement Date
Example: Json, Response
{
"Code": "RP018",
"Message": "Invalid Settlement Date"
}
14.2. Get Report Status
Get the status of specified report request by specified query conditions.
392
14.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/reportmgmt/report/status?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
30 per min per client
Resource Information
14.2.2. Request Body
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed value: GetReportStatusRequest
No
String
A list of feed request ID, other condition will be ignored if
RequestIDList
Attribute
RequestID
specify an ID in the list
No
String
A list of feed Task type, default is All.
SETTLEMENT_SUMMARY_REPORT
SETTLEMENT_TRASACTION_ REPORT
DAILY_INVENTORY_ REPORT
RMA_LIST_REPORT
ITEM_LOOKUP
INTERNATIONAL_INVENTORY_REPORT
RequestTypeList
GetRequestStatus
ORDER_LIST_REPORT
RequestBody
NeweggAPIRequest
RequestType
MaxCount
INTERNATIONAL_PRICE_REPORT
PREMIER_ITEM_REPORT
CAPROP65 _REPORT
ITEM_CHINATAXSETTING_REPORT
No
Integer
The maximum return records. Default and maximum is 100.
If you specified over than 100, the system still return 100
records
393
RequestStatus
No
String
The status of the feed submission.
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
ALL
RequestDateFrom
No
String
Search by date range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
RequestDateTo
No
String
Search by date range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
Example: XML, Request
XSD
API Schema > ReportMgmt > GetReportStatus > GetReportStatusRequest.xsd
PUT https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetReportStatusRequest
2PQBYWH4V68ZP
10
Example: Json, Request
PUT https://api.newegg.com/marketplace/reportmgmt/report/status?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
394
Accept: application/xml
{
"OperationType": "GetReportStatusRequest",
"RequestBody": {
"GetRequestStatus": {
"RequestIDList": { "RequestID": "2PQBYWH4V68ZP" },
"MaxCount": "10"
}
}
}
14.2.3. Response Body
Attribute
Format
Description
SellerID
String
Your seller ID on Newegg Marketplace
IsSuccess
String
Used to identify the operation is successful
True or false
OperationType
String
Fixed value: GetReportStatusResponse
RequestId
String
The Identifier of a submission
RequestType
String
ORDER_LIST_REPORT
SETTLEMENT_SUMMARY_REPORT
SETTLEMENT_TRASACTION_REPORT
RMA_LIST_REPORT
ITEM_LOOKUP
INTERNATIONAL_PRICE_REPORT
ResponseInfo
ResponseList
INTERNATIONAL_INVENTORY_REPORT
ResponseBody
NeweggAPIResponse
DAILY_INVENTORY_ REPORT
PREMIER_ITEM_REPORT
CAPROP65 _REPORT
ITEM_CHINATAXSETTING_REPORT
RequestDate
String
The date when the request was submitted.
(Pacific Standard Time)
RequestSatus
String
The status of the request submission.
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
TotalCount
Integer
Total number of records
395
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReportStatus > GetReportStatusResponse.xsd
true
GetReportStatusResponse
A006
2PQBYWH4V68ZP
ORDER_LIST_REPORT
2/21/2012 14:38:17
FINISHED
4
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "GetReportStatusResponse",
"ResponseBody": {
"ResponseList": [{
"RequestDate": "2\/21\/2012 14:38:17",
"RequestId": "2PQBYWH4V68ZP",
"RequestStatus": "IN_PROGRESS",
"RequestType": "ORDER_LIST_REPORT",
“TotalCount”:4
}]
},
"SellerID": "A006"
}
396
14.2.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
RP004
Date From is required.
RP005
Date To is required.
RP006
Invalid Date From.
RP007
Invalid Date To.
Example: XML, Response
RP004
Date From is required
Example: Json, Response
{
"Code": "RP005",
"Message": "Dateto is required"
}
14.3. Get Report Result
Get the processing result of a specified report request.
14.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}&version={versionno}
397
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
Available Version Numbers
306. Response includes the Seller Order Number assigned by seller when
using for SBN to fulfill multi-channel orders.
Version
No
307. Response includes SalesTax amount for U.S., VAT and Duty amount for
Newegg Global.
309. Response includes the replacement order #s for related RMAs.
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
30 per min per client
14.3.2. Request Body
Attribute
Required?
Format
Description
IssueUser
No
String
Specify your eligible seller account (email address) here
OperationType
Yes
String
Fixed values:
OrderListReportRequest
SettlementSummaryReportRequest
SettlementTransactionReportRequest
NeweggAPIRequest
DailyInventoryReportRequest
RMAListReportRequest
ItemLookupRequest
InternationalInventoryReportRequest
InternationalPriceReportRequest
PremierItemReportRequest
CAProp65ReportRequest
RequestBody
ItemChinaTaxSettingReportRequest
RequestID
PageInfo
Yes
String
The request ID
PageIndex
Yes
Integer
Current page index
PageSize
Yes
Integer
Return records count in one page.
(Max is 100 per page)
Example: XML, Request
398
XSD
API Schema > ReportMgmt > GetReport > GetReportRequest.xsd
PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
OrderListReportRequest
2PQBYWH4V68ZP
1
10
Example: Json, Request
PUT https://api.newegg.com/marketplace/reportmgmt/report/result?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
{
"OperationType": "OrderListReportRequest"
"RequestBody": {
"RequestID": "2PQBYWH4V68ZP",
"PageInfo": {
"PageSize": "10",
"PageIndex": "1"
}
}
}
14.3.3. Response Body
399
Order List Report
Attribute
Format
Description
Available
Ver.#
IsSuccess
String
Used to identify the operation of Get Order Info
is successful
All
All
OperationType
String
Fixed value: GetOrderInfoResponse
All
String
You request ID
All
String
You request datetime(Pacific Standard Time)
All
TotalCount
Integer
Total number of records
All
TotalPageCount
Integer
Total page count
All
PageSize
Integer
How many records in a page.
All
PageIndex
Integer
Current page index
All
SellerID
String
Seller ID
All
OrderNumber
Integer
Newegg Order number
All
SellerOrderNumber
String
Order number, assigned by seller.
307
ResponseByody
This is available for sellers using SBN (Shipped by
OrderInfo
Newegg) to fulfill multi-channel orders.
OrderInfoList
NeweggAPIResponse
ate
Your seller ID
estD estID
String
PageInfo
SellerID
Requ Requ
True or False
InvoiceNumber
Integer
The Invoice Number
All
OrderDownloaded
String
False: Order has not been downloaded yet.
All
True: Order downloaded already.
When order is shipped, this field will
automatically become “True”.
OrderDate
String
Create date
All
OrderStatus
Integer
The Order Status:
All
0: Unshipped
1: Partially Shipped
2: Shipped
3: Invoiced
4: Voided
400
OrderStatusDescription
String
The Order Status Description
All
(Unshipped|PartiallyShipped|Shipped|Invoiced|
Void)
Unshipped for order status code: 0
Partially Shipped for order status code: 1
Shipped for order status code: 2
Invoiced for order status code: 3
Voided for order status code: 4
CustomerName
String
The order’s customer name.
All
CustomerPhoneNumber
String
The order’s shipping phone number
All
CustomerEmailAddress
String
The masked customer email address, you can
All
reach to the customer through this email address.
For example:
gdv6l0viwo4l7j1d@marketplace.newegg.com
ShipToAddress1
String
The order will be shipped to address
All
ShipToAddress2
String
The order will be shipped to address line 2
All
ShipToCityName
String
The order will be shipped to city name
All
ShipToStateCode
String
The order will be shipped to state
All
ShipToZipCode
String
The order will be shipped to zip code
All
ShipToCountryCode
String
The country for your orders. i.e. United Kingdom
All
401
ShipService
String
The order’s shipping service:
All
Shipped By Newegg
APO/FPO – Military ONLY
Super Saver(7-14 business days)
Standard Shipping (5-7 business days)
Expedited Shipping (3-5 business days)
Two-Day Shipping(2 business days)
One-Day Shipping(Next day)
International Expedited Shipping(3-5 business
days)
International Two-Day Shipping(2 business days)
International Economy Shipping(8-15 business
days)
International Standard Shipping(5-7 business
days)Newegg Premier 3 Days
Newegg Premier 2 Days
Newegg Premier Next Day
Please note that the following shipping services
are for indicating Newegg Premier orders, you
should ship the order as soon as the service
required. Please contact
Datafeeds@Newegg.com for more detail
regarding Premier Seller Enrollment Program.
Newegg Premier 3 Days
Newegg Premier 2 Days
Newegg Premier Next Day
ShipToFirstName
String
The ship to First Name
All
ShipToLastName
String
The ship to Last Name
All
ShipToCompany
String
The order’s ship to company
All
OrderItemAmount
Decimal
The order’s item(s) total amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
ShippingAmount
Decimal
The order’s shipping Amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
DiscountAmount
Decimal
The order’s total discount amount
All
NOTE: All amounts are set in U.S. Dollars (USD).
OrderQty
Integer
Order’s total item quantity.
All
402
RefundAmount
Decimal
The order’s refund amount.
All
NOTE: All amounts are set in U.S. Dollars (USD).
SalesTax
Decimal
The order’s sales tax.
306
NOTE: All amounts are set in U.S. Dollars (USD).
VATTotal
Decimal
International Value Additional Tax Total.
306
NOTE: All amounts are set in U.S. Dollars (USD).
DutyTotal
Decimal
International Duty Total
306
NOTE: All amounts are set in U.S. Dollars (USD).
OrderTotalAmount
Decimal
The order’s total amount
All
IsAutoVoid
String
If an order was auto voided by Newegg system,
All
then the value is true. Otherwise, value is false.
SalesChannel
Integer
Order sales channel:
306, 307,
0: Newegg order
309
1: Multi-channel order
2: Replacement order
FulfillmentOption
Integer
Order fulfillment option:
All
0: Ship by seller
ItemInfo
ItemInfoList
1: Ship by Newegg
SellerPartNumber
String
The item’s seller part number
All
NeweggItemNumber
String
The item’s newegg item number
All
MfrPartNumber
String
The item’s manufacture part number
All
UPCCode
String
The item’s upc
All
Description
String
The item’s web title description
All
OrderedQty
Integer
Item’s Ordered Quantity.
All
ShippedQty
Integer
Item’s Shipped Quantity.
All
UnitPrice
Decimal
The final price per unit of the item appearing in
All
customer's shopping cart
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendUnitPrice
Decimal
Item's total charge (Item Unit Price x Quantity
All
Ordered)
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendShippingCharg
e
Decimal
Item's total shipping charge (Item Unit Shipping
All
Price x Quantity Ordered)
NOTE: All amounts are set in U.S. Dollars (USD).
403
ExtendSalesTax
Decimal
Item’s total sales tax charge.
306
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendVAT
Decimal
Item’s total Value Additional Tax charge
306
NOTE: All amounts are set in U.S. Dollars (USD).
ExtendDuty
Decimal
Item’s total Duty charge
306
NOTE: All amounts are set in U.S. Dollars (USD).
Status
Integer
1: Unshipped
All
2: Shipped
3: Cancelled
StatusDescription
String
Unshipped for status code: 1
All
Shipped for status code: 2
PackageType
String
The package type. Shipped | Unshipped
All
ShipCarrier
String
The package’s actual shipCarrier
All
ShipService
String
The package’s actual shipService
All
TrackingNumber
String
The package’s tracking number.
All
ShipDate
String
The package’s ship date. (Pacific Standard Time)
All
String
The item’s seller part number
All
String
The item’s manufacture part number
All
Integer
Item’s Shipped Quantity.
All
SellerPartN
umber
Item Info
ItemInfoList
PackageInfo
PackageInfoList
Cancelled for status code: 3
MfrPartNu
mber
ShippedQt
y
Memo
String
Other information.
All
ResponseDate
String
The response date
All
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > OrderListResponse.xsd
true
A006
GetOrderInfoResponse
2
404
1
10
1
2PQBYWH4V68ZP
2/21/2012 14:38:17
A006
41473642
2153930
0
true
1/23/2012 7:33:05
4
Voided
WY SD
123-223-3223
gdv6l0viwo4l7j1d@marketplace.newegg.com
149 Kenwood Dr
Newcastle
WY
82701
UNITED STATES
Media Mail (7-14 business days)
WY
SD
0
0.00
0.00
0
0.00
1
true
0
1
405
A00655467241
9SIA0060823129
55467241
test creation test item
1
0
1.00
1.03
1.03
3
Canceled
A006
159243598
2153930
82961992
true
1/18/2012 1:05:18
3
Invoiced
WY SD
123-223-3223
gdv6l0viwo4l7j1d@marketplace.newegg.com
149 Kenwood Dr
Newcastle
WY
82701
UNITED STATES
Media Mail (7-14 business days)
WY
406
SD
2.00
10.00
1.00
0
11.00
2
false
0
1
A006ZX-35833
9SIA0060845543
ZX-35833
431573000287
GYRO Huge Metal Goliath 3.5CH Electric RTF RC
Helicopter
2
2
1.00
2
Shipped
1.03
1.03
1.03
Shipped
UPS
342
2342424
1/18/2012 16:59:15
407
A006ZX-35833
ZX-35833
2
2/22/2012 16:51:03
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetOrderInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "2",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"RequestID": "2PQBYWH4V68ZP",
"RequestDate": "2/21/2012 14:38:17",
"OrderInfoList": {
"OrderInfo": [{
"SellerID": "A006 ",
"OrderNumber": "41473642",
"SellerOrderNumber": "2153930",
"InvoiceNumber": "0",
"OrderDownloaded": "true",
"OrderDate": "1/23/2012 7:33:05",
"OrderStatus": "4",
408
"OrderStatusDescription": "Voided",
"CustomerName": "WY SD",
"CustomerPhoneNumber": "123-223-3223",
"ShipToAddress1": "149 Kenwood Dr",
"ShipToAddress2": null,
"ShipToCityName": "Newcastle",
"ShipToStateCode": "WY",
"ShipToZipCode": "82701",
"ShipToCountryCode": "UNITED STATES",
"ShipService": "Media Mail (7-14 business days)",
"ShipToFirstName": "WY",
"ShipToLastName": "SD",
"ShipToCompany": null,
"OrderItemAmount": "0",
"ShippingAmount": "0.00",
"DiscountAmount": "0.00",
"RefundAmount": "0",
“SalesTax”:”0.00”,
“IntlVATTotal”:”0.00”,
“IntlDutyTotal”:”0.00”,
"OrderTotalAmount": "0.00",
"OrderQty": "1",
"IsAutoVoid": "true",
“SalesChannel”:0,
“FulfillmentOption”:1,
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "A00655467241",
"NeweggItemNumber": "9SIA0060823129",
"MfrPartNumber": "55467241",
"UPCCode": null,
"Description": "test creation test item”,
"OrderedQty": "1",
"ShippedQty": "0",
"UnitPrice": "1.00",
"ExtendUnitPrice": "1.03",
"UnitShippingCharge": "1.03",
"ExtendShippingCharge": "1.03",
“ItemVATTotal”:”0.00”,
“ItemDutyTotal”:”0.00”,
"Status": "3",
409
"StatusDescription": "Canceled"
}
},
"PackageInfoList": null
}, {
"SellerID": "A006 ",
"OrderNumber": "159243598",
"SellerOrderNumber": "2153930",
"InvoiceNumber": "82961992",
"OrderDownloaded": "true",
"OrderDate": "1/18/2012 1:05:18",
"OrderStatus": "3",
"OrderStatusDescription": "Invoiced",
"CustomerName": "WY SD",
"CustomerPhoneNumber": "123-223-3223",
"CustomerEmailAddress”:gdv6l0viwo4l7j1d@marketplace.newegg.com",
"ShipToAddress1": "149 Kenwood Dr",
"ShipToAddress2": null,
"ShipToCityName": "Newcastle",
"ShipToStateCode": "WY",
"ShipToZipCode": "82701",
"ShipToCountryCode": "UNITED STATES",
"ShipService": "Media Mail (7-14 business days)",
"ShipToFirstName": "WY",
"ShipToLastName": "SD",
"ShipToCompany": null,
"OrderItemAmount": "2.00",
"ShippingAmount": "10.00",
"DiscountAmount": "1.00",
"RefundAmount": "0",
“SalesTax”:”0.00”,
“IntlVATTotal”:”0.00”,
“IntlDutyTotal”:”0.00”,
"OrderTotalAmount": "11.00",
"OrderQty": "2",
"IsAutoVoid": "false",
“SalesChannel”:0,
“FulfillmentOption”:1,
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "A006ZX-35833",
410
"NeweggItemNumber": "9SIA0060845543",
"MfrPartNumber": "ZX-35833",
"UPCCode": "431573000287",
"Description": "GYRO Huge Metal Goliath 3.5CH Electric RTF RC Helicopter
",
"OrderedQty": "2",
"ShippedQty": "2",
"UnitPrice": "1.00",
"ExtendUnitPrice": "1.03",
"UnitShippingCharge": "1.03",
"ExtendShippingCharge": "1.03",
“ItemVATTotal”:”0.00”,
“ItemDutyTotal”:”0.00”,
"Status": "2",
"StatusDescription": "Shipped"
}
},
"PackageInfoList": {
"PackageInfo": {
"PackageType": "Shipped",
"ShipCarrier": "UPS",
"ShipService": "342",
"TrackingNumber": "2342424",
"ShipDate": "1/18/2012 16:59:15",
"ItemInfoList": {
"ItemInfo": {
"SellerPartNumber": "A006ZX-35833",
"MfrPartNumber": "ZX-35833",
"ShippedQty": "2"
}
}
}
}
}]
}
},
"Memo": null,
"ResponseDate": "2/22/2012 16:53:26"
}
}
411
Settlement Summary Report Result
Attribute
IsSuccess
Format
Description
String
Used to identify the operation is successful. Returns true or
false
String
Your seller ID
OperationType
String
Fixed value: GetSettlementSummaryInfoResponse
RequestID
String
You request ID
RequestDate
String
You request datetime(Pacific Standard Time)
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageIndex
Integer
Current page index
PageSize
Integer
How many records in a page.
SettlementDateFrom
String
Settlement From Date (Pacific Standard Time)
SettlementDateTo
String
SettlementDateTo(Pacific Standard Time)
SettlementID
string
SettlementID
CheckNumber
string
CheckNumber
ItemPrice
Decimal
ItemPrice
NOTE: All amounts are set in U.S. Dollars (USD).
SettlementSummary
SettlementSummaryList
Response Body
NeweggAPIResponse
PageInfo
SellerID
Shipping
Decimal
Shipping
NOTE: All amounts are set in U.S. Dollars (USD).
Other
Decimal
Other
NOTE: All amounts are set in U.S. Dollars (USD).
TotalOrderAmount
Decimal
TotalOrderAmount
NOTE: All amounts are set in U.S. Dollars (USD).
Refunds
Decimal
Refunds
NOTE: All amounts are set in U.S. Dollars (USD).
ChargeBack
Decimal
ChargeBack
NOTE: All amounts are set in U.S. Dollars (USD).
MiscellaneousAdjustment
Decimal
MiscellaneousAdjustment
NOTE: All amounts are set in U.S. Dollars (USD).
TotalRefunds
Decimal
TotalRefunds
NOTE: All amounts are set in U.S. Dollars (USD).
412
NeweggCommissionFee
Decimal
NeweggCommissionFee
NOTE: All amounts are set in U.S. Dollars (USD).
NeweggTransactionFee
Decimal
NeweggTransactionFee
NOTE: All amounts are set in U.S. Dollars (USD).
NeweggRefundCommissionFe
Decimal
e
NeweggMonthlyFee
NeweggRefundCommissionFee
NOTE: All amounts are set in U.S. Dollars (USD).
Decimal
NeweggMonthlyFee
NOTE: All amounts are set in U.S. Dollars (USD).
NeweggStorageFee
Decimal
NeweggStorageFee
NOTE: All amounts are set in U.S. Dollars (USD).
NeweggRMABuyoutFee
Decimal
NeweggRMABuyoutFee
NOTE: All amounts are set in U.S. Dollars (USD).
NeweggPremierFee
Decimal
NeweggPremierFee
NOTE: All amounts are set in U.S. Dollars (USD).
NeweggShippingLabelFee
Decimal
NeweggShippingLabelFee
NOTE: All amounts are set in U.S. Dollars (USD).
TotalNeweggFee
Decimal
TotalNeweggFee
NOTE: All amounts are set in U.S. Dollars (USD).
TotalSettlement
Decimal
TotalSettlement
NOTE: All amounts are set in U.S. Dollars (USD).
Memo
String
Additional Information.
ResponseDate
String
The respond date of this report
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > settlementSummaryResponse.xsd
true
A09D
GetSettlementSummaryInfoResponse
1
1
10
1
413
2PQBZMZTL3DYF
2/21/2012 15:12:55
2/21/2012 12:00:00
8/5/2011 12:00:00
2/21/2012 12:00:00
0
71.00
31.95
0.00
102.95
-1.98
0.00
-182.53
-184.51
-7.71
0.00
0.15
0.00
-59.05
-0.72
0.00
0.00
-638.63
-720.19
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"SellerID": "A09D",
"OperationType": "GetSettlementSummaryInfoResponse",
414
"ResponseBody": {
"PageInfo": {
"TotalCount": "1",
"TotalPageCount": "1",
"PageSize": "10",
"PageIndex": "1"
},
"RequestID": "2PQBZMZTL3DYF",
"RequestDate": "2/21/2012 15:12:55",
"SettlementSummaryList": {
"SettlementSummary": {
"SettlementDate": "2/21/2012 12:00:00",
"SettlementDateFrom": "8/5/2011 12:00:00",
"SettlementDateTo": "2/21/2012 12:00:00",
"SettlementID": "0",
"ItemPrice": "71.00",
"Shipping": "31.95",
"Other": "0.00",
"TotalOrderAmount": "102.95",
"Refunds": "-1.98",
"ChargeBack": "0.00",
"MiscellaneousAdjustment": "-182.53",
"TotalRefunds": "-184.51",
"NeweggCommissionFee": "-7.71",
"NeweggTransactionFee": "0.00",
"NeweggRefundCommissionFee": "0.15",
"NeweggMonthlyFee": "0.00",
"NeweggStorageFee": "-59.05",
"NeweggRMABuyoutFee": "-0.72",
"NeweggPremierFee": "0.00",
"NeweggShippingLabelFee": "0.00",
"TotalNeweggFee": "-638.63",
"TotalSettlement": "-720.19"
}
}
}
}
}
415
Settlement Transaction Report
Attribute
IsSuccess
Format
Description
String
Used to identify the operation is successful.
Returns true or false
SellerID
String
Your seller ID
OperationType
String
Fixed value:
GetSettlementTransactionInfoResponse
You request ID
RequestDate
String
You request datetime(Pacific Standard Time)
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageIndex
Integer
Current page index
PageSize
Integer
How many records in a page.
TransactionDate
String
Transaction date
TransactionType
String
TransactionType
OrderID
Integer
OrderID
InvoiceID
Integer
InvoiceID
SellerPartNumber
String
SellerPartNumber
NeweggItemNumber
String
Newegg item number
ItemDescription
String
ItemDescription
ItemCondition
String
Item condition:
SettlementTransactionInfoList
NeweggAPIResponse
Response Body
SettlementTransactionInfo
String
PageInfo
RequestID
New
Refurbished
Used – Like New
Used – Very Good
Used – Good
Used – Acceptable
Amount
Decimal
Amount
NOTE: All amounts are set in U.S. Dollars (USD).
Shipping
Decimal
Shipping charge
NOTE: All amounts are set in U.S. Dollars (USD).
416
CommissionFee
Decimal
CommissionFee
NOTE: All amounts are set in U.S. Dollars (USD).
SettlementID
String
SettlementID
Memo
String
Additional Information
ResponseDate
String
The respond date of this report
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > SettlementTransactionResponse.xsd
true
A09D
GetSettlementTransactionInfoResponse
21
21
10
1
2PQDKCAQFHL3M
2/23/2012 11:39:00
8/9/2011 12:00:00
Order
87123017
75994476
A09D77897686
9SIA00X0002HJ5
dfdfgsdfg
New
10.00
2.00
-0.75
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"SellerID": "A09D",
"OperationType": "GetSettlementTransactionInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "21",
"TotalPageCount": "21",
"PageSize": "10",
"PageIndex": "1"
},
"RequestID": "2PQDKCAQFHL3M",
"RequestDate": "2/23/2012 11:39:00",
"SettlementTransactionInfoList": {
"SettlementTransactionInfo": {
"TransactionDate": "8/9/2011 12:00:00",
"TransactionType": "Order",
"OrderID": "87123017 ",
"InvoiceID": "75994476 ",
"SellerPartNumber": "A09D77897686",
"NeweggItemNumber": "9SIA00X0002HJ5",
"ItemDescription": "dfdfgsdfg",
"ItemCondition": "New",
"Amount": "10.00",
"Shipping": "2.00",
"CommissionFee": "-0.75",
"SettlementID": null
}
}
},
"Memo": null
}
}
418
Daily Inventory Report
Format
Description
IsSuccess
String
Used to identify the operation is successful. Returns true or false.
SellerID
String
Your seller ID
OperationType
String
Fixed value: DailyinventoryReportResponse
SellerID
String
Your seller ID
RequestID
String
You request ID
RequestType
String
DAILY_INVENTORY_REPORT
RequestDate
String
You request datetime(Pacific Standard Time)
ReportFileURL
string
The ftp file path, where you can get the report result file.
Response Body
NeweggAPIResponse
Attribute
For example:
ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/DailyInventoryReport_2PN75DT8ZICH8.txt
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > DailyinventoryResponse.xsd
true
A006
DailyinventoryReportResponse
2PQC13C7UYDPQ
DAILY_INVENTORY_REPORT
2/21/2012 15:32:57
ftp://API-e6Cl2FfE:M9RUtm2s@ftp03.newegg.com/DailyInventoryReport_2PQC13C7UYDPQ.xls
Example: Json, Response
419
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"sellerID": "A006",
"OperationType": "DailyinventoryReportResponse",
"ResponseBody": {
"RequestID": "2PQC13C7UYDPQ",
"RequestType": "DAILY_INVENTORY_REPORT",
"RequestDate": "2/21/2012 15:32:57",
"ReportFileURL": "ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/DailyInventoryReport_2PQC13C7UYDPQ.xls"
},
"Memo": null
}
}
420
RMA List Report
Attribute
IsSuccess
Format
Description
String
Used to identify the operation is successful. Returns
true or false.
String
Your seller ID
OperationType
String
Fixed value: GetRMAListInfoResponse
RequestID
String
You request ID
RequestDate
String
You request datetime(Pacific Standard Time)
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageIndex
Integer
Current page index
PageSize
Integer
How many records in a page.
SellerID
String
SellerID
RMANumber
Integer
RMANumber
RMAType
Integer
Available values:
ResponseByody
1: Replacement
2: Refund
RMATypeDescription
String
Available values:
Replacement for the type code: 1
Refund for the type code: 2
RMAInfo
RMAInfoList
NeweggAPIResponse
PageInfo
SellerID
SellerRMANumber
String
Seller RMA #.
An alphanumeric string, max 50 characters.
Note:avaialbel for version=307 and 309
ReplacementOrderNumber
String
The Order Number of the replacement order.
After confirming the return item is received, Newegg
will create a replacement order for you to process.
Note: available for RMA type: Replacement (RMAType
value= 1) and the request version=309
RMADate
String
Date of RMA(Pacific Standard Time)
421
RMAStatus
Integer
Available values:
1: Open
2: Received
3: Rejected
4: Voided
5: Closed
6: Processing
RMAStatusDescription
String
Available values:
Open for status code: 1
Received for status code: 2
Rejected for status code: 3
Voided for status code: 4
Closed for status code: 5
RMATransaction
RMATransactionList
Processing for status code: 6
LastEditDate
String
Last edit date(Pacific Standard Time)
LastEditUser
String
Last edit user
OrderNumber
Integer
Order Number of the RMA requested order.
OrderDate
String
Order Date(Pacific Standard Time)
InvoiceNumber
Integer
Invoice Number of the RMA requested order.
OrderAmount
Decimal
Order Amount
RMAProcessedBy
String
Newegg or Seller
CustomerName
String
Customer Name
CustomerPhoneNumber
String
Customer Phone Number
CustomerAddress
String
Customer Address
RMAReceiveDate
String
RMA shipment received date(Pacific Standard Time)
RMANote
String
The comment in this RMA
SellerPartNumber
String
The seller part number to identify a SKU
MfrPartNumber
String
Manufacturer Part Number
NeweggItemNumber
String
Newegg Item Number
Description
String
Item Description
422
UnitPirce
Decimal
The return unit price of each SKU in refund RMA
ItemReturnQty
Integer
The return quantity of each SKU in this RMA
ItemRefundPerQty
Integer
Refund per qty of the item
ItemShippingRefun
Decimal
The shipping amount of refund of each SKU in this RMA
RMATotalRefund
Decimal
RMA total Refund
RefundReason
Integer
The replacement/refund reason of each SKU in this
d
RMA.
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: Not match what we show
5: Sent wrong item
6: Personal Reason | Other Reason
Refund/Replacement Info
RMAReasonDescrip
String
tion
Available values:
Carrier damage for reason code: 1
Defective for reason code: 2
Incompatible for reason code: 3
Not match what we show for reason code: 4
Sent wrong item for reason code: 5
Personal Reason | Other Reason for reason code: 6
ShippedBy
RMAShipMethod
Integer
Integer
0.
Shipped by seller
1.
Shipped by Newegg
The ship method if you want issue a replacement RMA.
Available values:
1: Media Mail(7-14 business days)
2: Standard Shipping(5-7 business days)
3: Expedited Shipping(3-5 business days)
4: Two-Day shipping
5: One-day shipping
6: International Standard Shipping(5-15 business days)
7: International Expedited Shipping(3-5 business days)
8: International Two-Day shipping
9: International Two-Day Shipping(2 business days)
10: APO/FPO – Military ONLY
11: Newegg Premier 3 Days
12: Newegg Premier 2 Days
13: Newegg Premier Next Day
423
RMAShipMethodDe
String
scription
Available values:
Super Saver(7-14 business days)for status code: 1
Standard Shipping(5-7 business days) for status code: 2
Expedited Shipping(3-5 business days) for status code:
3
Two-Day Shipping(2 business days)for status code: 4
One-Day Shipping(Next day)for status code: 5
International Economy Shipping(8-15 business
days)for status code: 6
International Standard Shipping(5-7 business days)for
status code: 7
International Expedited Shipping (3-5 business
days)for status code: 8
International Two-Day Shipping(2 business days) for
status code :9
APO/FPO – Military ONLY for status code:10
Newegg Premier 3 Days for status code:11
Newegg Premier 2 Days for status code:12
Newegg Premier Next Day for status code:13
ReplacementReaso
Integer
n
Available values:
1: Carrier damage
2: Defective
3: Incompatible
4: Not match what we show
5: Sent wrong item
6: Personal Reason | Other Reason
Memo
String
Additional Information.
ResponseDate
String
The respond date of this report.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > RMAListResponse.xsd
true
A006
GetRMAListInfoResponse
424
38
38
10
1
2PQC1CJFRIWLZ
2/21/2012 15:46:17
A006
46535720
Refund
E12345678
2
8/17/2011 12:14:55
4
Void
8/17/2011 12:19:34
vy95
41471602
8/16/2011 22:37:59
76299193
19.20
Seller
Jana Mmm
123-271-1420
17708 Rowland Street, , City of Industry, DC, 20001,
USA
6sdfasd96
42asdfa730
9SIA00603H5974
testing Axed- Splitting
10.00
1
425
Seller
-1
Other reason
Standard Shipping(5-7 business days)
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"SellerID": "A006",
"OperationType": "GetRMAListInfoResponse",
"ResponseBody": {
"PageInfo": {
"TotalCount": "38",
"TotalPageCount": "38",
"PageSize": "10",
"PageIndex": "1"
},
"RequestID": "2PQC1CJFRIWLZ",
"RequestDate": "2/21/2012 15:46:17",
"RMAInfoList": {
"RMAInfo": {
"SellerID": "A006 ",
"RMANumber": "46535720",
"RMATypeDescription": "Refund",
“SellerRMANumber”:”E1234567”,
"RMAType": "2",
"RMADate": "8/17/2011 12:14:55",
"RMAStatus": "4",
"RMAStatusDescription": "Void",
"LastEditDate": "8/17/2011 12:19:34",
"LastEditUser": "vy95",
426
"OrderNumber": "41471602",
"OrderDate": "8/16/2011 22:37:59",
"InvoiceNumber": "76299193",
"OrderAmount": "19.20",
"RMAProcessedBy": "Seller",
"CustomerName": "Jana Mmm",
"CustomerPhoneNumber": "123-271-1420",
"CustomerAddress": "17708 Rowland Street, , City of Industry, DC, 20001, USA",
"RMAReceivedDate": null,
"RMANote": null,
"RMATransactionList": {
"RMATransaction": {
"SellerPartNumber": "6sdfasd96",
"MfrPartNumber": "42asdfa730",
"NeweggItemNumber": "9SIA00603H5974",
"Description": "testing Axed- Splitting",
"UnitPrice": "10.00",
"ReplacementInfo": {
"ItemReturnQty": "1",
"ShippedBy": "Seller",
"ReplacementReason": "-1",
"ReplacementReasonDescription": "Other reason",
"RMAShipMethod": "Standard Shipping(5-7 business days)"
}
}
}
}
}
},
"Memo": null
}
}
Item Lookup Report
Format
Description
String
Used to identify the operation is successful. Returns
onse
IsSuccess
APIResp
Newegg
Attribute
SellerID
true or false.
String
Your seller ID
427
String
Fixed value: ItemLookupResponse
RequestID
String
You request ID
RequestDate
String
You request datetime(Pacific Standard Time)
TotalCount
Integer
Total number of records
TotalPageCount
Integer
Total page count
PageIndex
Integer
Current page index
PageSize
Integer
How many records in a page.
ParentItemNumber
String
The parent item number
UPC
String
The upc code
Condition
Integer
Available values:
ResponseByody
PageInfo
OperationType
1: New
2: Refurbished
3: Used – Like New
4: Used – Very Good
6: Used – Acceptable
Item
ItemList
5: Used – Good
PacksOrSets
Integer
Identify the package count of this product.
Please note: all products in a pack or set will have
matching item and condition.
ManufacturerName
Integer
The manufacture name
ManufacturerPartNumber
String
The manufacture part number
WebShortTitle
String
The web short title
Note
String
The note
String
The respond date of this report.
ResponseDate
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > ItemLookupResponse.xsd
true
428
ItemLookupResponse
bfwk
4
1
1
10
28292T8ASAL64
07/11/2014 18:14:04
-
01T-001Y-00004
20140711101111
1
1
-
01T-001Y-00004
20140711101111
1
1
-
01T-001Y-00004
20140711101111
1
1
-
01T-001Y-00007
429
2
1
07/11/2014 19:00:59
Example: Json, Response
{
"ResponseDate": "07/11/2014 19:00:59"
"IsSuccess": "true",
"OperationType": "ItemLookupResponse",
"SellerID": "bfwk",
"ResponseBody": {
"PageInfo": {
"TotalCount": "4",
"TotalPageCount": "1",
"PageIndex": "1",
"PageSize": "10"
},
"RequestID": "28292T8ASAL64",
"RequestDate": "07/11/2014 18:14:04",
"ItemList":
{
"ParentItemNumber": "01T-001Y-00004",
"UPC": "20140711101111",
"Condition": "1",
“PacksOrSets”:”1”,
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101",
"WebShortTitle": "b2b new item 201407111001"
},
{
"ParentItemNumber": "01T-001Y-00004",
430
"UPC": "20140711101111",
"Condition": "1",
“PacksOrSets”:”1”,
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101",
"WebShortTitle": "b2b new item 201407111001"
},
{
"ParentItemNumber": "01T-001Y-00004",
"UPC": "20140711101111",
"Condition": "1",
“PacksOrSets”:”1”,
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101",
"WebShortTitle": "b2b new item 201407111001"
},
{
"ParentItemNumber": "01T-001Y-00007",
"UPC": "",
"Condition": "2",
“PacksOrSets”:”1”,
"ManufacturerName": "q-see",
"ManufacturerPartNumber": "canmfpn20140711101",
"WebShortTitle": "456346"
}
]
}
}
International Program - Daily Inventory Report
Description
IsSuccess
String
Used to identify the operation is successful. Returns true or false.
SellerID
String
Your seller ID
OperationType
String
Fixed value: InternationalInventoryReportResponse
SellerID
String
Your seller ID
RequestID
String
You request ID
RequestType
String
INTERNATIONAL_INVENTORY_REPORT
e Body
Format
Respons
NeweggAPIResponse
Attribute
431
RequestDate
String
You request datetime(Pacific Standard Time)
ReportFileURL
string
The ftp file path, where you can get the report result file.
For example:
ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/InternationalInventoryReport_2PN75DT8ZIC
H8.txt
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > InternationalInventoryReportResponse.xsd
true
A006
InternationalInventoryReportResponse
2PQC13C7UYDPQ
INTERNATIONAL_INVENTORY_REPORT
2/21/2012 15:32:57
ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalInventoryReport_2PQC13C7UYDPQ.xls
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"sellerID": "A006",
"OperationType": "InternationalInventoryReportResponse",
"ResponseBody": {
"RequestID": "2PQC13C7UYDPQ",
"RequestType": "INTERNATIONAL_INVENTORY_REPORT",
"RequestDate": "2/21/2012 15:32:57",
432
"ReportFileURL": "ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalInventoryReport_2PQC13C7UYDPQ.xls"
},
"Memo": null
}
}
International Program - Daily Price Report
Format
Description
IsSuccess
String
Used to identify the operation is successful. Returns true or false.
SellerID
String
Your seller ID
OperationType
String
Fixed value: InternationalPriceReportResponse
SellerID
String
Your seller ID
RequestID
String
You request ID
RequestType
String
INTERNATIONAL_PRICE_REPORT
RequestDate
String
You request datetime(Pacific Standard Time)
ReportFileURL
string
The ftp file path, where you can get the report result file.
Response Body
NeweggAPIResponse
Attribute
For example:
ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/InternationalPriceReport_2PN75DT8ZICH8.tx
t
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > InternationalPriceReportResponse.xsd
true
A006
InternationalPriceReportResponse
2PQC13C7UYDPQ
433
INTERNATIONAL_PRICE_REPORT
2/21/2012 15:32:57
ftp://API-e6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalPriceReport_2PQC13C7UYDPQ.xls
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"sellerID": "A006",
"OperationType": "InternationalPriceReportResponse",
"ResponseBody": {
"RequestID": "2PQC13C7UYDPQ",
"RequestType": "INTERNATIONAL_PRICE_REPORT",
"RequestDate": "2/21/2012 15:32:57",
"ReportFileURL": "ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalPriceReport_2PQC13C7UYDPQ.xls"
},
"Memo": null
}
}
Description
IsSuccess
String
Used to identify the operation is successful. Returns true or false.
SellerID
String
Your seller ID
OperationType
String
Fixed value: PremierItemReportResponse
SellerID
String
Your seller ID
RequestID
String
You request ID
RequestType
String
PREMIER_ITEM_REPORT
RequestDate
String
You request datetime(Pacific Standard Time)
Response
Attribute
NeweggAPIResponse
Format
Body
Newegg Premier Item Report
434
ReportFileURL
string
The ftp file path, where you can get the report result file.
For example:
ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/PremierItemReport_2PN75DT8ZICH8.txt
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > PremierItemResponse.xsd
true
A006
PremierItemReportResponse
2PQC13C7UYDPQ
Premier_ITEM_REPORT
2/21/2012 15:32:57
ftp://API-e6Cl2FfE:M9RUtm2s@ftp03.newegg.com/PremierItemReport_2PQC13C7UYDPQ.xls
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"sellerID": "A006",
"OperationType": "PremierItemReportResponse",
"ResponseBody": {
"RequestID": "2PQC13C7UYDPQ",
"RequestType": "Premier_ITEM_REPORT",
"RequestDate": "2/21/2012 15:32:57",
"ReportFileURL": "ftp://API-e6Cl2FfE:M9RUtm2s@ftp03.newegg.com/PremierItemReport
2PQC13C7UYDPQ.xls"
},
"Memo": null
435
}
}
California’s Proposition 65 Warning Report
Format
Description
IsSuccess
String
Used to identify the operation is successful. Returns true or false.
SellerID
String
Your seller ID
OperationType
String
Fixed value: CAProp65ReportResponse
RequestID
String
You request ID
RequestType
String
CAPROP65_REPORT
RequestDate
String
You request datetime(Pacific Standard Time)
ReportFileURL
string
The ftp file path, where you can get the report result file.
Response Body
NeweggAPIResponse
Attribute
For example:
ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/CAProp65Report_2PN75DT8ZICH8.zip
NOTE: the result may be in multiple files, 40,000 records per file. They will be
Compressed into a zip formatted single package.
Memo
String
Additional Information.
Example: XML, Response
XSD
API Schema > ReportMgmt > GetReport > CAProp65ReportResponse.xsd
true
A006
CAProp65ReportResponse
2PQC13C7UYDPQ
CAPROP65_REPORT
2/21/2012 15:32:57
ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/CAProp65Report_2PQC13C7UYDPQ.zip
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"sellerID": "A006",
"OperationType": "CAProp65ReportResponse",
"ResponseBody": {
"RequestID": "2PQC13C7UYDPQ",
"RequestType": "CAPROP65_REPORT",
"RequestDate": "2/21/2012 15:32:57",
"ReportFileURL": "ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/CAProp65Report_2PQC13C7UYDPQ.zip"
},
"Memo": null
}
}
Tax Setting Report for Items Enabled for China
Format
Description
IsSuccess
String
Used to identify the operation is successful. Returns true or false.
SellerID
String
Your seller ID
OperationType
String
Fixed value: ItemChinaTaxSettingReportResponse
RequestID
String
You request ID
RequestType
String
ITEM_CHINATAXSETTING_REPORT
RequestDate
String
You request datetime(Pacific Standard Time)
ReportFileURL
string
The ftp file path, where you can get the report result file.
Response Body
NeweggAPIResponse
Attribute
For example:
ftp://API52qNFlUQ:pKLgE2aE@ftp03.newegg.com/ItemChinaTaxSettingReport_2PN75DT8ZICH
8.zip
Memo
String
Additional Information.
Example: XML, Response
437
XSD
API Schema > ReportMgmt > GetReport > ItemChinaTaxSettingReportResponse.xsd
true
A006
ItemChinaTaxSettingReportResponse
2PQC13C7UYDPQ
ITEM_CHINATAXSETTING_REPORT
2/21/2012 15:32:57
ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/InternationalPriceReport_2PQC13C7UYDPQ.zip
Example: Json, Response
{
"NeweggAPIResponse": {
"IsSuccess": "true",
"sellerID": "A006",
"OperationType": "ItemChinaTaxSettingReportResponse",
"ResponseBody": {
"RequestID": "2PQC13C7UYDPQ",
"RequestType": "ITEM_CHINATAXSETTING_REPORT",
"RequestDate": "2/21/2012 15:32:57",
"ReportFileURL": "ftp://APIe6Cl2FfE:M9RUtm2s@ftp03.newegg.com/ItemChinaTaxSettingReport_2PQC13C7UYDPQ.zip"
},
"Memo": null
}
}
14.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
438
Example: XML, Response
CE001
SellerID cannot be null or empty
Example: Json, Response
{
"Code": "CE001",
"Message": "SellerID cannot be null or empty"
}
439
15. Seller Management
The Seller Management service group contains functions that will allow you to get reference information you may need to use some of
the functions in Newegg API.
15.1. Get Industry List
Get the list of industry that is currently on Newegg Marketplace. Response contains Industry Code and Industry Name.
15.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sellermgmt/seller/industry?sellerid={sellerid}&industrycode={industrycode}
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
industrycode
No
Industry code.
If you don’t specify this parameter, system will return all industries.
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
15.1.2. Request Body
Example: XML, Request
GET https://api.newegg.com/marketplace/sellermgmt/seller/industry?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
440
GET https://api.newegg.com/marketplace/sellermgmt/seller/industry?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
15.1.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
True or False
Fixed value: GetSellerIndustryResponse
SellerID
String
Your seller ID
IndustryCode
String
The industry code
IndustryName
String
The industry name
Industry
String
IndustryList
OperationType
ResponseBody
NeweggAPIResponse
successful
Example: XML, Response
XSD
API Schema > SellerMgmt > GetIndustry > GetIndustryResponse.xsd
true
GetSellerIndustryResponse
A006
AP
Apparel
AL
Appliance
441
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetSellerIndustryResponse",
"SellerID": "A006",
"ResponseBody": {
"IndustryList":[
{
"IndustryCode": "AP",
"IndustryName": "Apparel"
},
{
"IndustryCode": "AL",
"IndustryName": "Appliance"
}
]
}
}
15.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
DF008
Invalid industry code [{0}].
Example: XML, Response
DF008
Invalid industry code ABC
442
Example: Json, Response
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
15.2.
Get Subcategory Status
Get the subcategory status for the specified seller account. Subcategory is either enabled or not enabled for a seller.
15.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sellermgmt/seller/subcategory?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
15.2.2. Request Body
Attribute
Required
Format
Description
Yes
String
Fixed value: GetSellerSubcategoryRequest
No
Integer
Subcategory ID. If this value is provided, then response will
?
y
SubcategoryIDList
GetItemSubcategor
RequestBody
NeweggAPIRequest
OperationType
SubcategoryID
only contain information of the specified subcategory ID.
443
Industry7CodeList
IndustryCode
Enabled
No
String
Industry Code
No
Integer
Condition filter to specify the request by sub-category current
status.
Available values:
0: Not Enabled
1: Enabled
If left blank, the response will return both Not Enabled and
Enabled subcategories
Example: XML, Request
XSD
API Schema > SellerMgmt > GetSubcategory > GetSubcatetoryRequest.xsd
PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategory?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetSellerSubcategoryRequest
397
CH
1
444
Example: Json, Request
PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategory?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetSellerSubcategoryRequest",
"RequestBody": {
"GetItemSubcategory": {
"SubcategoryIDList": { "SubcategoryID": "397" },
"IndustryCodeList": { "IndustryCode": "CH" },
"Enabled": "1"
}
}
}
15.2.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
Fixed value: GetSellerSubcategoryResponse
SellerID
String
Your seller ID
IndustryCode
String
The industry code
IndustryName
String
The industry name
SubcategoryID
Integer
The subcategory ID
SubcategoryName
String
The subcategory name
Enabled
Integer
The subcategory is enabled or not for this seller
Subcategory
String
SubcategoryList
OperationType
ResponseBody
NeweggAPIResponse
True or False
Available values;
0: Not Enabled
1: Enabled
Example: XML, Response
445
XSD
API Schema > SellerMgmt > GetSubcategory > GetSubcatetoryResponse.xsd
true
GetSellerSubcategoryResponse
A006
AP
Apparel
1508
1
AP
Apparel
153
0
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetSellerSubcategoryResponse",
"SellerID": "A006",
"ResponseBody": {
"SubcategoryList":[
{
"IndustryCode": "AP",
"IndustryName": "Apparel",
"SubcategoryID": "1508",
446
"SubcategoryName": "Belts & Suspenders",
"Enabled": "1"
},
{
"IndustryCode": "AP",
"IndustryName": "Apparel",
"SubcategoryID": "153",
"SubcategoryName": "Buckles",
"Enabled": "0"
}
]
}
}
15.2.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
DF008
Invalid industry code [{0}].
Example: XML, Response
DF008
Invalid industry code ABC
Example: Json, Response
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
447
15.3. Get Subcategory Status for international country
Get the subcategory eligibility for a seller on international country. Subcategory is either enabled or not enabled for a
seller.
15.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sellermgmt/seller/subcategory/V2?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
15.3.2. Request Body
Attribute
Required
Format
Description
Yes
String
Fixed value: GetSellerSubcategoryRequest
Yes
String
The country where the subcategory status you want to check.
?
OperationType
To review the complete list of available values, please
download the following:
https://promotions.newegg.com/Marketplace/Sellers/resourc
eLibrary/International%20Country%20Guide.pdf
y
SubcategoryIDList
GetItemSubcategor CountryCode
RequestBody
NeweggAPIRequest
Note: only the ISO standard 3-digit codes are accepted.
SubcategoryID
No
Integer
Subcategory ID. If this value is provided, then response will
only contain information of the specified subcategory ID.
448
Industry7CodeList
IndustryCode
Enabled
No
String
Industry Code
No
Integer
Condition filter to specify the request by sub-category current
status.
Available values:
0: Not Enabled
1: Enabled
If left blank, the response will return both Not Enabled and
Enabled subcategories
Example: XML, Request
XSD
API Schema > SellerMgmt > GetSubcategory > GetSubcatetoryRequestV2.xsd
PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategory/V2?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetSellerSubcategoryRequest
USA
397
CH
1
449
Example: Json, Request
PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategory/V2?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetSellerSubcategoryRequest",
"RequestBody": {
“CountryCode”:”USA”,
"GetItemSubcategory": {
"SubcategoryIDList": { "SubcategoryID": "397" },
"IndustryCodeList": { "IndustryCode": "CH" },
"Enabled": "1"
}
}
}
15.3.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status
is successful
OperationType
String
Fixed value: GetSellerSubcategoryResponse
SellerID
String
Your seller ID
String
The country where the subcategory status you
CountryCode
want to check.
ResponseBody
NeweggAPIResponse
True or False
Note: only the ISO standard 3-digit codes are
accepted.
To review the complete list of available values,
please download the following:
https://promotions.newegg.com/Marketplace/Sel
lers/resourceLibrary/International%20Country%2
0Guide.pdf
450
Subcategory
SubcategoryList
IndustryCode
String
The industry code
IndustryName
String
The industry name
SubcategoryID
Integer
The subcategory ID
SubcategoryName
String
The subcategory name
Enabled
Integer
The subcategory is enabled or not for this seller
Available values;
0: Not Enabled
1: Enabled
Example: XML, Response
XSD
API Schema > SellerMgmt > GetSubcategory > GetSubcatetoryResponse.xsd
true
GetSellerSubcategoryResponse
A006
USA
AP
Apparel
1508
1
AP
Apparel
153
0
451
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetSellerSubcategoryResponse",
"SellerID": "A006",
"ResponseBody": {
“CountryCode”:”USA”,
"SubcategoryList":[
{
"IndustryCode": "AP",
"IndustryName": "Apparel",
"SubcategoryID": "1508",
"SubcategoryName": "Belts & Suspenders",
"Enabled": "1"
},
{
"IndustryCode": "AP",
"IndustryName": "Apparel",
"SubcategoryID": "153",
"SubcategoryName": "Buckles",
"Enabled": "0"
}
]
}
}
15.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
DF008
Invalid industry code [{0}].
Example: XML, Response
452
DF008
Invalid industry code ABC
Example: Json, Response
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
15.4.
Download Feed Schema
Download the schema of specified feed type. You can download schema files for Item Creation, Inventory Update or
Order Shipping.
15.4.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
10 per min per client
Resource Information
15.4.2. Request Body
t
Fixed value: GetFeedSchemaRequest
s
String
e
Yes
u
Description
q
Format
e
Required?
R
I
P
g
g
e
A
w
OperationType
e
N
Attribute
453
FeedType
Yes
Integer
The feed schema type which you want to download from
our system.
Current only support the following:
1:ITEM_DATA – The schema for batch create item / update
item / update and/or append image to item(s).
2: ORDER_SHIP_NOTICE_DATA – The schema for batch
ship order.
4: 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: MULTICHANNEL_ORDER_DATA – The schema for
GetFeedSchema
RequestBody
batch create multi-channel order.
6: ITEM_DATA_UPCMATCH – A simplified version of
item creation. This can be used to create items that exist
on Newegg.com.
7: ITEM_PROMOTION_DATA – The schema for batch
create item promotion requests.
8: VOLUME_DISCOUNT_DATA – The schema for batch
create/update/delete volume discount.
9: INVENTORY_DATA - Through this type you can batch
update inventory.
10: PRICE_DATA - Through this type you can batch update
price.
11: ITEM_PREMIER_MARK_DATA – The schema for batch
add/remove item for Newegg Premier Program
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.
Example: XML, Request
XSD
454
API Schema > SellerMgmt > GetSchema > GetSchemaRequest.xsd
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/octet-stream
GetFeedSchemaRequest
1
BA
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/octet-stream
{
"OperationType": "GetFeedSchemaRequest",
"RequestBody": {
"GetFeedSchema": {
"FeedType": "1",
"IndustryCode": "BA"
}
}
}
15.4.3. Response Body
455
Newegg compressed schema file(s) before returning it as a Base64-encoded string. To obtain this package, you must decode the
Base64-encoded string, save it as binary file with a “.zip” extension, and then exact the schema files from the zip file.
15.4.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
DF008
Invalid industry code [{0}].
Example: XML, Response
DF008
Invalid industry code ABC
Example: Json, Response
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
15.5.
Get Subcategory Properties
Get the subcategory properties for the specified subcategory.
15.5.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sellermgmt/seller/subcategoryproperty?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
456
sellerId
Yes
Your seller ID on Newegg Marketplace
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
15.5.2. Request Body
Attribute
SubcategoryID
Format
Description
Yes
String
Fixed value: GetSellerSubcategoryPropertyRequest
Yes
Integer
Subcategory ID.
RequestBody
NeweggAPIRequest
OperationType
Required?
Example: XML, Request
XSD
API Schema > SellerMgmt > GetSubcategoryProperties > GetSubcatetoryPropertiesRequest.xsd
PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategoryproperty?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetSellerSubcategoryPropertyRequest
1045
Example: Json, Request
PUT https://api.newegg.com/marketplace/sellermgmt/seller/subcategoryproperty?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
457
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetSellerSubcategoryPropertyRequest",
"RequestBody": { "SubcategoryID": "1045" }
}
15.5.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
String
Fixed value: GetSellerSubcategoryPropertyResponse
SellerID
String
Your seller ID
SubcategoryID
Integer
The subcategory ID
SubcategoryName
String
The subcategory name
PropertyName
String
The property name
IsAdvancedSearch
Integer
Will this property be showing up in the advance search
navigation?
SubcategoryProperty
SubcategoryPropertyList
OperationType
ResponseBody
NeweggAPIResponse
True or False
Available values:
0: No
1: Yes
IsGroupBy
Integer
Is this a group by property?
Available values:
0: No
1: Yes
IsRequired
Integer
Is this a required property?
Available values:
0: No
1: Yes
Example: XML, Response
XSD
API Schema > SellerMgmt > GetSubcategoryProperties > GetSubcatetoryPropertiesResponse.xsd
458
true
GetSellerSubcategoryPropertyResponse
A006
1045
0
0
0
1045
1
1
1
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetSellerSubcategoryPropertyResponse",
"SellerID": "A006",
"ResponseBody": {
"SubcategoryPropertyList": [
{
459
"SubcategoryID": "1045",
"SubcategoryName": "Costumes",
"PropertyName": "Costume_Brand",
"IsAdvancedSearch": "0",
"IsGroupBy": "0",
"IsRequired": "0"
},
{
"SubcategoryID": "1045",
"SubcategoryName": "Costumes",
"PropertyName": "Costume_Model",
"IsAdvancedSearch": "1",
"IsGroupBy": "1",
"IsRequired": "1",
}
]
}
}
15.5.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
DF009
Invalid subcategory ID [{0}].
Example: XML, Response
DF009
Invalid subcategory ID ABC
Example: Json, Response
{
460
"Code": "DF009",
"Message": "Invalid subcategory ID ABC"
}
15.6.
Get Subcategory Property Values
Get the subcategory property value for the specified property.
15.6.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sellermgmt/seller/propertyvalue?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
15.6.2. Request Body
t
Fixed value: GetSellerPropertyValueRequest
s
String
e
Yes
u
Description
q
Format
e
Required?
R
I
P
g
g
e
A
w
OperationType
e
N
Attribute
461
No
Integer
RequestBody
SubcategoryID
Subcategory ID.
If left blank, returns the property information for all applied
subcategories.
PropertyName
Yes
String
Property Name.
Example: XML, Request
XSD
API Schema > SellerMgmt > GetSubcategoryPropertyValue > GetSubcategoryPropertyValueRequest.xsd
PUT https://api.newegg.com/marketplace/sellermgmt/seller/propertyvalue?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetSellerPropertyValueRequest
1045
Costume_Gender
Example: Json, Request
PUT https://api.newegg.com/marketplace/sellermgmt/seller/propertyvalue?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetSellerPropertyValueRequest",
"RequestBody": {
"SubcategoryID": "1045",
"PropertyName": "Costume_Gender"
462
}
}
15.6.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
True or False
OperationType
String
Fixed value: GetSellerPropertyValueResponse
SellerID
String
Your seller ID
SubcategoryID
Integer
Subcategory ID
SubcategoryName
String
Subcategory name
PropertyName
String
The property name
IsAdvancedSearch
Integer
Will this property be showing up in the advance search
navigation?
0: No
1: Yes
PropertyInfo
PropertyInfoList
IsGroupBy
ResponseBody
NeweggAPIResponse
Available values:
Integer
Is this a group by property?
Available values:
0: No
1: Yes
IsRequired
Integer
Is this a required property?
Available values:
0: No
1: Yes
Property value name
PropertyValue
PropertyValueList
String
Example: XML, Response
XSD
API Schema > SellerMgmt > GetSubcategoryPropertyValue > GetSubcategoryPropertyValueResponse.xsd
463
true
GetSellerPropertyValueResponse
A006
1045
1
0
0
1045
1
0
0
1045
1
0
0
464
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetSellerPropertyValueResponse",
"SellerID": "A006",
"ResponseBody": {
"PropertyInfoList": [
{
"SubcategoryID": "1045",
"SubcategoryName": "Costume",
"PropertyName": "Costume_Gender",
"IsAdvancedSearch": "1",
"IsGroupBy": "0",
"IsRequired": "0",
"PropertyValueList": [ "Male" ]
},
{
"SubcategoryID": "1045",
"SubcategoryName": "Costume",
"PropertyName": "Costume_Gender",
"IsAdvancedSearch": "1",
"IsGroupBy": "0",
"IsRequired": "0",
"PropertyValueList": [ "Female" ]
},
{
"SubcategoryID": "1045",
"SubcategoryName": "Costume",
"PropertyName": "Costume_Gender",
"IsAdvancedSearch": "1",
"IsGroupBy": "0",
"IsRequired": "0",
"PropertyValueList": [ "Unisex" ]
}
]
}
465
}
15.6.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
15.7. Seller Status Check
Get the seller account status.
15.7.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sellermgmt/seller/accountstatus?sellerid={sellerid}&version={versionno}
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
version
Yes
Available version numbers:
307
Resource Information
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
1000 per min per client
15.7.2. Request Body
Example: XML, Request
GET https://api.newegg.com/marketplace/sellermgmt/seller/accountstatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
466
Accept: application/xml
Example: Json, Request
GET https://api.newegg.com/marketplace/sellermgmt/seller/accountstatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
15.7.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is successful
True or False
OperationType
String
Fixed value: GetSellerAccountStatusResponse
SellerID
String
Your seller ID
SellerName
String
The seller’s name
Status
String
The seller account’s status
Active
Suspended
InActive
ResponseBody
NeweggAPIResponse
Available values:
Terminated
Closed
Membership
Integer
Membership level code:
0: Standard
1: Professional
2: Enterprise
467
WarehouseLocation
String
The ISO standard 3-digit codes of the country where your
warehouse is located. Please download the following to review
details:
http://promotions.newegg.com/marketplace/sellers/resourceLibrar
WarehouseType
Integer
The order type what the warehouse will ship for:
0: SBS(Ship by seller)
1: SBN(Ship by Newegg)
ShipToCountry
String
ShippingDestinationLis
FufillmentCenter
FufillmentCenterList
y/International%20Country%20Guide.pdf
The target country where the fulfillment center will ship the order
to. Only the ISO standard 3-digit codes are accepted.
To review the complete list of available values, please download the
following:
https://promotions.newegg.com/Marketplace/Sellers/resourceLibr
ary/International%20Country%20Guide.pdf
Example: XML, Response
XSD
API Schema > SellerMgmt > SellerStatusCheck > GetSellerAccountStatusResponse.xsd
true
GetSellerAccountStatusResponse
A006
Active
0
TUR
0
TUR
USA
468
USA
0
USA
NZL
USA
1
AUS
USA
SGP
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "GetSellerAccountStatusResponse",
"SellerID": "A006",
"ResponseBody": {
"Membership": 0,
"FufillmentCenterList": [
{
"WarehouseLocation": "TUR",
"WarehouseType": 0,
"ShippingDestinationList": [
"TUR",
"USA"
]
},
{
"WarehouseLocation": "USA",
"WarehouseType": 0,
"ShippingDestinationList": [
469
"USA",
"NZL"
]
},
{
"WarehouseLocation": "USA",
"WarehouseType": 1,
"ShippingDestinationList": [
"AUS",
"USA",
"SGP"
]
}
],
"SellerName": "Test_MKTPLS",
"Status": "Active"
}
}
15.7.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
16. SBN (Shipped by Newegg) Management
The SBN (Shipped by Newegg) Management service group is designed to help you send your inventory to one of Newegg’s
warehouse. Once your inventory is in a Newegg’s warehouse, you will be able to sell your items on Newegg, or you can sell the
products on different channels then use Shipped by Newegg to ship your orders.
16.1. Get Inbound Shipment Plan Suggestion
Create an inbound shipment plan suggestion to identify the shipments of the items that you want to send to Newegg
warehouse. By submitting the inbound shipment plan suggestion request, Newegg will provide the appropriate ship
arrangement based on Newegg’s business intelligence. This will make your items allocation more reasonable and
competitive.
470
16.1.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/plansuggestion?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
16.1.2. Request Body
Attribute
Required?
Format
Description
Yes
String
Fixed value: GetPlanSuggestionRequest
SellerPartNumber
Yes
String
Seller part number.
PlannedQuantity
Yes
Integer
The total quantity of the specified item you want to send
to Newegg’s warehouse.
Item
ItemList
PlanSuggestion
RequestBody
NeweggAPIRequest
OperationType
QuantityPerCarton
No
Integer
The carton capacity for this item.
If fill this element, we will return the suggested number
of cartons for you reference.
Example: XML, Request
XSD
API Schema > SBNMgmt > GetInboundShipmentPlan > GetInboundShipmentPlanRequest.xsd
PUT https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/plansuggestion?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
471
GetPlanSuggestionRequest
-
SS0120130516683100755
20
10
-
nz-tst-123
30
10
Example: Json, Request
PUT https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/plansuggestion?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetPlanSuggestionRequest",
"RequestBody": {
"PlanSuggestion": {
"ItemList": {
"Item": [
{
"SellerPartNumber": "SS0120130516683100755",
"PlannedQuantity": 20,
"QuantityPerCarton": 10
},
{
472
"SellerPartNumber": "nz-tst-123",
"PlannedQuantity": 32,
"QuantityPerCarton": 10
}
]
}
}
}
}
16.1.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
True or False
OperationType
String
Fixed value: GetPlanSuggestionResponse
SellerID
String
Your seller ID
String
The code of Newegg’s warehouse
ShipToWarehouseCode
Currently available Newegg warehouse:
06: Tennessee Bulk Warehouse
08: California Bulk Item Warehouse
10: New Jersey Bulk Warehouse
String
The ship to address1 of Newegg’s warehouse
ShipToAddress2
String
The ship to address2 of Newegg’s warehouse
ShipToCityName
String
The ship to city name of Newegg’s warehouse
ShipToStateCode
String
The ship to state code of Newegg’s warehouse
ShipToZipCode
String
The zip code of Newegg’s warehouse
ShipToCountryCode
String
The country code of Newegg’s warehouse
SellerPartNumber
String
Seller part number
NeweggItemNumber
String
Newegg item number
Quantity
Integer
Suggested item quantity
NumberofCartons
Integer
Total cartons needed
Item
ShipToAddress1
ItemList
Shipment
ShipmentList
14: New Jersey Small Warehouse
ResponseBody
NeweggAPIResponse
07: California Small Warehouse
Example: XML, Response
473
XSD
API Schema > SBNMgmt > GetInboundShipmentPlan > GetInboundShipmentPlanResponse.xsd
true
GetPlanSuggestionResponse
A006
07
17708 Rowland St.
City of Industry
CA
91748
USA
-
nz-tst-123
9SIA0060BB9157
10
1
12
4995 Citation Dr Suite 101,Dock 1-10
Memphis
TN
38118
USA
-
SS0120130516683100755
9SIA0060S01359
10
1
474
-
nz-tst-123
9SIA0060BB9157
10
1
14
45 Patrick Ave., Dock 9-17
Edison
NJ
08837
USA
-
SS0120130516683100755
9SIA0060S01359
10
1
-
nz-tst-123
9SIA0060BB9157
10
1
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "GetPlanSuggestionResponse",
"SellerID": "A006",
"ResponseBody": {
475
"ShipmentList": [
{
"ShipToWarehouseCode": "07",
"ShipToAddress1": "17708 Rowland St.",
"ShipToCityName": "City of Industry",
"ShipToStateCode": "CA",
"ShipToZipCode": "91748",
"ShipToCountryCode": "USA",
"ItemList": [
{
"SellerPartNumber": "SS0120130516683100755",
"NeweggItemNumber": "9SIA0060S01359",
"Quantity": 0,
"NumberofCartons": 0
},
{
"SellerPartNumber": "nz-tst-123",
"NeweggItemNumber": "9SIA0060BB9157",
"Quantity": 13
}
]
},
{
"ShipToWarehouseCode": "12",
"ShipToAddress1": "4995 Citation Dr Suite 101,Dock 1-10",
"ShipToCityName": "Memphis",
"ShipToStateCode": "TN",
"ShipToZipCode": "38118",
"ShipToCountryCode": "USA",
"ItemList": [
{
"SellerPartNumber": "SS0120130516683100755",
"NeweggItemNumber": "9SIA0060S01359",
"Quantity": 10,
"NumberofCartons": 1
},
{
"SellerPartNumber": "nz-tst-123",
"NeweggItemNumber": "9SIA0060BB9157",
"Quantity": 11
}
476
]
},
{
"ShipToWarehouseCode": "14",
"ShipToAddress1": "45 Patrick Ave., Dock 9-17",
"ShipToCityName": "Edison",
"ShipToStateCode": "NJ",
"ShipToZipCode": "08837",
"ShipToCountryCode": "USA",
"ItemList": [
{
"SellerPartNumber": "SS0120130516683100755",
"NeweggItemNumber": "9SIA0060S01359",
"Quantity": 10,
"NumberofCartons": 1
},
{
"SellerPartNumber": "nz-tst-123",
"NeweggItemNumber": "9SIA0060BB9157",
"Quantity": 8
}
]
}
]
}
}
16.1.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SBN002
Invalid Seller Part # :{sellerpart#}.
SBN003
Seller Part # :{sellerpart#} is marked as Shipped by Seller now, please convert this item to Shipped by Newegg
and try again.
Example: XML, Response
477
DF008
Invalid industry code ABC
Example: Json, Response
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
16.2. Submit Inbound Shipment Request
Submit a request to Newegg for:
-
Creating a new inbound shipment based on the information that was returned by the Get Inbound Shipment Plan
Suggestion.
-
Updating existing shipment based on assigned Shipment ID.
16.2.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentrequest?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
POST
Required
XML, Json
XML, Json
100 per min per client
Resource Information
16.2.2. Request Body
Create Inbound Shipment
478
Attribute
OperationType
Required?
Format
Description
Yes
String
The value is fixed, will always be
“SubmitShipmentRequest”
ActionCode
Yes
Integer
Action code:
1.Create
ShipFromAddress1
No
String
Ship from address1.
If left blank, will use seller’s primary address.
ShipFromAddress2
No
String
Ship from address2
If left blank, will use seller’s primary address.
No
String
Ship from city.
If left blank, will use seller’s primary address.
ShipFromState
Shipment
RequestBody
NeweggAPIRequest
ShipFromCity
No
String
Ship from state
If left blank, will use seller’s primary address.
ShipFromZipcode
No
String
Ship from zip code
If left blank, will use seller’s primary address.
ShipFromCountry
No
String
Ship from country code
If left blank, will use seller’s primary address.
ShipFromPhoneNumber
No
String
Ship from location contact phone number
ShipToWarehouseCode
Yes
String
Which Newegg warehouse you want to ship to.
Currently available Newegg warehouse:
06: Tennessee Bulk Warehouse
07: California Small Warehouse
08: California Bulk Item Warehouse
10: New Jersey Bulk Warehouse
14: New Jersey Small Warehouse
479
ShippingMethodCode
Yes
Integer
Which shipping method you will be using for this
shipment?
Available values:
1: Small Parcel Delivery(Individual boxes: consist of units
packed in individual boxes and individually labeled for
delivery)
2: Less Than Truckload(LTL, Pallets, Shipment at least
150 lbs:shipment combines individual boxes on pallets
for delivery)
ShippingCarrierCode
Yes
Integer
Which shipping carrier you will be using for this
shipment?
If ShippingMethodCode = 1:
101: DHL
102: FedEx
103: UPS
104: USPS
105: Newegg Partnered Carrier(UPS). For more
information, please refer to section 15.2.5: Newegg
Partnered Carrier- UPS.
99: Other
If ShippingMethodCode = 2, the only acceptable value is:
99. Other
OtherCarrierName
Yes if =
String
ShippingCa
Provide the shipping carrier name you will be using if
ShippingCarrierCode = 99.
rrierCode =
Package
PackageList
99
TrackingNumber
No
String
Tracking number in this shipment
PackageWeight
Yes if
Decimal
Package weigh
ShippingCa
See Shipments Weight and Size Limitations for more
rrierCode =
details.
105
PackageLength
Yes if
Decimal
Package length
ShippingCa
See Shipments Weight and Size Limitations for more
rrierCode =
details.
105
480
PackageHeight
Yes if
Decimal
Package height
ShippingCa
See Shipments Weight and Size Limitations for more
rrierCode =
details.
105
PackageWidth
Yes if
Decimal
Package width
ShippingCa
See Shipments Weight and Size Limitations for more
rrierCode =
details.
105
sellerPartNumber
Yes
String
Seller part number.
Quantity
Yes
Integer
Item quantity
NumberofPackage
No
Integer
Number of package labels.
If left blank, will return 1 package label.
ORM-D
No
Integer
1: Yes
0: No
If left blank, will treat it as 0.
ORM-D is a marking for mail or shipping in the United
domestic transport only. Packages bearing this mark
Item
ItemList
States that identifies other regulated materials for
contain hazardous material in a limited quantity that
presents a limited hazard during transportation, due to
its form, quantity, and packaging.
Please select ORM-D checkbox if applicable.
A material safety data sheet must be uploaded for ORMD items.
Examples of ORM-D items:
- Aerosol cans
- Automotive batteries
- Perfumes
- Small arms ammunition
- Gunpowder (black powder)
- Some photographic chemicals
- Lighters
- Beer
- Drain openers
481
MSDSURL
Yes if
String
ORM-d = 1
Please specify the local path where the Material Safety
Data Sheet file located.
Enter the URL for this product’s Material Safety Data
Sheet File.
All URLs must be a direct link to the actual
file. File must be (pdf, jpg, jpeg, png, doc,docx, xls or xlsx).
An alphanumeric string; 2000 characters maximum in
length.
The maximum file size is 10MB. All files larger than the
10MB limit will fail to process.
Example: XML, Request
XSD
API Schema > SBNMgmt > SubmitInboundShipment > SubmitInboundShipmentRequest_Create.xsd
PUT
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
SubmitShipmentRequest
1
123456789
08
1
99
newegg
SBNAPI-123456789
10.00
8.00
7.00
7.00
482
-
SS0120130516683100755
4
2
1
http://tesipaddress/MSDS/testMSDS.pdf
Example: Json, Request
PUT
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "SubmitShipmentRequest",
"RequestBody": {
"Shipment": {
"ActionCode": 1,
"ShipFromPhoneNumber": "123456789",
"ShipFromAddress1": "11708 Rowland St.",
"ShipFromAddress2": "12708 Rowland St.",
"ShipFromCity": "NY",
"ShipFromState": "CA",
"ShipFromZipcode": "123456",
"ShipFromCountry": "USA",
"ShipToWarehouseCode": "14",
"ShippingMethodCode": 1,
"ShippingCarrierCode": 105,
"OtherCarrierName": "SF",
"PackageList": {
"Package": [
{
483
"TrackingNumber": "123456789",
"PackageWeight": 10,
"PackageLength": 8,
"PackageHeight": 7,
"PackageWidth": 6
},
{
"TrackingNumber": "987654321",
"PackageWeight": 10,
"PackageLength": 8,
"PackageHeight": 7,
"PackageWidth": 6
}
]
},
"ItemList": {
"Item": [
{
"SellerPartNumber": "SS0120130516683100755",
"Quantity": 40,
"NumberofPackage": 2,
“ORM-D”:1,
“MSDSURL”:”http://tesipaddress/MSDS/testMSDS.pdf”
}
]
}
}
}
}
Void Inbound Shipment
OperationType
Required?
Format
Description
Yes
String
The value is fixed, will always be
Shipment
“SubmitShipmentRequest”
RequestBody
NeweggAPIRequest
Attribute
ShipmentID
Yes
String
Existing shipment ID.
ActionCode
Yes
Integer
Action code:
2.Void
484
Example: XML, Request
XSD
API Schema > SBNMgmt > SubmitInboundShipment > SubmitInboundShipmentRequest_Void.xsd
PUT
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentrequest?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
SubmitShipmentRequest
2
2771551
Example: Json, Request
{
"OperationType": "SubmitShipmentRequest",
"RequestBody": {
"Shipment": {
"ActionCode": 2,
"ShipmentID": 2771551
}
}
}
16.2.3. Response Body
nse
APIR
espo
IsSuccess
egg
New
Attribute
Format
Description
String
Used to identify the operation of Get feed status is successful
True or False
485
String
Fixed value: SubmitShipmentResponse
SellerID
String
Your seller ID
RequestID
String
The Identifier of a submission
RequestDate
String
Request date.
RequestStatus
String
The status of the request submission.
ResponseBody
OperationType
SUBMITTED
Example: XML, Response
XSD
API Schema > SBNMgmt > SubmitInboundShipment > SubmitInboundShipmentResponse.xsd
true
SubmitShipmentResponse
A006
2PQCX3SPZ3QBF
06/06/2013 10:21:00
SUBMITTED
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "SubmitShipmentResponse",
"SellerID": "A006",
"ResponseBody": {
"RequestID": "Z2OTIV1AVVBJ",
"RequestDate": "07/11/2013 17:24:46",
"RequestStatus": "SUBMITTED"
}
}
16.2.4. Request Failure Errors
486
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
SBN001
Delivery to the Newegg warehouse: {ShipToWarehouseCode} of Seller Part # {SellerPart#} is not available. Please
submit a Get Inbound Shipment Plan request to receive the information of available option(s).
SBN002
Invalid Seller Part # :{sellerpart#}.
SBN003
Seller Part # :{sellerpart#} is marked as Shipped by Seller now, please convert this item to Shipped by Newegg
and try again.
SBN004
Invalid Shipment ID:{ShipmentID}
SBN005
Cannot void Shipment: [ShipmentID]. Shipment using Newegg Partnered Carrier service cannot be void 48 hours
after pre-paid shipping label created.
SBN006
Cannot void Shipment: [ShipmentID]. Shipment cannot be void because it is marked as [Received or Partially
Received or Manually closed or Voided]
SBN007
The field: [PackageWeight or PackageLength or PackageHeight or PackageWidth ] is required when using Newegg
Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg API Development
Guide, SBN section.
SBN008
The value in the field: PackageWeight cannot exceed 150 lbs. (70 kg) when using Newegg Partnered Carrier service
(ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN009
The value in the field: PackageLength cannot exceed 108 inches (270 cm) when using Newegg Partnered Carrier
service (ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN010
Package size cannot exceed 165 inches (419 cm) in (Package Length + 2x Package Width + 2x Package Height) when
using Newegg Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg API
Development Guide, SBN section.
SBN011
The field: OtherCarrierName is required when Shipping Carrier is Other (ShippingCarrierCode: 99). For more detail,
please review Newegg API Development Guide, SBN section.
SBN012
The value in the field of ShippingCarrier can only be Other (ShippingCarrierCode: 99) when the
ShippingMethodCode= 2. For more detail, please review Newegg API Development Guide, SBN section.
SBN013
Newegg Partnered Carrier service (ShippingCarrierCode: 105) is not available for international sellers.
SBN014
Package Dimension Weight cannot exceed 150 lbs.(70kg) in (Package Length x Package Width x Package Height/166)
when using Newegg Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg
API Development Guide, SBN section.
SBN015
The field:[MSDSURL] is required when ORM-D = 1. For more detail, please contact datafeeds@newegg.com.
Example: XML, Response
DF008
Invalid industry code ABC
487
Example: Json, Response
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
16.2.5. Newegg Partnered Carrier- UPS
Newegg partnered carriers offer deeply discounted rates, and the cost is billed to your account as an “SBN Inbound Fee”.
We will provide a shipping label that you can print and use with our partnered carriers. The rates apply to shipments
originating from the continental 50 U.S. states only (does not include Puerto Rico or APO/FPO addressed).
Please note this service is currently not available for International Sellers.
Shipment Measurement Guidelines
-
Shipments Weight and Size Limitations.*
Packages can be up to 150 lbs. (70 kg).
Packages can be up to 165 inches (419 cm) in (Length + 2x Width + 2x Height).
Packages can be up to 108 inches (270 cm) in Length.
*Packages with a large size-to-weight ratio require special pricing and dimensional weight calculations.
Example: A box measuring 34" x 34" x 34" exceeds the maximum dimensions. The length (34") plus 2x width (2 x 34")
and 2x height (2 x 34") equals 170".
-
Large Package
If packages Length plus 2x Width plus 2x Height exceeds 130 inches (330 cm), UPS applies a Large Package Surcharge.
Example: A box measuring 36” x 26” x 26” the length (36”) plus 2x width (2 x 26”) and 2x height (2 x 26”) equals 140”.
UPS will accept the box, but they may apply a Large Package Surcharge.
-
Dimensional Weight
If a package's volume is more than 5,184 cubic inches (3 cubic feet), UPS compares the dimensional weight (cubic inches
divided by 166) with the actual weight. If the dimensional weight is greater than actual weight, UPS uses the package's
dimensional weight as the billable weight.
Example: A package measuring 26" x 16" x 16" has a volume of 6,656 cubic inches. The dimensional weight equals 6,656
divided by 166 or 41 lbs. If the package's actual weight is 24 lbs., the dimensional weight may be used for the billable
weight.
-
Billable Weight
488
For large packages, UPS determines the billable weight by taking the package dimensions into account. For large packages,
if the dimensional weight is greater than the actual weight, UPS may use the dimensional weight instead of the actual weight.
16.3. Get Inbound Shipment Status Request
Get the status of specified inbound shipment.
16.3.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentstatus?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
16.3.2. Request Body
Attribute
RequestIDList
GetRequestStatus
RequestBody
NeweggAPIRequest
OperationType
RequestID
ActionCode
Required?
Format
Description
Yes
String
The value is fixed, will always be “GetShipmentStatusRequest”
No
String
The Identifier of a submission. Other condition will be ignored if
Request ID has been specified.
No
Integer
Available values for action code:
0: All(Default)
1: Create
2: Void
MaxCount
No
Integer
The maximum return records. Default is 100. If you specified
over than 100, the system still return 100 records.
489
RequestStatus
No
String
The status of the submitted request.
Available values:
ALL (Default)
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
RequestDateFrom
No
DateTime
Search by request date range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
RequestDateTo
No
DateTime
Search by request date range. (Pacific Standard Time)
Please refer to the Acceptable Date Format
Example: XML, Request
XSD
API Schema > SBNMgmt > GetInboundShipmentStatus > GetShipmentStatusRequest.xsd
PUT https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentstatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetShipmentStatusRequest
22AZLF9YXKT7S
1
100
ALL
Example: Json, Request
490
PUT https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentstatus?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetShipmentStatusRequest",
"RequestBody": {
"GetRequestStatus": {
"RequestIDList": {
"RequestID": [
"22AZLF9YXKT7S"
]
},
"ActionCode": 1,
"MaxCount": 100,
"RequestStatus": "ALL",
"RequestDateFrom": "2013-5-4",
"RequestDateTo": "2013-8-4"
}
}
}
16.3.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
Fixed value: GetShipmentStatusResponse
SellerID
String
Your seller ID
RequestId
String
The Identifier of a submission
ActionCode
Integer
Available values for the action code:
ResponseInfo
String
ResponseList
OperationType
ResponseBody
NeweggAPIResponse
True or False
1: Create
2: Void
RequestDate
String
The date when the feed was submitted. (Pacific Standard
Time)
491
RequestStatus
String
Available values for the status of the feed submission.
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
Memo
String
Detailed error information
Example: XML, Response
XSD
API Schema > SBNMgmt > GetInboundShipmentStatus > GetShipmentStatusResponse.xsd
true
A006
GetShipmentStatusResponse
22AZLF9YXKT7S
1
07/11/2013 16:39:30
IN_PROGRESS
Example: Json, Response
{
"IsSuccess": true,
"SellerID": “A006”,
"OperationType": "GetShipmentStatusResponse",
"ResponseBody": {
"ResponseList": [
{
"RequestId": "22AZLF9YXKT7S",
"ActionCode": 1,
492
"RequestDate": "07/11/2013 16:39:30",
"RequestStatus": "IN_PROGRESS"
}
]
}
}
16.3.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
16.4. Get Inbound Shipment Request Result
Get the processing result of a specified inbound shipment request.
16.4.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?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
{requestid}
Yes
Request ID
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
GET
Required
XML, Json
XML, Json
100 per min per client
Resource Information
16.4.2. Request Body
Example: XML, Request
GET
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={s
ellerid}
493
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
Example: Json, Request
GET
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={s
ellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
16.4.3. Response Body
For the new shipment creation, once your request has been created successfully, we will return the ShipmentID and Newegg
supported label files for your downloading.
Item Label Sample:
Package Label Sample:
494
Shipping Label Sample (Only available when Shipping carrier = Newegg Partnered Carrier (UPS)):
495
Packing List Label Sample:
496
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
True or False
o
p
s
y
The Identifier of a submission
d
String
RequestID
o
Your seller ID
B
String
e
SellerID
s
Fixed value: GetShipmentResultResponse
n
String
e
OperationType
R
NeweggAPIResponse
Attribute
497
RequestDate
String
Request date
ProcessedDate
String
Processed date
RequestStatus
String
Request Status
String
Shipment ID
String
Label types:
ShipmentID
ItemLabel
Label
PackageLabel
ShippingLabel
PackingListLabel
LabelURL
String
Downloading URL
ErrorDescription
String
Error description
Error
LabelURLList
ErrorList
Shipment
LabelType
Example: XML, Response
XSD
API Schema > SBNMgmt > GetInboundShipmentResult > GetInboundShipmentResultResponse.xsd
true
GetShipmentResultResponse
A006
21VS8NZ4D1RU9
07/14/2013 22:41:25
07/14/2013 22:42:40
FINISHED
2768782
Example: Json, Response
{
"IsSuccess": "true",
"OperationType": "GetShipmentResultResponse",
"SellerID": "A006",
"ResponseBody": {
"RequestID": "21VS8NZ4D1RU9",
"RequestDate": "07/14/2013 22:41:25",
"ProcessedDate": "07/14/2013 22:42:40",
"RequestStatus": "FINISHED",
"Shipment": {
“ShipmentID”: 2768782,
"Label": [
{
"LabelType": "ItemLabel",
"LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/fff5267a-b688-4705-a6766b17e910454a.pdf"
},
{
"LabelType": "PackageLabel",
499
"LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/ac2ec547-4492-41c0-80facbcbd2e5a393.pdf"
},
{
"LabelType": "PackingListLabel",
"LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/d5dd197a-5e4a-410d-bc1298841ea84623.pdf"
},
{
"LabelType": "ShippingLabel",
"LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/063d7c3a-0ed3-4b5f-adb7f21ba46e2d4f.pdf"
}
]
}
}
}
16.4.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
16.5. Get Inbound Shipment List
Get the inbound shipment list of a specified Shipment ID or certain time period.
16.5.1. Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentlist?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
500
16.5.2. Request Body
Attribute
OperationType
Required?
Format
Description
Yes
String
The value is fixed, will always be
PageInfo
“GetShipmentListRequest”
PageIndex
Yes
Integer
Current page index. Default is 1.
PageSize
Yes
Integer
How many records in a page.
KeywordsType
KeywordsValue
(Max is 100 per page)
No
No
Integer
String
0.
All (Default)
1.
Shipment ID
2.
Newegg Item Number
3.
Seller Part Number
The keywords value of the
specified type
RequestBody
NeweggAPIRequest
Status
LastUpdateDateFrom
No
No
Integer
String
0. All (Default)
1.
Preparing
2.
Shipped
3.
Received
4.
Partially Received
5.
Manually closed
6.
Voided
Get all shipments whose last
update date starts from this
date.
(Pacific Standard Time)
Please refer to the Acceptable
Date Format
Please note if both
LastUpdateDateFrom and
LastUpdateDateTo are empty,
will use last 30 days instead.
LastUpdateDateTo
No
String
Get all shipments whose last
update date ends from this date
(Include this day).
(Pacific Standard Time)
Please refer to the Acceptable
Date Format
Example: XML, Request
501
XSD
API Schema > SBNMgmt > GetInboundShipmentList > GetShipmentListRequest.xsd
PUT https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentlist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
GetShipmentListRequest
1
10
1
2740139
0
06/01/2013
06/07/2013
Example: Json, Request
GET https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentlist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetShipmentListRequest",
"RequestBody": {
"PageInfo": {
"PageIndex": 1,
"PageSize": 10
},
"KeywordsType": 1,
502
"KeywordsValue": "2740139",
"Status": 0,
"LastUpdateDateFrom": "01/01/2013",
"LastUpdateDateTo": "07/07/2013"
}
}
16.5.3. Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
OperationType
String
Fixed value: GetShipmentListResponse
SellerID
String
Your seller ID
ShipmentID
String
Shipment ID
Status
String
Shipment’s status:
Creating – shipment is creating at backend. (I’m
going to remove)
Preparing – user can work on shipment.
Shipped – shipment has been shipped out.
Shipment
ShipmentList
Ready to ship – shipment is ready to ship.
ResponseBody
NeweggAPIResponse
True or False
Partially Received – warehouse received a part of
shipment.
Received – warehouse received whole shipment
already.
Void – shipment has been voided.
Manually closed – shipment is manually closed which
is over 3 month and still no received.
CreateDate
String
Shipment create date
LastEditDate
String
Last edit date
ShipFrom
String
Ship from name. Default value: seller’s store name.
503
ShipToWarehouseCode
String
Ship to warehouse code
Currently available Newegg warehouse code in
united states:
06. -Tennessee Bulk Warehouse
07. -California Small Warehouse
08. -California Bulk Item Warehouse
10. -New Jersey Bulk Warehouse
14. -New Jersey Small Warehouse
ShipToAddress1
String
Ship to address 1
ShipToAddress2
String
Ship to address 2
ShipToCityName
String
Ship to city name
ShipToStateCode
String
Ship to state code. Example: CA -> California
ShipToZipCode
String
Ship to zip code
ShipToCountryCode
String
Ship to country code
ShippingMethodCode
Integer
The shipping method you specified for this shipment.
1.Small Parcel Delivery (Individual boxes: consist of
units packed in individual boxes and individually
labeled for delivery)
2.Less Than Truckload (LTL, Pallets, Shipment at least
150 lbs:shipment combines individual boxes on
pallets for delivery)
ShippingCarrierCode
Integer
The shipping carrier you used for this shipment.
If ShippingMethodCode = 1:
101.DHL
102.FedEx
103.UPS
104.USPS
105. Newegg Partnered Carrier(UPS)
99.Other
If ShippingMethodCode = 2:
99.Other
OtherCarrierName
String
The shipping carrier name you provided if
Package
st
PackageLi
ShippingCarrierCode = 99.
TrackingNumber
String
The number for tracking your package.
PackageWeight
Decimal
Package weight
PackageLength
Decimal
Package length
504
Item
ItemList
PackageHeight
Decimal
Package height
PackageWidth
Decimal
Package width
SellerPartNumber
String
Seller part number
Quantity
Integer
Item quantity
NumberofPackage
Integer
Number of package labels.
Example: XML, Response
XSD
API Schema > SBNMgmt > GetInboundShipmentList > GetShipmentListResponse.xsd
true
GetShipmentListResponse
A006
2740139
Ready to ship
06/06/2013 17:02:31
06/07/2013 11:31:00
Test_MKTPLS'K_
14
45 Patrick Ave., Dock 9-17
Edison
NJ
08837
USA
1
99
1
1
0
0
505
0
0
-
Ss0120121228065937386
36
2
-
SS0120130516683100755
9
3
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "GetShipmentListResponse",
"SellerID": "A006",
"ResponseBody": {
"ShipmentList": [
{
"ShipmentID": "2740139",
"Status": "Ready to ship",
"CreateDate": "06/06/2013 17:02:31",
"LastEditDate": "06/07/2013 11:31:00",
"ShipFrom": "Test_MKTPLS'K_",
"ShipToWarehouseCode": "14",
"ShipToAddress1": "45 Patrick Ave., Dock 9-17",
"ShipToCityName": "Edison",
"ShipToStateCode": "NJ",
"ShipToZipCode": "08837",
"ShipToCountryCode": "USA",
506
"ShippingMethodCode": 0,
"ShippingCarrierCode": 99,
"OtherCarrierName": "1",
"PackageList": [
{
"TrackingNumber": "1",
"PackageWeight": 0.0,
"PackageLength": 0.0,
"PackageHeight": 0.0,
"PackageWidth": 0.0
}
],
"ItemList": [
{
"SellerPartNumber": "Ss0120121228065937386",
"Quantity": 36,
"NumberofPackage": 2
},
{
"SellerPartNumber": "SS0120130516683100755",
"Quantity": 9,
"NumberofPackage": 3
}
]
}
]
}
}
16.5.4. Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
16.6. Get Warehouse List
Get the available information of Newegg’s warehouses.
507
Resource URL & Information
Resource URL
https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/warehouse?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
HTTP Method
Authentication?
Request Formats
Response Formats
Rate Limited?
PUT
Required
XML, Json
XML, Json
1000 per min per client
Resource Information
Request Body
Attribute
OperationType
Format
Description
Yes
String
The value is fixed, will always be “GetWarehouseRequest”
No
String
The warehouse code
RequestBody
NeweggAPIRequest
WarehouseCode
Required?
Currently available Newegg warehouse code in united states:
06. -Tennessee Bulk Warehouse
07. -California Small Warehouse
08. -California Bulk Item Warehouse
10. -New Jersey Bulk Warehouse
14. -New Jersey Small Warehouse
Example: XML, Request
XSD
API Schema > SBNMgmt > GetWarehouseList > GetWarehouseListRequest.xsd
PUT https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/warehouse?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
508
GetWarehouseRequest
10
Example: Json, Request
GET https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentlist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json
{
"OperationType": "GetWarehouseRequest",
"RequestBody": {
"WarehouseCode": "10"
}
}
Response Body
Attribute
IsSuccess
Format
Description
String
Used to identify the operation of Get feed status is
successful
True or False
String
The value is fixed, will always be
“GetWarehouseResponse “
SellerID
String
Your seller ID
String
Available Newegg warehouses:
Currently available Newegg warehouse code in united
Warehouse
WarehouseList
WarehouseCode
ResponseBody
NeweggAPIResponse
OperationType
states:
06. -Tennessee Bulk Warehouse
07. -California Small Warehouse
08. -California Bulk Item Warehouse
10. -New Jersey Bulk Warehouse
14. -New Jersey Small Warehouse
509
AllowBulkItem
Integer
This indicates this warehouse accepts bulk item.
0 – No
1 - Yes
AllowSmallItem
Integer
This indicates this warehouse accepts small item.
0 – No
1 - Yes
ShipToAddress1
String
The ship to address1 of Newegg’s warehouse
ShipToAddress2
String
The ship to address2 of Newegg’s warehouse
ShipToCityName
String
The ship to city name of Newegg’s warehouse
ShipToStateCode
String
The ship to state code of Newegg’s warehouse
ShipToZipCode
String
The zip code of Newegg’s warehouse
ShipToCountryCode
String
The country code of Newegg’s warehouse
Example: XML, Response
XSD
API Schema > SBNMgmt > GetWarehouseList > GetWarehouseListResponse.xsd
true
GetWarehouseResponse
A006
10
0
1
Memphis
TN
38118
USA
510
Example: Json, Response
{
"IsSuccess": true,
"OperationType": "GetWarehouseResponse",
"SellerID": "A006",
"ResponseBody": {
"WarehouseList": [
{
"WarehouseCode": "10",
"AllowBulkItem": 0,
"AllowSmallItem": 1,
"ShipToAddress1": "4995 Citation Dr Suite 101,Dock 1-10",
"ShipToCityName": "Memphis",
"ShipToStateCode": "TN",
"ShipToZipCode": "38118",
"ShipToCountryCode": "USA"
}
]
}
}
Request Failure Errors
For common HTTP error responses, please refer to Common Error Responses
Error Code
Description
Example: XML, Response
DF008
Invalid industry code ABC
Example: Json, Response
511
{
"Code": "DF008",
"Message": "Invalid industry code ABC"
}
512
Appendix
1. Common Request Headers
Name
Required?
Description
Accept
No
The content type of the response resource
Type: String
Default: application/json
Accept-Language
No
The information for localization
Type: String
Default: en-US
Authorization
Yes
The information required for request authentication
Type: String
Default: None
Content-Length
Conditional
Length of the message (without the headers) according to RFC 2616
Type: String
Default: None
Condition: Required for PUTs and operations that load XML
Content-Type
No
The content type of the resource. Example: application/json
Type: String
Default: None
Date
Yes
The current date and time according to the requester. Example: Wed, 01 Mar
2009 12:00:00 GMT
Type: String
Default: None
2. Failed Response Error Code List
2.1. General HTTP error code
Error Code
Description
400
The request cannot be fulfilled due to bad syntax
401
Unauthorized.
Similar to 403 Forbidden, but specifically used when authentication is possible but has failed or has not yet been
provided.
513
The response must include a WWW-Authenticate header field containing a challenge applicable to the requested
resource.
403
Forbidden.
The request was a valid request, but the server is refusing to respond to it. Unlike a 401 Unauthorized response,
authenticating will make no difference.
405
The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The
response MUST include an Allow header containing a list of valid methods for the requested resource.
404
Not Found.
The requested resource could not be found but may be available again in the future. Subsequent requests by the
client are permissible.
409
Conflict.
Indicates that the request could not be processed because of conflict in the request, such as an edit conflict.
500
Internal Server Error.
A generic error message, given when no more specific message is suitable.
501
Not Implemented.
The server either does not recognize the request method, or it lacks the ability to fulfill the request.
503
Service Unavailable.
The server is currently unavailable (because it is overloaded or down for maintenance). Generally, this is a
temporary state.
2.2. Common Error Response
Error Code
Description
CE001
SellerID cannot be null or empty
CE002
Invalid SellerID
CE003
Format error. {parse error message}
CE004
The request type you specified is invalid.
CE006
Invalid Issue user.
CE007
The MaxCount (maximum return records) is invalid. Default is 100. If you specified over than 100, the system still
return 100 records.
CE008
DateFrom is required.
CE009
DateTo is required.
CE010
Invalid Date From.
CE011
Invalid Date To.
CE012
System is currently processing your request, please wait a moment and try again.
CE013
No data found
CE014
SellerNoRightError_{0}
Available values:
SellerNoRightError_suspended
514
SellerNoRightError_terminated
SellerNoRightError_closed
SellerNoRightError_new
SellerNoRightError_ holiday lock
(NOTE: This error is to indicate the seller status that not able to submit any request)
CE016
Request cannot be processed because the current seller status is suspended.
CE017
Request cannot be processed because the current seller status is terminated.
CE018
Request cannot be processed because the current seller status is closed.
CE019
Request cannot be processed because the current seller status is new.
CE021
The DateTo should later than the DateFrom
CE022
System is currently experiencing heavy traffic in processing your request. Please wait a moment and try again.
CE023
The service is unavailable or experiencing extremely high error rates.
CE024
We sincerely apologize for the inconvenience. Newegg Marketplace API is currently under scheduled
maintenance and upgrades but will return shortly (From [{begin time}] to [{end time}]). Thank you for your
patience.
3. Acceptable Date Format
Date Format
Sample
YYYY-MM-DD HH:MM:SS
1998-02-23 14:23:05
MM/DD/YYYY HH:MM:SS
PM(AM)
02/23/1998 2:23:05 PM
YYYY-MM-DD HH:MM:SS.MMM
1998-02-23 10:00:00.123
DD MM YYYY HH:MM:SS
23 Feb 1998 14:23:05
YYYY-MM-DDTHH:MM:SS
1998-02-23T14:23:05
YYYY-MM-DDTHH:MM:SS.OZ
1998-02-23T14:23:05.OZ
MM/DD/YYYY
02/23/1998
YYYY-MM-DD
1998-02-23
515
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Page Count : 515 Language : en-US Author : aw78 Creator : Microsoft® Word 2013 Create Date : 2018:09:17 17:34:48-07:00 Modify Date : 2018:09:17 17:34:48-07:00 Producer : Microsoft® Word 2013EXIF Metadata provided by EXIF.tools