Newegg Logistics Services (NLS): Seller API Integration SOP
Version: 1.0.0
Updated Year: 2021

Table of Contents
· 01_Getstarted
o 1.1RequestaccesstosellerintegrationAPIs
o 1.2 Making your firstrequest
o 1.3 Handling responseerrors
o 1.4 Date and timezone
o 1.5 Testing with sandboxseller
· 02_Manageitems
o 2.1 Itembasics
o 2.2 What you can do with ItemAPIs
o 2.3 Get itemdetails
o 2.4 Query itemlist
o 2.5 Createitem
o 2.6 Updateitem
o 2.7 Deleteitem
o 2.8 Enableitem
o 2.9 Disableitem
o 2.10 Generate itemlabels
· 03_Sendinventory
o 3.1 Inventorybasics
o 3.2 What you can do with InventoryAPIs
o 3.3 Get inventorydetails
o 3.4 Query inventorydetails
o 3.5 Get inventory shipmentdetails
o 3.6 Query inventory shipmentlist
o 3.7 Create inventoryshipment
o 3.8 Update inventoryshipment
o 3.9 Mark inventory shipment asshipped
o 3.10 Cancel inventoryshipment
o 3.11 Generate itemlabels
o 3.12 Generate packagelabels
o 3.13 Generate packing listlabel
· 04_Manageorders
o 4.1 Orderbasics
o 4.2 What you can do with OrderAPIs
o 4.3 Get orderdetails
o 4.4 Query orderlist
o 4.5 Createorder
o 4.6 Cancelorder
· 05_Manage Returns(TBD)
· 06_Request for Reports(TBD)
· 07_Subscribe Notifications(TBD)
· 08_Working with datafeeds
o 8.1 Data feedbasics
o 8.2 What you can do with Data FeedAPIs
o 8.3Submitdatafeedforbatchitemcreation
o 8.4Submitdatafeedforbatchordercreation
o 8.5 Get data feedstatus

Section 1: Get started

· 1.1 Request access to seller integrationAPIs
o 1.1.1 SSLrequirements
o 1.1.2 Get your Client ID and ClientSecret
o 1.1.3 Generate accesstoken
· 1.2 Making your firstrequest
o 1.2.1 Requestheaders
o 1.2.2 BaseURL
o 1.2.3 Example APIcall
· 1.3 Handling responseerrors
o 1.3.1 Data field definition of errorresponse
o 1.3.2 Used HTTP statuscodes
o 1.3.3 Common used errorcodes
· 1.4 Date and timezone
· 1.5 Testing with sandboxseller

1.1 Request access to seller integration APIs
Before use our seller integration API. You need to register as a Newegg Logistics seller at first. Please contact with Newegg Logistics team, they will guide you through the registration process.

1.1.1 SSL requirements

Newegg Logistics seller integration APIs require SSL version 3.0 and higher. All calls to our seller integration APIs must be started with “https://“.

1.1.2 Get your Client ID and Client Secret

Newegg Logistics seller integration APIs use OAuth for token-based authentication and authorization. Please follow below steps to get your Client ID and Client Secret for OAuth access token generation.

