Manage Orders

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 shannel – Origin website or source where the order is placed
• Ship service selected – Newegg shipping method or 3^rd 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 an 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.2 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.3 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.3.1 Query parameters

4.3.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.3.3 Response example

[INSERT TABLE]

4.3.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.3.5 Response codes

4.4 Query order list

GET order

Query a list of orders by given search criteria.

4.4.1 Query parameters

4.4.2 Request example

Query order list by multiple Newegg Order #.
GET https://apis.newegg.com/tpl/v2/order?Keyword=400000001,400000002,400000003

Query order list by Seller Part #
GET https://apis.newegg.com/tpl/v2/order?SearchBy=SellerPartNumber&Keyword=SY-82404

Query order list where Seller Order Date is from 2019-08-01 (PST/PDT), and status is Invoiced, return first 50 matched orders.
GET https://apis.newegg.com/tpl/v2/order?Status=Invoiced&SellerOrderDateFrom=2019-08-01T00:00:00&PageSize=50

Query order list by Sales Channel.
GET https://apis.newegg.com/tpl/v2/order?SalesChannel=eBay%20USA

4.4.3 Response example

{
  "Count": 10,
  "TotalCount": 13,
  "PageSize": 10,
  "TotalPageCount": 2,
  "NextPageIndex": 1,
  "Results": [
    {
      "NeweggOrderNumber": 400000003,
      "SellerOrderNumber": "100-1234567-7654321",
      "OrderDate": "2019-08-30T00:00:00",
      "ExpectShippingDate": null,
      "SalesChannel": "eBay USA",
      "SubSalesChannel": null,
      "Platform": null,
      "PlatformID": null,
      "CustomerPONumber": null,
      "SellerCustomerNumber": null,
      "WarehouseShipmentNumber": null,
      "SSCCRequired": null,
      "ShippingMethod": "Newegg 3 Day",
      "OrderStatus": "Invoiced",
      "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": [
        {
          "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"
        }
      ],
      "PackageInfoList": [
        {
          "TrackingNumber": "1ZX037170301234567",
          "ShippingMethod": "Newegg 3 Day",
          "ShipCarrier": "UPS",
          "ShipService": "UPS Ground",
          "ShipServiceCode": "038",
          "ShipDate": "08/30/2019 14: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"
              ]
            }
          ]
        }
      ],
      "ExtendedProperties": [
        {
          "Name": "IsPrime",
          "Value": "Yes"
        }
      ],
      "Memo": "This is a testing order. Do NOT ship it.",
      "CreateTime": "2019-08-30T12:45:04.395",
      "CreateTimeUtc": "2019-08-30T19:45:04.395Z",
      "LastUpdateTime": "2019-08-30T12:45:42.939-07:00",
      "LastUpdateTimeUtc": "2019-08-30T19:45:42.939Z"
    }
    // more ...
  ]
}

4.4.4 Field definitions

Following table shows extra data fields returned in the response.

For other fields, refer to 4.1.3 Order field definitions and 4.3.4 Field definitions in “Get order details” section.

4.5 Create order

POST order

Create an order. Order status will be Initialized after you submitted your order creation request. Order status will be changed to Unshipped when order released Newegg warehouse.

Newegg Logistics will verify your order data before release it to Newegg warehouse. Order status will be changed to Exceptional if verification failed.

If an order with the same Seller Order # and Sales Channel exists in Newegg system. Order creation will be rejected if order status is not Exceptional, or Void.

4.5.1 Request example

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

{  "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": "UserDefine5",
          "Value": "20171019"
        },
        {
          "Name": "Price",
          "Value": "58.00"
        }
      ]
    }
  ],
  "ExtendedProperties": [
    {
      "Name": "REF02",
      "Value": "1000230455"
    },
    {
      "Name": "CURRENCY_CODE",
      "Value": "CNY"
    }
  ],
  "Memo": "This is a testing order. Do NOT ship it."
}

4.5.2 Response example

Order created. HTTP status code is 200.

{
  "Succeeded": true,
  "Message": "Your order creation request has been submitted. The system may take about 1 minute to process your request. Order status will be changed to Unshipped when the order is released to Newegg warehouse."
}

{
  "Succeeded": false,
  "ErrorCode": "DuplicateOrder",
  "Message": "An order with the same Seller Order # and sales channel already exists."
}

4.5.3 Field definitions

Please refer to 4.1.3 Order field definitions.

4.5.4 Response codes

4.6 Cancel order

POST order/cancel

Cancel an order before it get shipped. You can cancel an order with following status only.

• Pending
• Exceptional
• Unshipped
• Ready to Ship

Newegg will try to fulfill you order as soon as possible. So cancel order might be failed if you submit your cancel order request on next business day or later. Contact Newegg Logistics support if you really want to intercept the order from shipping.

4.6.1 Request example

POST https://apis.newegg.com/tpl/v2/order/cancel

{
  "NeweggOrderNumber": 400000033,
  "SellerOrderNumber": null,
  "SalesChannel": null,
  "CancelReason": "UnableToFulfill",
  "Memo": "Cannot ship to APO address"
}

4.6.2 Response example

Cancel request submitted. HTTP status code is 200.

{
  "Succeeded": true,
  "Message": "Your cancel order request has been sent. The system may take a few minutes to process your request. Order status will be changed to Void when Newegg cancelled your order."
}

Cancel request failed. HTTP status code is 409.

{
  "Succeeded": false,
  "ErrorCode": "OrderAlreadyShipped",
  "Message": "Unable to cancel an order being shipped already."
}

4.6.3 Field definitions

You must specify Newegg Order #, or Seller Order # to identify the order need to be cancelled.

4.6.4 Response codes