### Java Example: Get Order Information

Source: https://developer.newegg.com/newegg_marketplace_api/create_your_own_client_library

This Java example shows how to retrieve order information from the Newegg Marketplace API. It includes setup for SSL trust managers and hostname verification, and constructs a PUT request with XML payload.

```java
/*
* 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
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
httpsConnection.setRequestProperty("Authorization", "720ddc067f4d115bd544aff46bc75634");
//Set secret-key
httpsConnection.setRequestProperty("SecretKey", "21EC2020-3AEA-1069-A2DD-08002B30309D");
httpsConnection.setDoInput(true);
httpsConnection.setDoOutput(true);
String requestStr =
"<NeweggAPIRequest>" +
"<OperationType>GetOrderInfoRequest</OperationType>" +
"<RequestBody>" +
"<PageIndex>1</PageIndex>" +
"<PageSize>10</PageSize>" +
"<RequestCriteria>" +
"<OrderNumberList>" +
"<OrderNumber>159243598</OrderNumber>" +
"<OrderNumber>41473642</OrderNumber>" +
"</OrderNumberList>" +
"<Status>1</Status>" +
"<Type>1</Type>" +
"<OrderDateFrom>2011-01-01 09:30:47</OrderDateFrom>" +
"<OrderDateTo>2011-12-17 09:30:47</OrderDateTo>" +
"<OrderDownloaded>0</OrderDownloaded>" +
"</RequestCriteria>" +
"</RequestBody>" +
"</NeweggAPIRequest>";
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);
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);
}
}
}
```

--------------------------------

### XML Request Example for Get Industry List

Source: https://developer.newegg.com/newegg_marketplace_api/seller_management/get_industry_list

This example shows how to construct an XML GET request to fetch the industry list. It includes necessary headers for authorization and content type.

```http
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
```

--------------------------------

### JSON Request Example for Get Batch Price

Source: https://developer.newegg.com/newegg_marketplace_api/item_management/get-batch-price-b2b-and-can

This example shows how to make a POST request with a JSON payload to get batch pricing. Include the necessary headers for authentication and content type.

```json
POST https://api.newegg.com/marketplace/b2b/contentmgmt/item/pricelist?sellerid={SellerID}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
  "Type": "1",
  "Values": ["A006-TestItem-001","A006-TestItem-002","A006-TestItem-003"]
}
```

--------------------------------

### JSON Request Example for Get Industry List

Source: https://developer.newegg.com/newegg_marketplace_api/seller_management/get_industry_list

This example demonstrates how to make a JSON GET request to retrieve the industry list. Ensure the Content-Type and Accept headers are set to application/json.

```http
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
```

--------------------------------

### Get Price Response Example

Source: https://developer.newegg.com/newegg_marketplace_api/item_management/get_price

This example demonstrates the structure of a successful response when retrieving price information.

