Order Ship Notice Feed

Batch ship orders that is placed on Newegg that seller’s will be responsible to fulfill.

This request will allow seller’s to update shipment of one or all items in an order. When the order has been completely fulfilled (i.e. all the item(s) in order shipped), the order process is completed.

Please review the following example and the possible shipment options you can assign for each feed:
Order XYZ has item A (5 units) and item B (1 unit)

• Single package contains 5 units of item A and 1 unit of item B with one tracking number.
• Single package contains either 5 units of item A or 1 unit of item B with one tracking number.
• Mutile packages: one package contains 5 units of item A with one tracking number. The other package contains 1
  unit of item B with another tracking number.
• Multiple package: one package contains 2 units of item A with one tracking number. Another package contains 3
  units of item A with another tracking number. The other package contains 1 unit of item B with another tracking
  number.
• Multiple package, 1 package contains 2 units of item A with one tracking number. The other package contains 3
  units of item A and 1 unit of item B with another tracking number.
• You cannot submit a request for partial shipment as following: Single package contains 2 units of item A with
  one tracking number.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype={RequestType}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype={RequestType}
Newegg.ca: https://api.newegg.com/marketplace/can/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype={RequestType}

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: ShipNotice.xsd

Example: XML, Request

POST https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ORDER_SHIP_NOTICE_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggEnvelope>
    <Header>
        <DocumentVersion>1.0</DocumentVersion>
    </Header>
    <MessageType>ShipNotice</MessageType>
    <Message>
        <ShipNotice>
            <Package>
                <OrderNumber>11006035</OrderNumber>
                <ItemInformation>
                    <Item>
                        <SellerPartNumber>data_MP_329_00976</SellerPartNumber>
                        <NeweggItemNumber>9SIAWES000CY64</NeweggItemNumber>
                        <ShippedQuantity>1</ShippedQuantity>
                    </Item>
                    <Item>
                        <SellerPartNumber>data_MP_329_00975</SellerPartNumber>
                        <NeweggItemNumber>9SIAWES000CY58</NeweggItemNumber>
                        <ShippedQuantity>2</ShippedQuantity>
                    </Item>
                    <Item>
                        <SellerPartNumber>data_MP_329_00974</SellerPartNumber>
                        <NeweggItemNumber>9SIAWES000CY53</NeweggItemNumber>
                        <ShippedQuantity>1</ShippedQuantity>
                    </Item>
                    <Item>
                        <SellerPartNumber>data_MP_32900973</SellerPartNumber>
                        <NeweggItemNumber>9SIAWES000CY49</NeweggItemNumber>
                        <ShippedQuantity>1</ShippedQuantity>
                    </Item>
                    <Item>
                        <SellerPartNumber>data_MP_32900972</SellerPartNumber>
                        <NeweggItemNumber>9SIAWES000CY45</NeweggItemNumber>
                        <ShippedQuantity>2</ShippedQuantity>
                    </Item>
                </ItemInformation>
                <ActualShippingCarrier>UPS</ActualShippingCarrier>
                <ActualShippingMethod>UPS Ground</ActualShippingMethod>
                <TrackingNumber>20110922002</TrackingNumber>
            </Package>
        </ShipNotice>
    </Message>
</NeweggEnvelope>

Example: Json, Request

POST https://api.newegg.com/marketplace/datafeedmgmt/feeds/submitfeed?sellerid={sellerid}&requesttype=ORDER_SHIP_NOTICE_DATA
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "NeweggEnvelope": {
        "Header": {
            "DocumentVersion": "1.0"
        },
        "MessageType": "ShipNotice",
        "Message": {
            "ShipNotice": {
                "Package": {
                    "OrderNumber": "11006035",
                    "ItemInformation": {
                        "Item": [
                            {
                                "SellerPartNumber": "data_MP_329_00976",
                                "NeweggItemNumber": "9SIAWES000CY64",
                                "ShippedQuantity": "1"
                            },
                            {
                                "SellerPartNumber": "data_MP_329_00975",
                                "NeweggItemNumber": "9SIAWES000CY58",
                                "ShippedQuantity": "2"
                            },
                            {
                                "SellerPartNumber": "data_MP_329_00974",
                                "NeweggItemNumber": "9SIAWES000CY53",
                                "ShippedQuantity": "1"
                            },
                            {
                                "SellerPartNumber": "data_MP_32900973",
                                "NeweggItemNumber": "9SIAWES000CY49",
                                "ShippedQuantity": "1"
                            },
                            {
                                "SellerPartNumber": "data_MP_32900972",
                                "NeweggItemNumber": "9SIAWES000CY45",
                                "ShippedQuantity": "2"
                            }
                        ]
                    },
                    "ActualShippingCarrier": "UPS",
                    "ActualShippingMethod": "UPS Ground",
                    "TrackingNumber": "20110922002"
                }
            }
        }
    }
}

Response Body

Schema: SubmitFeedResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>SubmitFeedResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>2291326430</RequestId>
                <RequestType>ORDER_SHIP_NOTICE_DATA</RequestType>
                <RequestDate>2/16/2012 12:29:19</RequestDate>
                <RequestStatus>SUBMITTED</RequestStatus>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
    <Memo />
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "OperationType": "SubmitFeedResponse",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestDate": "2/22/2012 17:24:35",
                "RequestId": "2PQCX3CMQ82MK",
                "RequestStatus": "SUBMITTED",
                "RequestType": "ORDER_SHIP_NOTICE_DATA"
            }
        ]
    },
    "SellerID": "A006"
}

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>DF003</Code>
        <Message>The MaxCount (maximum request records) CANNOT be over 30000</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "DF003",
        "Message": "The MaxCount (maximum request records) CANNOT be over 30000"
    }
]

Last updated: October 15, 2018