1. Log into Newegg Logistics portal (https://www.newegglogistics.com/login), find your Seller ID from Business Information _tab under _Manage Account > Account Setting.
   2. Send your Seller ID to Newegg Logistics support team (3PLDatafeeds@newegg.com), request them for Client ID and Client Secret.
   3. Newegg Logistics support team will take a little time to setup access permission of seller integration APIs for you, and send you the Client ID and Client Secret when done.

1.1.3 Generate access token

Use your Client ID and Client Sercet to generate access token by sending following request to the authorization API.

POST https://apis.newegg.com/tpl/v2/authorization/generate-access-token Accept: application/json
Content-Type: application/json

If your Client ID and Client Sercet is valid, your will see following response with Access Token returned:

We will use generated access token to make API calls to Newegg Logistics seller integration APIs.

1.2 Making your first request
1.2.1 Request headers

You must include following headers to your API calls to our seller integration APIs.

1.2.2 Base URL

All seller integration APIs are hosted under URL https://apis.newegg.com/tpl/v2/.

1.2.3 Example API call

Following is an example API call to create a new item.

POST https://apis.newegg.com/tpl/v2/item Accept: application/json
Content-Type: application/json
Authorization: Bearer L3FcMWq86USjcvk6OStIz3lKYQcxDxhr46RDhYfa

Example response (HTTP status code - 200):

Example response of a bad request (HTTP status code - 400):

Example response of a failure API call (HTTP status code - 500):

1.3 Handling response errors
If your API call failed, HTTP status code 4XX or 5XX will be returned. You can use HTTP status code to check if your request was processed normally.

· If system encountered business errors during request processing, HTTP status code 500 will be returned.
You may need to extract error details from response content to figure out what’s wrong with it.

For POST/PUT/DELETE requests, if returned HTTP status is 200, response content will include the fields “Succeeded” and “Message”. You can check the value of field “Succeeded” to see if the request was processed normally. Refer to example below:

1.3.1 Data field definition of error response

1.3.2 Used HTTP status codes

Following table lists HTTP status codes used by our seller integration APIs. Refer to HTTP/1.1: Status Code Definitions.

1.3.3 Common used error codes

1.4 Date and time zone
Newegg Logistics seller integration APIs accept ISO 8601 for date time values. Default time zone is PST/PDT if not specified. Following table shows valid date time values for your reference.

Date time value in response will be serialized as yyyy-MM-dd’T’HH:mm:ss.fff _and _yyyy-MM- dd’T’HH:mm:ss.fff’Z’ (for UTC) format by default. For example:

· 2029-07-20T11:29:48.263
· 2029-07-20T03:29:48.263Z

1.5 Testing with sandbox seller
Newegg Logistics created a public sandbox seller for testing purpose. You can use this sandbox seller to testing your integration with Newegg Logistics.

Your use above sandbox user ID and password to log into Newegg Logistics portal (https://www.newegglogistics.com/login), to check your testing data submitted by your application.

Section 2: Manage items
· 2.1 Itembasics
o 2.1.1 Newegg Item#
o 2.1.2 Itemstatus
o 2.1.3 Item fielddefinitions
· 2.2 What you can do with ItemAPIs
· 2.3 Get itemdetails
o 2.3.1 Queryparameters
o 2.3.2 Requestexample
o 2.3.3 Responseexample
o 2.3.4 Fielddefinitions
o 2.3.5 Responsecodes
· 2.4 Query itemlist
o 2.4.1 Queryparameters
o 2.4.2 Requestexample
o 2.4.3 Responseexample
o 2.4.4 Fielddefinitions
· 2.5 Createitem
o 2.5.1 Requestexample
o 2.5.2 Responseexample

o 2.5.3 Fielddefinitions
o 2.5.4 Responsecodes
· 2.6 Updateitem
o 2.6.1 Requestexample
o 2.6.2 Responseexample
o 2.6.3 Fielddefinitions
o 2.6.4 Responsecodes
· 2.7 Deleteitem
o 2.7.1 Requestexample
o 2.7.2 Responseexample
o 2.7.3 Responsecodes
· 2.8 Enableitem
o 2.8.1 Requestexample
o 2.8.2 Responseexample
o 2.8.3 Fielddefinitions
o 2.8.4 Responsecodes
· 2.9 Disableitem
o 2.9.1 Requestexample
o 2.9.2 Responseexample
o 2.9.3 Fielddefinitions
o 2.9.4 Responsecodes
· 2.10 Generate itemlabels
o 2.10.1 Requestexample
o 2.10.2 Responseexample
o 2.10.3 Fielddefinitions
o 2.10.4 Responsecodes

2.1 Item basics
Before you send your inventory to Newegg warehouse. You need to create corresponding items in Newegg system. In order to stock your item inventory to Newegg warehouse, you need to provide following information at least.

· Seller Part # - The SKU # used to identify an unique item of yours
· Title - Short description of your item
· Dimension - Item length, width, height (Inch)
· Weight - Item gross weight (LB)
· MSRP - Manufacturer suggested retail price (USD, used for customs clearance)
· Origin countries - Country codes of item origin (used for customs clearance)
· Shipping restriction - Indicate if this product contains hazardous materials, like batteries restricted for shipping

2.1.1 Newegg Item #

Newegg will generate a unique item # (Newegg Item #, e.g.: 9SIADFS9YD2804) once the item was created in Newegg system. The Newegg Item # cannot be changed once generated. Newegg Item # will be used to identity the item and track its inventory in Newegg system.

2.1.2 Item status

Item may have different status. You can send inventory or create orders with the item only when it is Active, also you cannot update an item when it is not Active.

2.1.3 Item field definitions

Below table shows item data fields filled by seller.

2.1 What you can do with Item APIs
The Seller Integration API lets you do the following with the Item APIs.

· GET item/{Seller Part # | Newegg Item #}
Get item details by Seller Part # or Newegg Item #
· GET item
Query item list with given search criteria
· POST item Create an item
· PUT item Update item
· DELETE item/_{Seller Part # | Newegg Item #} _Delete item by Seller Part # or Newegg Item #
· POST item/disable
Disable an item for order creation
· POST item/enable
Restore an item for order creation
· POST item/generate-label
Generate PDF item labels and return DFIS download link.

2.2 Get item details
GET item/{Seller Part # | Newegg Item #}

Get item details by Seller Part # or Newegg Item #. HTTP status code 404 will be returned if item not found.

2.2.1 Query parameters

2.2.2 Request example

Get item details by Newegg Item #.
GET https://apis.newegg.com/tpl/v2/item/9SIADFS9D95206?WithInven toryDetails=true

Get item details by Seller Part #.
GET https://apis.newegg.com/tpl/v2/item/T19031901701?WithInvento ryDetails=true

2.2.3 Response example

],
“Status”: “Active”, “Inventory”: {
“Q4S”: 0,
“InStock”: 0,
“InTransit”: 0,
“Reserved”: 0, “Warehouses”: [
{
“WarehouseNumber”: “02”, “WarehouseName”: “CA Warehouse 02”, “CountryCode”: “USA”,
“Q4S”: 0,
“InStock”: 0,
“InTransit”: 0,
“Reserved”: 0
},
{
“WarehouseNumber”: “07”, “WarehouseName”: “CA Rowland Warehouse”, “CountryCode”: “USA”,
“Q4S”: 0,
“InStock”: 0,
“InTransit”: 0,
“Reserved”: 0
},
{
“WarehouseNumber”: “08”,
“WarehouseName”: “CA Rowland Bulk Item Warehouse”, “CountryCode”: “USA”,
“Q4S”: 0,
“InStock”: 0,
“InTransit”: 0,
“Reserved”: 0
},
{
“WarehouseNumber”: “10”, “WarehouseName”: “NJ Bulk Warehouse”, “CountryCode”: “USA”,
“Q4S”: 0,
“InStock”: 0,
“InTransit”: 0,
“Reserved”: 0
},
{
“WarehouseNumber”: “14”, “WarehouseName”: “NJ Small Warehouse”, “CountryCode”: “USA”,
“Q4S”: 0,
“InStock”: 0,
“InTransit”: 0,
“Reserved”: 0
},

2.2.4 Field definitions

Following table shows extra data fields returned in the response.

For other fields, please refer to 2.1.3 Item field definitions.

2.2.5 Response codes

2.3 Query item list
GET item

Query a list of items by given search criteria. Query result is sorted by create time in descending order.

2.3.1 Query parameters

2.3.2 Request example

Query item list by multiple Newegg Item #.
GET https://apis.newegg.com/tpl/v2/item_?Keyword=9SIADFS9YD2804,9SIADFS9XW8946_
,9SIADFS9XW8522

Query item list by multiple Seller Part #.
GET https://apis.newegg.com/tpl/v2/item_?SearchBy=SellerPartNumber&Keyword=SY- 82401|SY-82403|SY-82404_

Query item list where Seller Part # contains ‘black’
GET https://apis.newegg.com/tpl/v2/item_?SearchBy=SellerPartNumber&Keyword=bla ck_

Query items created from 2019-08-01 (PST/PDT), and status is Active, return first 50 matched items.
GET https://apis.newegg.com/tpl/v2/item_?Status=Active&CreateTimeFrom=2019-08- 01T00:00:00&PageSize=50_

Query active items where available inventory is zero.
GET https://apis.newegg.com/tpl/v2/item_?Status=Active&InventoryTo=0_

2.3.3 Response example

2.3.4 Field definitions

Following table shows extra data fields returned in the response.

For other fields, refer to 2.1.3 Item field definitions and 2.3.4 Field definitions in “Get item details” section.

2.4 Create item
POST item

Create an item. Item status will be Creating after you submitted your item creation request. Item status will be changed to Active when Newegg system completed the item creation.

2.4.1 Request example

POST https://apis.newegg.com/tpl/v2/item

2.4.2 Response example

Item creation request submitted. HTTP status code is 200.

Create item failed. HTTP status code is 500.

2.4.3 Field definitions

Please refer to 2.1.3 Item field definitions.

2.4.4 Response codes

2.5 Update item
PUT item

You can update item only when item is Active. Item status will be Updating after your submitted your update request. Item status will be restored to Active when Newegg system finished updating your item.

You cannot update following fields with this API, because these fields are read-only after item was created:

· Seller Part #
· Condition
· Packs Or Sets

2.5.1 Request example

Only given fields will be updated. You must specify Newegg Item # or Seller Part # to identify the item need to be updated in your request.

PUT https://apis.newegg.com/tpl/v2/item

2.5.2 Response example

2.5.3 Field definitions

You must provide either Newegg Item # or Seller Part # in your request to identify the item need to be updated.

For other fields, please refer to 2.1.3 Item field definitions.

2.5.4 Response codes

2.6 Delete item
DELETE item/{Seller Part # | Newegg Item #}

You can delete an item only when item status is Active or Disabled. You cannot delete an item with following situation:

· Item has pending inventory shipments (in transit)
· Item was used in any order
· Item was used in any return
· Newegg warehouses still have its inventory

Item status will be Deleted after your submitted your delete request. Item will be removed after Newegg system delete your item completely. Deleted item cannot be recovered, so be careful when call this API.

2.6.1 Request example

Delete item by Newegg Item #.
DELETE https://apis.newegg.com/tpl/v2/item/_9SIADFS9XW8522_

Delete item by Seller Part #.
DELETE https://apis.newegg.com/tpl/v2/item/_test-sku%23123456_

2.6.2 Response example

2.6.3 Response codes

2.7 Enable item
POST item/enable

Restore a Disabled item to Active, so that it can be used to create orders again. You cannot enable an item if the UPC of the item already used by other active items.

2.7.1 Request example

POST https://apis.newegg.com/tpl/v2/item/enable

2.7.2 Response example

2.7.3 Field definitions

You must specify Newegg Item # or Seller Part # to identify the item need to be enabled.

2.7.4 Response codes

2.8 Disable item
POST item/disable

Disable an item for create orders. Item status will be changed to Disabled after you disabled it.

2.8.1 Request example

POST https://apis.newegg.com/tpl/v2/item/disable

2.8.2 Response example

2.8.3 Field definitions

You must specify Newegg Item # or Seller Part # to identify the item need to be disabled.

2.8.4 Response codes

2.10 Generate item labels
POST item/generate-label

Generate item label in PDF format. You can see the download link of generated PDF label in response. Item label can be used to label each unit of your items before send inventory to Newegg warehouse.

Item label need to be printed on a thermal printer. Following image is an example of generated item label.

2.10.1 Request example

You must specify Newegg Item # or Seller Part # to identify the item need to generate item label.

Active, Disabled

POST https://apis.newegg.com/tpl/v2/item/generate-label

2.10.2 Response example

2.10.3 Field definitions

Following table shows field definitions of data in your request.

Following table shows field definitions of returned data in the response.

2.10.4 Response codes

Section 3: Send inventory
· 3.1 Inventorybasics
o 3.1.1 ShipmentID
o 3.1.2 Shipmentstatus
o 3.1.3 Neweggwarehouses
o 3.1.4 Shipment fielddefinitions
· 3.2 What you can do with InventoryAPIs
· 3.3 Get inventorydetails
o 3.3.1 Requestexample
o 3.3.2 Responseexample
o 3.3.3 Fielddefinitions
o 3.3.4 Responsecodes
· 3.4 Query inventorydetails
o 3.4.1 Queryparameters
o 3.4.2 Requestexample
o 3.4.3 Responseexample
o 3.4.4 Fielddefinitions
· 3.5 Get inventory shipmentdetails
o 3.5.1 Requestexample
o 3.5.2 Responseexample
o 3.5.3 Fielddefinitions
o 3.5.4 Responsecodes
· 3.6 Query inventory shipmentlist
o 3.6.1 Queryparameters
o 3.6.2 Requestexample
o 3.6.3 Responseexample
o 3.6.4 Fielddefinitions
· 3.7 Create inventoryshipment
o 3.7.1 Requestexample
o 3.7.2 Responseexample
o 3.7.3 Fielddefinitions
o 3.7.4 Responsecodes
· 3.8 Update inventoryshipment
o 3.8.1 Requestexample
o 3.8.2 Responseexample
o 3.8.3 Fielddefinitions
o 3.8.4 Responsecodes
· 3.9 Mark inventory shipment asshipped
o 3.9.1 Requestexample
o 3.9.2 Responseexample
o 3.9.3 Fielddefinitions
o 3.9.4 Responsecodes

· 3.10 Cancel inventoryshipment
o 3.10.1 Requestexample
o 3.10.2 Responseexample
o 3.10.3 Fielddefinitions
o 3.10.4 Responsecodes
· 3.11 Generate itemlabels
o 3.11.1 Requestexample
o 3.11.2 Responseexample
o 3.11.3 Fielddefinitions
o 3.11.4 Responsecodes
· 3.12 Generate packagelabels
o 3.12.1 Requestexample
o 3.12.2 Responseexample
o 3.12.3 Fielddefinitions
o 3.12.4 Responsecodes
· 3.13 Generate packing listlabel
o 3.13.1 Requestexample
o 3.13.2 Responseexample
o 3.13.3 Responsecodes

3.1 Inventory basics
You need to create inbound shipments to send your inventory to Newegg warehouses before create orders. To create an inbound shipment (aka. send inventory shipment) in Newegg system, you need to provide following information at least.

· Destination warehouse - Newegg warehouse # expected to receive the shipment
· Seller Part # - Seller Part # of shipment items
· Quantity - Unit of items to be shipped

You need to label each unit of the shipment items, and pack them into packages with packing list for receiving. When your shipment has been picked up, you need to mark the shipment as shipped in Newegg system, with tracking# and ship service selected.

3.1.1 Shipment ID

Newegg will generate a unique shipment ID to identify your shipment.

3.1.2 Shipment status

Newegg Logistics uses following status to indicate the state of a shipment.

3.1.3 Newegg warehouses

You can send your inventory to following warehouses.

3.1.4 Shipment field definitions

3.1 What you can do with Inventory APIs
· GET inventory/{Seller Part # | Newegg Item #} _Get inventory details of an item
· GET inventory
Query a list of item inventory details
· GET inventory/inbound-shipment/{Shipment ID} _Get inbound inventory shipment details
· GET inventory/inbound-shipment Query inbound inventory shipment list
· POST inventory/inbound-shipment Create an inbound inventory shipment
· PUT inventory/inbound-shipment Update inbound inventory shipment

· POST inventory/inbound-shipment/mark-as-shipped Mark an inventory shipment as shipped
· POST inventory/inbound-shipment/cancel Cancel an inventory shipment
· POST inventory/inbound-shipment/generate-item-label Generate item labels for an inventory shipment
· POST inventory/inbound-shipment/generate-package-label Generate package labels for inventory shipment
· POST inventory/inbound-shipment/generate-packing-list-label Generate packing list label for receiving

3.2 Get inventory details
GET inventory/{Seller Part # | Newegg Item #}/{Warehouse #}

Get warehouse inventory details of an item. You must assign a specific warehouse # to get inventory details of this warehouse. Please refer to 3.1.3 Newegg warehouses.

3.2.1 Request example

Get inventory details by Seller Part #.

GET https://apis.newegg.com/tpl/v2/inventory/SY-82401/02

Get inventory details by Newegg Item #.

GET https://apis.newegg.com/tpl/v2/inventory/9SIADFS9YD2804/08

3.2.2 Response example

Return inventory details of specified warehouse.

3.2.3 Field definitions

Following table shows definition for each data field returned in above response.

3.2.4 Response codes

3.3 Query inventory details
GET inventory

Query warehouse inventory details by given search criteria.

3.3.1 Query parameters

3.3.2 Request example

Query warehouse inventory details by multiple Newegg Item #.
GET https://apis.newegg.com/tpl/v2/inventory_?Keyword=9SIADFS9YD2804,9SIADFS9X W8946,9SIADFS9XW8522_

Query warehouse inventory details by multiple Seller Part #.
GET https://apis.newegg.com/tpl/v2/inventory_?SearchBy=SellerPartNumber&Keywor d=SY-82401|SY-82402|SY-82404_

Query warehouse inventory details of warehouse 02, and last updated from 2019-08-01 (PST/PDT), return first 50 matched items.
GET https://apis.newegg.com/tpl/v2/inventory_?WarehouseNumber=02&LastUpdateTim e=2019-08-01T00:00:00&PageSize=50_

3.3.3 Response example

3.3.4 Field definitions

Following table shows definition for each data fields returned in the response.

For other fields, refer to 3.3.3 Field definitions in “Get inventory details” section.

3.4 Get inventory shipment details
GET inventory/inbound-shipment/{Shipment ID}

Get inbound inventory shipment details by shipment ID. HTTP status code 404 will be returned if shipment not found.

3.4.1 Request example

GET https://apis.newegg.com/tpl/v2/inventory/inbound-shipment/_10004532_

3.4.2 Response example

3.4.3 Field definitions

Following table shows definition for each data fields returned in the response.

For other fields, please refer to 3.1.4 Shipment field definitions.

3.4.4 Response codes

3.5 Query inventory shipment list
GET inventory/inbound-shipment

Query inbound inventory shipment list by given search criteria.

3.5.1 Query parameters

3.5.2 Request example

Query inbound inventory shipment list by multiple shipment IDs. GET https://apis.newegg.com/tpl/v2/inventory/inbound- shipment?Keyword=10003899,100039000

Query inbound inventory shipment list by tracking#.
GET https://apis.newegg.com/tpl/v2/inventory/inbound- shipment?SearchBy=TrackingNumber&Keyword=1Z81W1R72410861670

Query received inventory shipment list, return first 50 matched shipments. GET https://apis.newegg.com/tpl/v2/inventory/inbound- shipment?Status=Received&PageSize=50

3.5.3 Response example

“Status”: “Partially Received”, “ItemList”: [
{
“NeweggItemNumber”: “9SIADFS9XW8522”, “SellerPartNumber”: “SY-82401”, “Manufacturer”: “Newegg Logistics”, “ManufacturerPartNumber”: “SY-82401”, “UPC”: “463565040544”,
“NPC”: “00000150836191”, “Title”: “TEST - ITEM #1”,
“Quantity”: 100,
“ReceivedQuantity”: 30, “UOM”: “PCS”,
“PieceCountPerCarton”: null
},
{
“NeweggItemNumber”: “9SIADFS9XW8946”, “SellerPartNumber”: “SY-82404”, “Manufacturer”: “Newegg Logistics”, “ManufacturerPartNumber”: “SY-82403”, “UPC”: “463565040544”,
“NPC”: “00000150836191”, “Title”: “TEST - ITEM #2”,
“Quantity”: 25,
“ReceivedQuantity”: 25, “UOM”: “PCS”,
“PieceCountPerCarton”: null
},
{
“NeweggItemNumber”: “9SIADFS9YD2804”, “SellerPartNumber”: “SY-82404”, “Manufacturer”: “Newegg Logistics”, “ManufacturerPartNumber”: “SY-82404”, “UPC”: “463565040544”,
“NPC”: “00000150836191”, “Title”: “TEST - ITEM #3”,
“Quantity”: 40,
“ReceivedQuantity”: 0, “UOM”: “PCS”,
“PieceCountPerCarton”: null
}
],
“ShipCarrier”: “UPS”,
“ShipService”: “Small Parcel Delivery”, “TrackingNumberList”: [ “1Z81W1R72410861670”, “1Z81W1R72410861661”
],
“ShipDate”: “2019-08-28T07:42:37.884”, “CreateTime”: “2019-08-26T23:34:34.943”, “CreateTimeUtc”: “2019-08-27T06:34:34.943Z”,
“LastUpdateTime”: “2019-08-28T09:08:36.8898299-07:00”, “LastUpdateTimeUtc”: “2019-08-28T16:08:36.8898299Z”,

3.5.4 Field definitions

Following table shows definition for each data fields returned in the response.

For other fields, refer to 3.1.4 Shipment field definitions and 3.5.3 Field definitions in “Get inventory shipment details” section.

3.6 Create inventory shipment
POST inventory/inbound-shipment

Create an inventory shipment. Newegg system will create a unique shipment ID to identify the shipment, and shipment status will be Preparing after created.

3.6.1 Request example

POST https://apis.newegg.com/tpl/v2/inventory/inbound-shipment

3.6.2 Response example

Generated shipment ID is returned in the response.

3.6.3 Field definitions

For definition of each field in above request, please refer to 3.1.4 Shipment field definitions.

3.6.4 Response codes

3.7 Update inventory shipment
PUT inventory/inbound-shipment

Update an inbound inventory shipment by shipment ID before Newegg warehouse receive the shipment. If the shipment was received, only ship service and tracking # can be updated.

Status of shipment is read-only, you cannot update shipment status with this API. To mark the shipment as Shipped, please refer to 3.9 Mark inventory shipment as shipped.

3.7.1 Request example

PUT https://apis.newegg.com/tpl/v2/inventory/inbound-shipment

3.7.2 Response example

3.7.3 Field definitions

For other field in your request, please refer to 3.1.4 Shipment field definitions.

3.7.4 Response codes

3.8 Mark inventory shipment as shipped
POST inventory/inbound-shipment/mark-as-shipped

Mark a shipment as shipped. You can update associated tracking# and ship service in this API too.

Only the shipment status is ‘Preparing’ or ‘Ready To Ship’, you can mark shipment as shipped.

3.8.1 Request example

POST https://apis.newegg.com/tpl/v2/inventory/inbound-shipment/mark-as- shipped

3.8.2 Response example

3.8.3 Field definitions

Following table shows definition of each data field in above request.

3.8.4 Response codes

3.10 Cancel inventory shipment
POST inventory/inbound-shipment/cancel

Cancel an inventory shipment before it get shipped out.

Only the shipment status is ‘Preparing’, ‘Ready To Ship’ or ‘Shipped’, you can cancel the shipment.

3.10.1 Request example

POST https://apis.newegg.com/tpl/v2/inventory/inbound-shipment/cancel

3.10.2 Response example

3.10.3 Field definitions

Following table shows definition of each data field in your request.

3.10.4 Response codes

3.11 Generate item labels
POST inventory/inbound-shipment/generate-item-label

If your item do not include a UPC/ISBN barcode on the product packaging, you need to label each unit of the item with NPC (Newegg Product Code). Use this API to generate item labels for a shipment according to the shipment quantity of each item. Generated item labels are all in a PDF document, with one label per page.

Following image is an example of generated item labels for a shipment.

3.11.1 Request example

POST https://apis.newegg.com/tpl/v2/inventory/inbound-shipment/generate-item- label

3.11.2 Response example

3.11.3 Field definitions

Following table shows definition of each data field in above request.

Following table shows field definitions of returned data in the response.

3.11.4 Response codes

3.12 Generate package labels
POST inventory/inbound-shipment/generate-package-label

Generate package labels to indicate items within a package.

We strongly recommend that you package same items into one box. Same items can be packed in multiple boxes, but one box should only contain one type of item. A package label must be displayed on the outside of each box.

Same SKU packaging is preferred and will ensure fast receiving of your shipment. Mixed inventory packaged shipments may take longer to receive.

Following image is an example of generated package labels for a shipment.

3.12.1 Request example

POST https://apis.newegg.com/tpl/v2/inventory/inbound-shipment/generate- package-label

3.12.2 Response example

3.12.3 Field definitions

Following table shows definition of each data field in your request.

Following table shows field definitions of returned data in the response.

3.12.4 Response codes

3.13 Generate packing list label
POST inventory/inbound-shipment/generate-packing-list-label

Generate packing list for receiving.

Following image is an example of generated packing list label of a shipment for receiving.

3.13.1 Request example

You need to specify the shipment ID to generate packing list label.

POST https://apis.newegg.com/tpl/v2/inventory/inbound-shipment/generate- packing-list-label

3.13.2 Response example

Generated packing list label is returned in the _DownloadLink _field.

3.13.3 Response codes

Section 4: Manage orders
· 4.1 Orderbasics
o 4.1.1 Newegg Order#
o 4.1.2 Orderstatus
o 4.1.3 Order fielddefinitions
· 4.2 What you can do with OrderAPIs
· 4.3 Get orderdetails
o 4.3.1 Queryparameters
o 4.3.2 Requestexample
o 4.3.3 Responseexample
o 4.3.4 Fielddefinitions
o 4.3.5 Responsecodes
· 4.4 Query orderlist
o 4.4.1 Queryparameters
o 4.4.2 Requestexample
o 4.4.3 Responseexample
o 4.4.4 Fielddefinitions
· 4.5 Createorder
o 4.5.1 Requestexample
o 4.5.2 Responseexample
o 4.5.3 Fielddefinitions
o 4.5.4 Responsecodes
· 4.6 Cancelorder
o 4.6.1 Requestexample
o 4.6.2 Responseexample
o 4.6.3 Fielddefinitions
o 4.6.4 Responsecodes

4.1 Order basics
Newegg Logistics orders are warehouse shipment orders that help seller to deliver their items from Newegg warehouse to customer. You need to make sure each order item has sufficient inventory before place an order into Newegg Logistics system.

To create an order in Newegg Logistics system, you need to provide following information at least.

· Seller Order # - Unique order # assigned by seller to identify an order from a sales channel
· Sales channel - Origin website or source where the order is placed
· Ship service selected - Newegg shipping method or 3rd party shipping service to be used for this order
· Customer information - Customer name, phone # etc
· Shipping address - Ship to destination, include detail address line, city, state, zip code etc
· Seller Part # - The SKU # used to identify an unique item of yours
· Ordered quantity - Units of the item to be shipped

4.1.1 Newegg Order #

Newegg will generate a unique order number (Newegg Order #, e.g.: 451304212) when order submitted to Newegg system. The Newegg Order # will be used to identify an order in Newegg system.

4.1.2 Order status

Newegg Logistics uses following status to indicate the state of an order.

Diagram of order status flow:

4.1.3 Order field definitions

4.1 What you can do with Order APIs
The Seller Integration API lets you do the following with the Order APIs.

· GET order/{Newegg Order # | Seller Order #}
Get order details by Seller Order # or Newegg Order #
· GET order
Query order list by given search criteria
· POST order Create an order
· POST order/cancel Cancel an order

4.2 Get order details
GET order/{Newegg Order # | Seller Order #}

Get order details by Newegg Order # or Seller Order #. HTTP status code 404 will be returned if order not found.

4.2.1 Query parameters

4.2.2 Request example

Get order details by Newegg Order #.
GET https://apis.newegg.com/tpl/v2/order/_451304212_

Get order details by Seller Order # and Sales Channel.
GET https://apis.newegg.com/tpl/v2/order/09-12345- 67890?SalesChannel=eBay%20USA

4.2.3 Response example

“StateOrProvince”: “CA”, “PostalCode”: “91748”, “Country”: “USA”
},
“ItemList”: [
{
“NeweggItemNumber”: “9SIADFS9YD2804”, “SellerPartNumber”: “SY-82404”, “WarehouseNumber”: “02”, “WarehouseName”: “CA Warehouse 02”, “Condition”: “New”, “ManufacturerPartNumber”: “SY-82404”, “UPC”: “413565040662”,
“Description”: “TEST ITEM #4”, “PacksOrSets”: 1,
“OrderedQuantity”: 1,
“ShippedQuantity”: 1, “UOM”: null, “PieceCountPerCarton”: null, “UnitPrice”: 89.99, “CustomerItemNumber”: null, “SignatureRequired”: null, “Status”: “Shipped”
}
],
“PackageList”: [
{
“TrackingNumber”: “1ZX037170301234567”, “ShippingMethod”: “Newegg 3 Day”, “ShipCarrier”: “UPS”,
“ShipService”: “UPS Ground”, “ShipServiceCode”: “038”, “ShipDate”: “2019-08-30T14:25:58”,
“WarehouseNumber”: “02”,
“Length”: 37.25,
“Width”: 25.5,
“Height”: 9.5,
“Weight”: 42.33, “Status”: null, “ProNumber”: null, “SSCC”: null,
“ItemList”: [
{
“NeweggItemNumber”: “9SIADFS9YD2804”, “SellerPartNumber”: “SY-82404”, “ManufacturerPartNumber”: “SY-82404”, “UPC”: “413565040662”,
“OrderedQuantity”: 1,
“ShippedQuantity”: 1, “SerialNumberList”: [ “413565040662”
]
}

4.2.4 Field definitions

Following table shows extra data fields returned in the response.

For other fields, please refer to 4.1.3 Order field definitions.

4.2.5 Response codes

4.3 Query order list
GET order

Query a list of orders by given search criteria.

4.3.1 Query parameters