```APIDOC
## Get Price Response

### Description
This endpoint returns the pricing details for a given item, including various price points, shipping options, and promotion statuses across different countries.

### Response
#### Success Response (200)
- **SellerID** (string) - The unique identifier for the seller.
- **ItemNumber** (string) - The unique identifier for the item.
- **SellerPartNumber** (string) - The seller's part number for the item.
- **PriceList** (object) - A list of price details for different countries.
  - **Price** (object) - Details for a specific country's pricing.
    - **CountryCode** (string) - The ISO 3-letter country code.
    - **Currency** (string) - The ISO 3-digit currency code.
    - **Active** (integer) - Indicates if the price is active (1) or inactive (0).
    - **MSRP** (decimal) - Manufacturer Suggested Retail Price.
    - **CheckoutMAP** (integer) - Indicates if Checkout MAP is enabled (1) or disabled (0).
    - **SellingPrice** (decimal) - The actual selling price of the item.
    - **EnableFreeShipping** (integer) - Indicates if free shipping is enabled (1) or disabled (0).
    - **OnPromotion** (string) - Comma-separated codes indicating active promotions.
    - **LimitQuantity** (integer) - The maximum quantity a customer can purchase within 48 hours.

### Response Example
```xml
<?xml version="1.0" encoding="utf-8"?>
<PriceResult>
    <SellerID>A006</SellerID>
    <ItemNumber>9SIA0060884598</ItemNumber>
    <SellerPartNumber>A006testitem201201021459</SellerPartNumber>
    <PriceList>
        <Price>
            <CountryCode>USA</CountryCode>
            <Currency>USD</Currency>
            <Active>0</Active>
            <MAP>25.99</MAP>
            <CheckoutMAP>0</CheckoutMAP>
            <SellingPrice>20.92</SellingPrice>
            <EnableFreeShipping>1</EnableFreeShipping>
            <OnPromotion>1,5</OnPromotion>
            <LimitQuantity>2</LimitQuantity>
        </Price>
        <Price>
            <CountryCode>IND</CountryCode>
            <Currency>INR</Currency>
            <Active>1</Active>
            <MAP>25.99</MAP>
            <CheckoutMAP>0</CheckoutMAP>
            <SellingPrice>389.92</SellingPrice>
            <EnableFreeShipping>0</EnableFreeShipping>
            <OnPromotion>1,5</OnPromotion>
            <LimitQuantity>2</LimitQuantity>
        </Price>
        <Price>
            <CountryCode>IRL</CountryCode>
            <Currency>EUR</Currency>
            <Active>0</Active>
            <MAP>25.99</MAP>
            <CheckoutMAP>0</CheckoutMAP>
            <SellingPrice>19.92</SellingPrice>
            <EnableFreeShipping>0</EnableFreeShipping>
            <OnPromotion/>
            <LimitQuantity>2</LimitQuantity>
        </Price>
    </PriceList>
</PriceResult>
```
```

--------------------------------

### XML Request Example

Source: https://developer.newegg.com/newegg_marketplace_api/sbn_shipped_by_newegg_management/get_inbound_shipment_request_result

This example demonstrates how to make a GET request to retrieve inbound shipment results in XML format. Include your Authorization and SecretKey in the headers.

```http
GET https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
```

--------------------------------

### Get Order List Report Example

Source: https://developer.newegg.com/newegg_marketplace_api/reports_management/get_report_result/get_order_list_report

This example demonstrates how to retrieve a list of orders. The response includes pagination details and a list of orders, each with comprehensive information about the order and its items.

