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.

Newegg allows shipping order(s) in multiple packages, please review the following package options when submitting shipment.  Each package will have its own carrier and unique tracking information.  Order XYZ  containing two items, Item_A (5 qty) and Item_B (1 qty), example of different scenarios when submitting a shipment to Newegg:

• Scenario 1 single package: Package 1, containing Item_A (5 qty) and Item_B (1 qty) with tracking#1.
• Scenario 2 single package: Package 1, containing Item_A (5 qty) with tracking#1.
  • This is will be considered a partially shipped order.
  • Item_B should be shipped, Package 2, before the auto-void date of order, else if not shipped, Newegg will remove Item_B from order and invoice order with just Item_A.
• Scenario 3 multiple packages: Package 1, containing Item_A (5 qty) with tracking#1.  Package 2, containing Item_B (1 qty) with tracking#2.
• Scenario 4 multiple packages: Package 1, containing Item_A (2 qty) with tracking#1.  Package 2,  containing Item_A (3 qty) with tracking#2. Package 3, containing Item_B (1 qty) with tracking#3.
• Newegg will not accept partial shipment of item qty ordered: Package 1, containing Item_A (2 qty).
  • Newegg will error submitted shipment and notice total qty ordered of Item_A does not match qty shipped.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}

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

Resource Information

Request Body

Schema: ShipmentRequest.xsd

Example: XML, Request

Note: <VALUE> MUST BE ENCLOSED BY <![CDATA[]]>, See Example for Detail.

PUT https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<UpdateOrderStatus>
    <Action>2</Action>
    <Value>
        <![CDATA[
<Shipment><Header><SellerID>A006</SellerID><SONumber>159243598</SONumber></Header><PackageList><Package><TrackingNumber>lztestA0060001</TrackingNumber><ShipCarrier>Other Carrier</ShipCarrier><ShipService>Other Service</ShipService><ItemList><Item><SellerPartNumber>A006ZX-35833</SellerPartNumber><ShippedQty>1</ShippedQty></Item></ItemList></Package></PackageList></Shipment>
]]>
    </Value>
</UpdateOrderStatus>

Example: Json, Request

PUT https://api.newegg.com/marketplace/can/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",
                        "ItemList": {
                            "Item": {
                                "SellerPartNumber": "A3WG11002378965412586",
                                "ShippedQty": "1"
                            }
                        }
                    },
                    {
                        "TrackingNumber": "alistestonly2",
                        "ShipCarrier": "Purolator",
                        "ShipService": "3-5",
                        "ItemList": {
                            "Item": [
                                {
                                    "SellerPartNumber": "A3WG11002378965412583",
                                    "ShippedQty": "1"
                                },
                                {
                                    "SellerPartNumber": "A3WG11002378965412584",
                                    "ShippedQty": "1"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    }
}

Response Body

Schema: ShipmentResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<UpdateOrderStatusInfo>
    <IsSuccess>true</IsSuccess>
    <PackageProcessingSummary>
        <TotalPackageCount>1</TotalPackageCount>
        <SuccessCount>1</SuccessCount>
        <FailCount>0</FailCount>
    </PackageProcessingSummary>
    <Result>
        <OrderNumber>159243598</OrderNumber>
        <SellerID>A006</SellerID>
        <OrderStatus>Shipped</OrderStatus>
        <Shipment>
            <PackageList>
                <Package>
                    <TrackingNumber>lztestA0060001</TrackingNumber>
                    <ShipDate>2012-02-10T15:30:01</ShipDate>
                    <ProcessStatus>true</ProcessStatus>
                    <ProcessResult>Success</ProcessResult>
                    <ItemList>
                        <ItemDes>
                            <NeweggItemNumber>9SIA0060845543</NeweggItemNumber>
                            <SellerPartNumber>A006ZX-35833</SellerPartNumber>
                            <ShippedQty>1</ShippedQty>
                        </ItemDes>
                    </ItemList>
                </Package>
            </PackageList>
        </Shipment>
    </Result>
</UpdateOrderStatusInfo>

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",
                    "ProcessStatus": true,
                    "ShipDate": "2012-02-10T15:30:01",
                    "TrackingNumber": "lztestA0060001"
                }
            ]
        }
    }
}

Request Failure Errors

For common HTTP error responses, please refer to Failed Response Error Code List.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SO002</Code>
        <Message>Order Number should be an integer (ranging from 1 to 2147483647)</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "SO002",
        "Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
    }
]

Last updated: October 15, 2018