Get Inbound Shipment Request Result

Get the processing result of a specified inbound shipment request.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={sellerid}

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

Name	Required?	Description
sellerid	Yes	Your seller ID on Newegg Marketplace

Resource Information

HTTP Method	Authentication?	Request Formats	Response Formats	Rate Limited?
GET	Required	XML, Json	XML, Json	100 requests per min per client

Request Body

Example: XML, Request

GET https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

Example: Json, Request

GET https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentresult/{requestid}?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

Response Body

For the new shipment creation, once your request has been created successfully, we will return the ShipmentID and Newegg supported label files for your downloading.

Item Label Sample:

Package Label Sample:

Shipping Label Sample (Only available when Shipping carrier = Newegg Partnered Carrier (UPS)):

Packing List Label Sample:

 

Attribute	Format	Description
IsSuccess	String	Get feed status operation: True: Successful False: Not successful
OperationType	String	Fixed value: GetShipmentResultResponse
SellerID	String	Your seller ID
RequestID	String	The Identifier of  submission
RequestDate	String	Request date of submission
ProcessedDate	String	Processed date of submission
RequestStatus	String	The status of the request submission: FINISHED
LabelType	String	Label types: ItemLabel PackageLabel ShippingLabel PackingListLabel
LabelURL	String	URL for downloading labels
ErrorDescription	String	Error description

Schema: GetInboundShipmentResultResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetShipmentResultResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <RequestID>21VS8NZ4D1RU9</RequestID>
        <RequestDate>07/14/2013 22:41:25</RequestDate>
        <ProcessedDate>07/14/2013 22:42:40</ProcessedDate>
        <RequestStatus>FINISHED</RequestStatus>
        <Shipment>
            <ShipmentID>2768782</ShipmentID>
            <LabelURLList>
                <Label>
                    <LabelType>ItemLabel</LabelType>
                    <LabelUrl>ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/fff5267a-b688-4705-a676-6b17e910454a.pdf</LabelUrl>
                </Label>
                <Label>
                    <LabelType>PackageLabel</LabelType>
                    <LabelUrl>ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/ac2ec547-4492-41c0-80facbcbd2e5a393.pdf</LabelUrl>
                </Label>
                <Label>
                    <LabelType>PackingListLabel</LabelType>
                    <LabelUrl>ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/d5dd197a-5e4a-410d-bc12-98841ea84623.pdf</LabelUrl>
                </Label>
                <Label>
                    <LabelType>ShippingLabel</LabelType>
                    <LabelUrl>ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/063d7c3a-0ed3-4b5f-adb7-f21ba46e2d4f.pdf</LabelUrl>
                </Label>
            </LabelURLList>
            <ErrorList></ErrorList>
        </Shipment>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "GetShipmentResultResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "RequestID": "21VS8NZ4D1RU9",
        "RequestDate": "07/14/2013 22:41:25",
        "ProcessedDate": "07/14/2013 22:42:40",
        "RequestStatus": "FINISHED",
        "Shipment": {
            "ShipmentID": 2768782,
            "Label": [
                {
                    "LabelType": "ItemLabel",
                    "LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/fff5267a-b688-4705-a676-6b17e910454a.pdf"
                },
                {
                    "LabelType": "PackageLabel",
                    "LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/ac2ec547-4492-41c0-80facbcbd2e5a393.pdf"
                },
                {
                    "LabelType": "PackingListLabel",
                    "LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/d5dd197a-5e4a-410d-bc12-98841ea84623.pdf"
                },
                {
                    "LabelType": "ShippingLabel",
                    "LabelUrl": "ftp://API-kisRuBid:aa8ke7h8@ftp03.newegg.com/063d7c3a-0ed3-4b5f-adb7-f21ba46e2d4f.pdf"
                }
            ]
        }
    }
}

Request Failure Errors

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

Last updated: October 15, 2018