```APIDOC
## Get Order List Report

### Description
Retrieves a list of orders with detailed information, including items, shipping, and customer details. Supports pagination.

### Method
POST

### Endpoint
/api/order/getorderlist

### Parameters
#### Request Body
- **SellerID** (string) - Required - The unique identifier for the seller.
- **PageIndex** (integer) - Optional - The page number to retrieve. Defaults to 1.
- **PageSize** (integer) - Optional - The number of records per page. Defaults to 10.
- **QueryType** (string) - Optional - Specifies the type of query (e.g., 'ALL', 'UNPROCESSED').
- **OrderDateFrom** (string) - Optional - The start date for filtering orders (YYYY-MM-DD).
- **OrderDateTo** (string) - Optional - The end date for filtering orders (YYYY-MM-DD).
- **OrderStatus** (string) - Optional - Filters orders by their status.

### Request Example
```json
{
  "SellerID": "V006",
  "PageIndex": 1,
  "PageSize": 10,
  "QueryType": "ALL",
  "OrderDateFrom": "2023-01-01",
  "OrderDateTo": "2023-01-31",
  "OrderStatus": "2"
}
```

### Response
#### Success Response (200)
- **NeweggAPIResponse** (object)
  - **IsSuccess** (string) - Indicates if the operation was successful.
  - **SellerID** (string) - The seller's unique identifier.
  - **OperationType** (string) - The type of operation performed.
  - **ResponseBody** (object)
    - **PageInfo** (object)
      - **TotalCount** (string) - Total number of orders matching the query.
      - **TotalPageCount** (string) - Total number of pages available.
      - **PageSize** (string) - Number of orders per page.
      - **PageIndex** (string) - Current page index.
    - **RequestID** (string) - Unique identifier for the request.
    - **RequestDate** (string) - Date and time the request was processed.
    - **OrderInfoList** (object)
      - **OrderInfo** (array of objects) - List of order details.
        - **SellerID** (string) - Seller's unique identifier for the order.
        - **OrderNumber** (string) - Newegg's order number.
        - **SellerOrderNumber** (string) - Seller's order number.
        - **InvoiceNumber** (string) - Invoice number associated with the order.
        - **OrderDownloaded** (string) - Indicates if the order has been downloaded.
        - **OrderDate** (string) - Date and time the order was placed.
        - **OrderStatus** (string) - Code representing the order status.
        - **OrderStatusDescription** (string) - Description of the order status.
        - **CustomerName** (string) - Name of the customer.
        - **CustomerPhoneNumber** (string) - Customer's phone number.
        - **ShipToAddress1** (string) - First line of the shipping address.
        - **ShipToAddress2** (string) - Second line of the shipping address.
        - **ShipToCityName** (string) - City of the shipping address.
        - **ShipToStateCode** (string) - State code of the shipping address.
        - **ShipToZipCode** (string) - Zip code of the shipping address.
        - **ShipToCountryCode** (string) - Country code of the shipping address.
        - **ShipService** (string) - Shipping service used for the order.
        - **ShipToFirstName** (string) - First name of the shipping recipient.
        - **ShipToLastName** (string) - Last name of the shipping recipient.
        - **ShipToCompany** (string) - Company name for shipping, if applicable.
        - **OrderItemAmount** (string) - Total amount for items in the order.
        - **ShippingAmount** (string) - Total shipping charges for the order.
        - **DiscountAmount** (string) - Total discount applied to the order.
        - **RefundAmount** (string) - Total refund amount for the order.
        - **RecyclingFeeAmount** (string) - Recycling fee, if applicable.
        - **OrderTotalAmount** (string) - Total amount of the order.
        - **OrderQty** (string) - Total quantity of items in the order.
        - **IsAutoVoid** (string) - Indicates if the order was automatically voided.
        - **SalesChannel** (integer) - The sales channel through which the order was placed.
        - **FulfillmentOption** (integer) - The fulfillment option for the order.
        - **ItemInfoList** (object)
          - **ItemInfo** (array of objects) - List of item details within the order.
            - **SellerPartNumber** (string) - Seller's part number for the item.
            - **NeweggItemNumber** (string) - Newegg's item number.
            - **MfrPartNumber** (string) - Manufacturer's part number.
            - **UPCCode** (string) - UPC code of the item.
            - **Description** (string) - Description of the item.
            - **OrderedQty** (string) - Quantity of the item ordered.
            - **ShippedQty** (string) - Quantity of the item shipped.
            - **UnitPrice** (string) - Unit price of the item.
            - **ExtendUnitPrice** (string) - Extended unit price.
            - **UnitShippingCharge** (string) - Unit shipping charge for the item.
            - **ExtendShippingCharge** (string) - Extended shipping charge for the item.
            - **Status** (string) - Item status code.
            - **StatusDescription** (string) - Description of the item status.
            - **AutoRegWarranty** (boolean) - Indicates if auto-registration warranty is applied.
        - **PackageInfoList** (null or object) - Information about packages, if available.
    - **Memo** (null) - Additional notes or memos.

#### Response Example
```json
{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "SellerID": "V006",
        "OperationType": "GetOrderInfoResponse",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "20",
                "TotalPageCount": "20",
                "PageSize": "10",
                "PageIndex": "1"
            },
            "RequestID": "2PQBYWH4V68ZP",
            "RequestDate": "2/21/2012 14:38:17",
            "OrderInfoList": {
                "OrderInfo": [
                    {
                        "SellerID": "V006",
                        "OrderNumber": "155738158",
                        "SellerOrderNumber": "2153930",
                        "InvoiceNumber": "0",
                        "OrderDownloaded": "false",
                        "OrderDate": "12/21/2011 1:47:24",
                        "OrderStatus": "4",
                        "OrderStatusDescription": "Voided",
                        "CustomerName": "Richard Chen",
                        "CustomerPhoneNumber": "626-277-1420",
                        "ShipToAddress1": "17708 Rowland St",
                        "ShipToAddress2": null,
                        "ShipToCityName": "Rowland Heights",
                        "ShipToStateCode": "DC",
                        "ShipToZipCode": "20001",
                        "ShipToCountryCode": "USA",
                        "ShipService": "Media Mail (7-14 business days)",
                        "ShipToFirstName": "Richard",
                        "ShipToLastName": "Chen",
                        "ShipToCompany": null,
                        "OrderItemAmount": "0.00",
                        "ShippingAmount": "3.00",
                        "DiscountAmount": "-5.00",
                        "RefundAmount": "0.00",
                        "RecyclingFeeAmount": "0.00",
                        "OrderTotalAmount": "8.00",
                        "OrderQty": "1",
                        "IsAutoVoid": "false",
                        "SalesChannel": 0,
                        "FulfillmentOption": 1,
                        "ItemInfoList": {
                            "ItemInfo": [
                                {
                                    "SellerPartNumber": "Mike_A006_101478-151",
                                    "NeweggItemNumber": "9SIA00607Y6664",
                                    "MfrPartNumber": "Mike_A006_10114-151",
                                    "UPCCode": "410997000004",
                                    "Description": "Tungsten Ladies' Dome Ring w/ CZ",
                                    "OrderedQty": "1",
                                    "ShippedQty": "0",
                                    "UnitPrice": "5.00",
                                    "ExtendUnitPrice": "1.03",
                                    "UnitShippingCharge": "1.03",
                                    "ExtendShippingCharge": "1.03",
                                    "Status": "3",
                                    "StatusDescription": "Canceled",
                                    "AutoRegWarranty": false
                                }
                            ]
                        },
                        "PackageInfoList": null
                    }
                ]
            },
            "Memo": null
        }
    }
}
```

### Error Handling
Refer to the Failed Response Error Code List for common HTTP error responses.
```

