Working With Data Feeds

8.1 Data feed basics

Newegg Logistics allow you to bulk creation items and orders via the Data Feed APIs. Data feed are processing by jobs at backend. You will be notified when Newegg system finished processing your data feed.

8.1.1 Request ID

Newegg system will be generated an unique request ID for each data feed after submitted. You can use the request ID to check process result of your data feed.

8.1.2 Data feed status

Newegg Logistics uses following status to indicate the state of data feed processing.

Status	Description
Pending	Data feed has uploaded to Newegg system. Waiting for processing.
Processing	Data feed is under processing in Newegg system.
Processed	All entries in the data feed have been processed successfully.
ProcessedWithErrors	Part of entries in the data feed have been processed, others are failed.
Failed	All entries in the data feed are failed. Or an exception occurred during data feed parsing and validation.

8.2 What you can do with Data Feed APIs

• POST data-feed/batch-item-creation
  Submit data feed for bulk item creation
• POST data-feed/batch-order-creation
  Submit data feed for bulk order creation
• GET data-feed/{Request ID}
  Get data feed process result

8.3 Submit data feed for batch item creation

POST data-feed/batch-item-creation

Submit data feed for bulk item creation.

Item data will be written into a XML file and upload to Newegg cloud storage. A backend job will be scheduled to process the file for bulk creation. You can use the “Get data feed statust” API to check the process result of each entry in your feed.

8.3.1 Request example

POST https://apis.newegg.com/tpl/v2/data-feed/batch-item-creation

{
  "Description": "Short description about this feed",
  "RequestUser": "email@address.com",
  "Action": "Create",
  "Data": [
    {
      "SellerPartNumber": "test-sku#123456",
      "Condition": "New",
      "Title": "Testing sku 123456",
      "Manufacturer": "Newegg Logistics",
      "ManufacturerPartNumber": "sku#123456",
      "UPC": "40076543210",
      "PacksOrSets": 1,
      "Length": 1.5,
      "Width": 1.2,
      "Height": 1,
      "Weight": 0.9,
      "CartonLength": null,
      "CartonWidth": null,
      "CartonHeight": null,
      "CartonWeight": null,
      "ShippingRestriction": false,
      "InventoryManagementType": "FIFO",
      "ContainingBatteries": false,
      "BatteryWattHours": null,
      "BatteryWeight": null,
      "MSRP": 339.99,
      "OriginCountries": [
        "CHN"
      ],
      "Images": [
        "http://sample.com/image.jpg"
      ],
      "AdditionalInformation": {
        "SerialNumberScanRequired": false
      }
    }
    // more ...
  ]
}

 

8.3.2 Response example

{
  "Succeeded": true,
  "Code"： "RequestSubmitted",
  "RequestID": "22SOFY74XXXV5",
  "DownloadLink": "https://images10.newegg.com/tpl/portal/ADFS_BatchItemCreation_20190831091201457.xml",
  "Message": "Your data feed has been submitted to Newegg system successfully."
}

8.3.3 Field definitions

Following tables shows definition of each field in your request.

For definitions of item field in the request, please refer to our Manage items section.

Following tables shows definition of each field in returned response.

8.3.4 Response codes

8.4 Submit data feed for batch order creation

POST data-feed/batch-order-creation

Submit data feed for bulk order creation.

Order data will be written into a XML file and upload to Newegg cloud storage. A backend job will be scheduled to process the file for bulk creation. You can use the “Get data feed status” API to check the process result of each entry in your feed.

8.4.1 Request example

{
  "Description": "Short description about this feed",
  "RequestUser": "email@address.com",
  "Data": [
    {
      "SellerOrderNumber": "100-1234567-7654321",
      "OrderDate": "2019-08-30T00:00:00",
      "ExpectShippingDate": null,
      "SalesChannel": "Amazon Seller Prime",
      "SubSalesChannel": null,
      "CustomerPONumber": null,
      "SellerCustomerNumber": null,
      "WarehouseShipmentNumber": null,
      "SSCCRequired": null,
      "ShippingMethod": "Newegg 3 Day",
      "ShipTo": {
        "Name": "Dennis Meade",
        "Company": null,
        "PhoneNumber": "432-012-3456",
        "Address1": "Rowland St. XXX",
        "Address2": null,
        "City": "City of Industry",
        "StateOrProvince": "CA",
        "PostalCode": "91748",
        "Country": "USA"
      },
      "ItemList": [
        {
          "SellerPartNumber": "SY-82404",
          "WarehouseNumber": null,
          "OrderedQuantity": 1,
          "CustomerItemNumber": null,
          "SignatureRequired": false
        }
      ],
      "ExtendedProperties": [
        {
          "Name": "REF02",
          "Value": "1000230455"
        }
      ],
      "Memo": "This is a testing order. Do NOT ship it."
    }
    // more ...
  ]
}

8.4.2 Response example

{
  "Succeeded": true,
  "Code": "RequestSubmitted",
  "RequestID": "24ETA3SXXX1CC",
  "DownloadLink": "https://images10.newegg.com/tpl/portal/ADFS_BatchOrderCreation_20190831091304682.xml",
  "Message": "Your data feed has been submitted to Newegg system successfully."
}

 

8.4.3 Field definitions

Following tables shows definition of each field in your request.

For definitions of order field in the request, please refer to our Manage orders section.

Following tables shows definition of each field in returned response.

8.4.4 Response codes

8.5 Get data feed status

GET data-feed/{Request ID}

Get process result by request ID.

8.5.1 Request example

GET https://apis.newegg.com/tpl/v2/data-feed/24ETA3SXXX1CC

8.5.2 Response example

{
  "RequestID": "24ETA3SXXX1CC",
  "RequestUser": "email@address.com",
  "Type": "OrderCreation",
  "Description": "Short description about this feed",
  "DownloadLink": "https://images10.newegg.com/tpl/portal/ADFS_BatchOrderCreation_20190831091304682.xml",
  "TotalCount": 1,
  "ProcessedCount": 1,
  "FailedCount": 0,
  "Status": "Processed",
  "UploadDate": "2019-08-31T09:12:07.234",
  "UploadDateUtc": "2019-08-31T16:12:07.234Z",
  "ProcessDate": "2019-08-31T09:17:08.720",
  "ProcessDateUtc": "2019-08-31T16:17:08.720Z",
  "ProcessMemo": "Total: 1, Processed: 1, Failed: 0",
  "Results": [
    {
      "LineNumber": 1,
      "Status": "Processed",
      "Description": "Newegg order created successfully. The Newegg Order# is 459611251.",
      "SalesChannel": "Other",
      "SellerOrderID": "0000034919"
    }
  ]
}

8.5.3 Field definitions

Following tables shows definition of each field in returned response.

8.5.4 Response codes