Get Package List

When you are ready to ship an order, you can request a package list using this function.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/shippingservice/shippinglabel/packagelist?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/shippingservice/shippinglabel/packagelist?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?
PUT Required XML, Json XML, Json 10 per min per client

Request Body

Attribute Required? Format Description
OperationType Yes String Fixed value: GetPackageListRequest
RequestID Yes, if no OrderNumber provided String The shipping request ID
OrderNumber Yes, if no RequestID provided String Order number

Schema: GetPackageListRequest.xsd

Example: XML, Request

PUT https://api.newegg.com/marketplace/b2b/shippingservice/shippinglabel/packagelist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<NeweggAPIRequest>
    <OperationType>GetPackageListRequest</OperationType>
    <RequestBody>
        <RequestID>2PQCX3SPZ3QBF</RequestID>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

PUT https://api.newegg.com/marketplace/b2b/shippingservice/shippinglabel/packagelist?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OperationType": "GetPackageListRequest",
    "RequestBody": {
        "RequestID": "2PQCX3SPZ3QBF"
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: GetPackageListResponse
SellerID String Your seller ID
OrderNumber Integer Related order number
RequestID String Request identifier of a submission
File String The PDF document URL for package list

Schema: GetPackageListResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetPackageListResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <OrderNumber>423423678</OrderNumber>
        <RequestList>
            <Request>
                <RequestID>2PQBYWH4V68ZP</RequestID>
                <PdfFileList>
                    <File>http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf</File>
                    <File>http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf</File>
                </PdfFileList>
            </Request>
            <Request>
                <RequestID>2PQBYWH4V68ZP</RequestID>
                <PdfFileList>
                    <File>http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf</File>
                    <File>http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf</File>
                </PdfFileList>
            </Request>
        </RequestList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "GetPackageListResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "OrderNumber": "423423678",
        "RequestList": {
            "Request": [
                {
                    "RequestID": "2PQBYWH4V68ZP",
                    "PdfFileList": {
                        "File": [
                            "http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf",
                            "http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf"
                        ]
                    }
                },
                {
                    "RequestID": "2PQBYWH4V68ZP",
                    "PdfFileList": {
                        "File": [
                            "http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf",
                            "http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf"
                        ]
                    }
                }
            ]
        }
    }
}

Request Failure Errors

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

Error Code Description
SL018 Invalid request. OrderNumber or RequestId is required.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SL018</Code>
        <Message>Invalid request. OrderNumber or RequestId is required.</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "SL018",
    "Message": "Invalid request. OrderNumber or RequestId is required."
}

Last updated: October 15, 2018