--------------------------------

### Get RMA Information Example

Source: https://developer.newegg.com/newegg_marketplace_api/rma_management/get_rma_information

This example demonstrates how to retrieve RMA information using the Newegg Marketplace API.

```APIDOC
## Get RMA Information

### Description
Retrieves detailed information about a Return Merchandise Authorization (RMA), including item specifics, return reasons, shipping information, and refund status.

### Method
GET

### Endpoint
/rma/get

### Parameters
#### Query Parameters
- **rmaNumber** (string) - Required - The unique identifier for the RMA.
- **rmaType** (string) - Optional - The type of RMA (e.g., Refund, Replacement).

### Request Example
```json
{
  "NeweggAPIRequest": {
    "IsSuccess": "true",
    "OperationType": "GetRMAInfo",
    "SellerID": "A2GS",
    "RequestBody": {
      "RMANumber": "21964299"
    }
  }
}
```

### Response
#### Success Response (200)
- **RMAInfoList** (object) - Contains a list of RMA information objects.
  - **RMAInfo** (object) - Details of a single RMA.
    - **RMANumber** (string) - The unique RMA number.
    - **RMATypeDescription** (string) - Description of the RMA type.
    - **SellerRMANumber** (string) - The seller's RMA number.
    - **RMADate** (string) - The date the RMA was issued.
    - **RMAStatusDescription** (string) - Description of the RMA status.
    - **OrderNumber** (string) - The associated order number.
    - **OrderDate** (string) - The date of the associated order.
    - **InvoiceNumber** (string) - The invoice number for the order.
    - **OrderAmount** (string) - The total amount of the order.
    - **AvailableRefundAmount** (string) - The amount currently available for refund.
    - **CustomerName** (string) - The name of the customer.
    - **CustomerEmailAddress** (string) - The email address of the customer.
    - **ReturnShippingLabel** (object) - Information about the return shipping label.
      - **TrackingNumber** (string) - The tracking number for the return shipment.
      - **TrackingURL** (string) - The URL to track the return shipment.
      - **LabelEstimateCost** (string) - The estimated cost of the shipping label.
      - **PaidBy** (string) - Indicates who paid for the shipping label (Seller/Newegg).
    - **RMATransactionList** (object) - A list of transactions associated with the RMA.
      - **RMATransaction** (object) - Details of a single RMA transaction.
        - **SellerPartNumber** (string) - The seller's part number for the item.
        - **MfrPartNumber** (string) - The manufacturer's part number for the item.
        - **NeweggItemNumber** (string) - Newegg's item number.
        - **Description** (string) - Description of the item.
        - **UnitPrice** (string) - The unit price of the item.
        - **ReturnQuantity** (string) - The quantity of the item being returned.
        - **ReturnUnitPrice** (string) - The unit price for the return.
        - **RefundShippingPrice** (string) - The amount of shipping cost to be refunded.
        - **RMAReasonDescription** (string) - Description of the reason for the RMA.

#### Response Example
```json
{
  "NeweggAPIResponse": {
    "IsSuccess": "true",
    "OperationType": "GetRMAInfo",
    "SellerID": "A2GS",
    "ResponseBody": {
      "PageInfo": {
        "TotalCount": "1",
        "TotalPageCount": "1",
        "PageIndex": "1",
        "PageSize": "100"
      },
      "RMAInfoList": {
        "RMAInfo": {
          "RMANumber": "21964299",
          "RMAType": "2",
          "RMATypeDescription": "Refund",
          "SellerRMANumber": "TestRMAA2GS20200305101",
          "IssueUser": "A2GS",
          "RMADate": "03/03/2020 17:16:49",
          "RMAStatus": "1",
          "RMAStatusDescription": "Open",
          "OrderNumber": "458765952",
          "OrderDate": "01/22/2020 19:03:37",
          "InvoiceNumber": "175154088",
          "OrderAmount": "0.81",
          "AvailableRefundAmount": "0.26",
          "RMAProcessedBy": "Newegg",
          "RMANote": "Test--This is a test RMA TestRMAA2GS20200305101 1001",
          "PriorRefundAmount": "0.40",
          "CustomerName": "Michael Liang",
          "CustomerPhoneNumber": "435-432-1431",
          "CustomerEmailAddress": "cusatest@marketplace.newegg.com",
          "ShipToAddress1": "17709 Rowland St",
          "ShipToAddress2": "",
          "ShipToCityName": "Rowland Heights",
          "ShipToStateCode": "CA",
          "ShipToZipCode": "91748-1108",
          "ShipToCountryCode": "UNITED STATES",
          "ShipToLastName": "Liang",
          "ShipToFirstName": "Michael",
          "ShipToCompany": "",
          "ReturnShippingLabel": {
            "Label": {
              "TrackingNumber": "1ZA813779092080471",
              "TrackingURL": "http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779092080471&Type=1",
              "LabelEstimateCost": "6.19",
              "PaidBy": "Seller"
            }
          },
          "RMATransactionList": {
            "RMATransaction": {
              "SellerPartNumber": "Test_SP#AJST_201904090006",
              "MfrPartNumber": "Test_MP#201904090006",
              "NeweggItemNumber": "9SIA2GS9212178",
              "Description": "Test_Item Website Short Title 20190409_0006",
              "UnitPrice": "0.01",
              "ReturnQuantity": "1",
              "ReturnUnitPrice": "0.01",
              "RefundShippingPrice": "0.10",
              "RMAReason": "4",
              "RMAReasonDescription": "No longer needed"
            }
          }
        }
      }
    },
    "ResponseDate": "03/06/2020 16:22:42"
  }
}
```
```

--------------------------------

### Get Batch Inventory Response Example

Source: https://developer.newegg.com/newegg_marketplace_api/item_management/get-batch-inventory

This example demonstrates the structure of a successful response when retrieving batch inventory data.

```APIDOC
## Get Batch Inventory Response

### Description
Returns a list of items with their corresponding inventory details.

### Response Body
- **ItemList** (array) - A list of inventory items.
  - **ItemNumber** (string) - The unique identifier for the item.
  - **SellerPartNumber** (string) - The seller's part number for the item.
  - **Condition** (integer) - The condition of the item (e.g., 1 for New).
  - **InventoryAllocation** (array) - Details about inventory allocation per warehouse.
    - **WarehouseLocation** (string) - The location of the warehouse.
    - **FulfillmentOption** (string) - The fulfillment option (e.g., "0").
    - **AvailableQuantity** (integer) - The number of available units.
- **TotalCount** (integer) - The total number of items returned.
- **IsSuccess** (boolean) - Indicates if the operation was successful.
- **OperationType** (string) - The type of operation performed (e.g., "GetInventoryList").
- **SellerID** (string) - The seller's unique identifier.
- **ResponseDate** (string) - The date and time the response was generated.

### Response Example
```json
{
  "ResponseBody": {
    "ItemList": [
      {
        "ItemNumber": "9SIA00603V5190",
        "SellerPartNumber": "A006-TestItem-001",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 10
          },
          {
            "WarehouseLocation": "AUS",
            "FulfillmentOption": "0",
            "AvailableQuantity": 0
          }
        ]
      },
      {
        "ItemNumber": "9SIA00603V5191",
        "SellerPartNumber": "A006-TestItem-002",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 5
          },
          {
            "WarehouseLocation": "AUS",
            "FulfillmentOption": "0",
            "AvailableQuantity": 10
          }
        ]
      },
      {
        "ItemNumber": "9SIA00603V5192",
        "SellerPartNumber": "A006-TestItem-003",
        "Condition": 1,
        "InventoryAllocation": [
          {
            "WarehouseLocation": "USA",
            "FulfillmentOption": "0",
            "AvailableQuantity": 15
          },
          {
            "WarehouseLocation": "AUS",
            "FulfillmentOption": "0",
            "AvailableQuantity": 20
          }
        ]
      }
    ],
    "TotalCount": 3
  },
  "IsSuccess": true,
  "OperationType": "GetInventoryList",
  "SellerID": "A006",
  "ResponseDate": "2022-04-20T23:46:41.7786361-07:00"
}
```
```

--------------------------------

### Get RMA List Report Example

Source: https://developer.newegg.com/newegg_marketplace_api/reports_management/get_report_result/get_rma_list_report

This example demonstrates how to retrieve an RMA list report. It includes sample data for customer information, return shipping labels, and transaction details.

```APIDOC
## Get RMA List Report

### Description
Retrieves a list of RMA (Return Merchandise Authorization) reports, including customer details, return shipping information, and itemized refund data.

### Method
GET

### Endpoint
/reports/rma/list

### Query Parameters
- **SellerID** (string) - Required - The unique identifier for the seller.
- **RMAStatus** (string) - Optional - The status of the RMA (e.g., 'Open', 'Closed').
- **StartDate** (string) - Optional - The start date for filtering reports (YYYY-MM-DD).
- **EndDate** (string) - Optional - The end date for filtering reports (YYYY-MM-DD).

### Response
#### Success Response (200)
- **RmaList** (array) - A list of RMA report objects.
  - **RmaNumber** (string) - The RMA number.
  - **RmaDate** (string) - The date the RMA was created.
  - **CustomerName** (string) - The name of the customer.
  - **CustomerPhoneNumber** (string) - The customer's phone number.
  - **CustomerAddress** (string) - The customer's shipping address.
  - **RMANote** (string) - Notes associated with the RMA.
  - **ReturnShippingLabel** (array) - Details about the return shipping label.
    - **TrackingNumber** (string) - The tracking number for the return shipment.
    - **TrackingURL** (string) - The URL to track the return shipment.
    - **LabelEstimateCost** (number) - The estimated cost of the shipping label.
    - **PaidBy** (string) - Who paid for the return shipping.
  - **RMATransactionList** (array) - A list of items included in the RMA.
    - **SellerPartNumber** (string) - The seller's part number for the item.
    - **MfrPartNumber** (string) - The manufacturer's part number for the item.
    - **NeweggItemNumber** (string) - The Newegg item number.
    - **Description** (string) - A description of the item.
    - **UnitPrice** (number) - The unit price of the item.
    - **RefundInfo** (object) - Information about the refund for the item.
      - **ItemReturnQty** (integer) - The quantity of the item returned.
      - **ItemRefundPerQty** (number) - The refund amount per unit.
      - **ItemShippingRefund** (number) - The shipping refund amount for the item.
      - **RMATotalRefund** (number) - The total refund amount for the item.
      - **RefundReason** (integer) - The code for the refund reason.
      - **RefundReasonDescription** (string) - A description of the refund reason.

### Response Example
```json
{
    "RmaList": [
        {
            "RmaNumber": "RMA123456789",
            "RmaDate": "2023-10-27T10:00:00Z",
            "CustomerName": "Jian Qin",
            "CustomerPhoneNumber": "626-347-5618",
            "CustomerAddress": "17708 Rowland St, Rowland Heights, CA, 91748-1119, USA",
            "RMANote": "Test Test TestRMAA2GS202001231001 your note here",
            "ReturnShippingLabel": [
                {
                    "TrackingNumber": "1ZA813779097504156",
                    "TrackingURL": "http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779097504156&Type=1",
                    "LabelEstimateCost": 6.19,
                    "PaidBy": "Customer"
                }
            ],
            "RMATransactionList": [
                {
                    "SellerPartNumber": "Test_SPA2GS_20190930_3002",
                    "MfrPartNumber": "TestMP#A2GS190930_32",
                    "NeweggItemNumber": "9SIA2GSAAK6919",
                    "Description": "Test_Item Website Short Title A2GS 20190930 30002",
                    "UnitPrice": 0.01,
                    "RefundInfo": {
                        "ItemReturnQty": 1,
                        "ItemRefundPerQty": 0.01,
                        "ItemShippingRefund": 0,
                        "RMATotalRefund": 0.01,
                        "RefundReason": 1,
                        "RefundReasonDescription": "Carrier damage"
                    }
                }
            ]
        }
    ]
}
```

### Error Handling
Refer to the 'Failed Response Error Code List' for common HTTP error responses. Examples are provided for both XML and JSON error formats.
```

--------------------------------

### Get RMA List Report Example

Source: https://developer.newegg.com/newegg_marketplace_api/reports_management/get_report_result/get_rma_list_report

This example demonstrates how to retrieve a list of RMA reports. It includes details about the RMA, associated order, customer, and transaction items.

```APIDOC
## Get RMA List Report

### Description
Retrieves a list of RMA (Return Merchandise Authorization) reports for a seller, including details about each RMA, the associated order, customer information, and transaction items.

### Method
GET (Assumed, as no method is explicitly provided, but typical for list retrieval)

### Endpoint
/api/v1/rma/list

### Parameters
#### Query Parameters
- **sellerId** (string) - Required - The unique identifier for the seller.
- **rmaNumber** (string) - Optional - Filter by a specific RMA number.
- **orderNumber** (string) - Optional - Filter by a specific order number.
- **rmaStatus** (string) - Optional - Filter by RMA status (e.g., 'Open', 'Closed').
- **startDate** (string) - Optional - Filter by start date for RMA creation (YYYY-MM-DD).
- **endDate** (string) - Optional - Filter by end date for RMA creation (YYYY-MM-DD).
- **pageIndex** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of items per page.

### Request Example
```json
{
  "sellerId": "A2GS",
  "rmaNumber": "22187609",
  "orderNumber": "461654091"
}
```

### Response
#### Success Response (200)
- **RMAInfoList** (array) - A list of RMA information objects.
  - **SellerID** (string) - The seller's ID.
  - **RMANumber** (integer) - The RMA number.
  - **SellerRMANumber** (string) - The seller's custom RMA number.
  - **RMATypeDescription** (string) - Description of the RMA type (e.g., 'Refund').
  - **RMADate** (string) - The date the RMA was created.
  - **RMAStatusDescription** (string) - Description of the current RMA status.
  - **OrderNumber** (integer) - The associated order number.
  - **OrderDate** (string) - The date the order was placed.
  - **InvoiceNumber** (integer) - The invoice number for the order.
  - **OrderAmount** (number) - The total amount of the order.
  - **CustomerName** (string) - The name of the customer.
  - **CustomerPhoneNumber** (string) - The customer's phone number.
  - **CustomerAddress** (string) - The customer's shipping address.
  - **RMANote** (string) - Any notes associated with the RMA.
  - **ReturnShippingLabel** (array) - Information about the return shipping label.
    - **TrackingNumber** (string) - The tracking number for the return shipment.
    - **TrackingURL** (string) - The URL to track the return shipment.
  - **RMATransactionList** (array) - A list of items included in the RMA transaction.
    - **SellerPartNumber** (string) - The seller's part number for the item.
    - **MfrPartNumber** (string) - The manufacturer's part number for the item.
    - **NeweggItemNumber** (string) - Newegg's item number.
    - **Description** (string) - Description of the item.
    - **UnitPrice** (number) - The unit price of the item.
    - **RefundInfo** (object) - Details about the refund for the item.
      - **ItemReturnQty** (integer) - The quantity of the item returned.
      - **ItemRefundPerQty** (number) - The refund amount per unit.
      - **ItemShippingRefund** (number) - The shipping refund amount for the item.
      - **RMATotalRefund** (number) - The total refund amount for the item.
      - **RefundReasonDescription** (string) - Description of the refund reason.

#### Error Response (400)
- **IsSuccess** (boolean) - False if the request failed.
- **Message** (string) - Error message describing the failure.

### Response Example
```json
{
  "ResponseDate": "03/05/2020 22:42:44",
  "IsSuccess": true,
  "OperationType": "GetRMAListInfoResponse",
  "SellerID": "A2GS",
  "ResponseBody": {
    "PageInfo": {
      "TotalCount": 1,
      "TotalPageCount": 1,
      "PageIndex": 1,
      "PageSize": 100
    },
    "RequestID": "237F788KK8LS0",
    "RequestDate": "03/05/2020 22:20:08",
    "RMAInfoList": [
      {
        "SellerID": "A2GS",
        "RMANumber": 22187609,
        "SellerRMANumber": "TestRMAA2GS202001231001",
        "RMAType": 2,
        "RMATypeDescription": "Refund",
        "RMADate": "01/19/2020 19:24:46",
        "RMAStatus": 1,
        "RMAStatusDescription": "Open",
        "LastEditDate": "01/22/2020 17:30:39",
        "LastEditUser": "Seller",
        "OrderNumber": 461654091,
        "OrderDate": "11/01/2019 23:36:12",
        "InvoiceNumber": 172997652,
        "OrderAmount": 0.05,
        "RMAProcessedBy": "Seller",
        "CustomerName": "Jian Qin",
        "CustomerPhoneNumber": "626-347-5618",
        "CustomerAddress": "17708 Rowland St, Rowland Heights, CA, 91748-1119, USA",
        "RMANote": "Test Test TestRMAA2GS202001231001 your note here",
        "ReturnShippingLabel": [
          {
            "TrackingNumber": "1ZA813779097504156",
            "TrackingURL": "http://www.newegg.com/info/trackOrder.aspx?trackingnumber=1ZA813779097504156&Type=1",
            "LabelEstimateCost": 6.19,
            "PaidBy": "Customer"
          }
        ],
        "RMATransactionList": [
          {
            "SellerPartNumber": "Test_SPA2GS_20190930_3002",
            "MfrPartNumber": "TestMP#A2GS190930_32",
            "NeweggItemNumber": "9SIA2GSAAK6919",
            "Description": "Test_Item Website Short Title A2GS 20190930 30002",
            "UnitPrice": 0.01,
            "RefundInfo": {
              "ItemReturnQty": 1,
              "ItemRefundPerQty": 0.01,
              "ItemShippingRefund": 0,
              "RMATotalRefund": 0.01,
              "RefundReason": 1,
              "RefundReasonDescription": "Carrier damage"
            }
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### Get Order Information Request Example (XML)

Source: https://developer.newegg.com/newegg_marketplace_api/order_management/get_order_information_can

An example of an XML request to retrieve order information. This includes specifying order numbers, status, date ranges, and other criteria.

```xml
PUT https://api.newegg.com/marketplace/can/ordermgmt/order/orderinfo?sellerid={sellerid}&version={version}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml
<NeweggAPIRequest>
<OperationType>GetOrderInfoRequest</OperationType>
<RequestBody>
<PageIndex>1</PageIndex>
<PageSize>10</PageSize>
<RequestCriteria>
<OrderNumberList>
<OrderNumber>159243598</OrderNumber>
<OrderNumber>41473642</OrderNumber>
</OrderNumberList>
<SellerOrderNumberList>
<SellerOrderNumber>SO159243598</SellerOrderNumber>
<SellerOrderNumber>SO41473642</SellerOrderNumber>
</SellerOrderNumberList>
<Status>1</Status>
<Type>1</Type>
<OrderDateFrom>2011-01-01 09:30:47</OrderDateFrom>
<OrderDateTo>2011-12-17 09:30:47</OrderDateTo>
<OrderDownloaded>0</OrderDownloaded>
</RequestCriteria>
</RequestBody>
</NeweggAPIRequest>
```