Multi-Channel Shipping Label Reprint Request

Reprint Newegg Shipping Labels for successful multi-channel shipping label requests.

Please note: In order to start processing orders with Newegg Shipping Label service, please enroll the program at https://sellerportal.newegg.com/add-on-services/enrollneweggshippinglabelservice

All Multi-Channel label API requests are based on HTTPS (TLS 1.2). Please make sure to enable version support for the corresponding requests or API requests may fail to connect Newegg API.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/shipping-label/query?sellerid={sellerid} 
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/shipping-label/query?sellerid={sellerid}  
Newegg.ca: https://api.newegg.com/marketplace/can/shipping-label/query?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?
POST Required XML, Json XML, Json 1000 request per hour

Request Body

Attribute Required? Format Description
OrderNumber No String Previous requested order number
TrackingNumber No String The tracking number associated with previous requested package
LabelCreatedFrom No DateTime Search by label creation time, starting from
LabelCreatedTo No DateTime Search by label creation time, end to
PageSize No Integer Search page size, default: 10
PageIndex No Integer Page index, 0 means first page, default value: 0

Schema: ShippingLabelQueryRequest.xsd

Example: XML, Request

POST https://api.newegg.com/marketplace/shipping-label/query?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/xml
Accept: application/xml

<ShippingLabelQueryRequest
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <OrderNumber />
    <TrackingNumber />
    <LabelCreatedFrom>2020-02-24T22:00:00</LabelCreatedFrom>
    <LabelCreatedTo>2020-02-25T00:00:00</LabelCreatedTo>
    <PageSize>10</PageSize>
    <PageIndex>0</PageIndex>
</ShippingLabelQueryRequest>

Example: Json, Request

POST https://api.newegg.com/marketplace/shipping-label/query?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
    "OrderNumber": null,
    "TrackingNumber": null,
    "LabelCreatedFrom": "2020-02-24T22:00:00",
    "LabelCreatedTo": "2020-02-25T00:00:00",
    "PageSize": 10,
    "PageIndex": 0
}

Response Body

Attribute Format Description
TotalCount Integer Number of Order that meet the search conditions
Count Integer The number of Order contained in the current page
TotalPageCount Integer total pages
PageSize Integer Total page size specified in the request
PageIndex Integer Page index
NextPageIndex Integer Next Page Index
Results Object Matched results
OrderNumber String Order number specified form your sales channel
AddressType String The Address Type of your package recipient address (R – Residential, C – Commercial)

Default value: true。
CreateTime DateTime Label creation time
ShipFromInformation Object Ship From address information.
Name String Contact person name
Company String Company name is applicable
PhoneNumber String contact phone number
Address1 String Ship from address
Address2 String Ship from address 2nd line if any
City String Ship from city
StateOrProvince String Ship from state
PostalCode String Ship from zipcode
Country String Ship from country code in 3-digit format

  • Newegg.com, Neweggbuseinss.com: USA
  • Newegg.ca: CAN
ShipToInformation Object Recipient address information
Name String Contact person name
Company String Company name is applicable
PhoneNumber String contact phone number
Address1 String Ship to address
Address2 String Ship to address 2nd line if any
City String Ship to city
StateOrProvince String Ship to state, such as CA, FL, etc.
PostalCode String Ship to zipcode, such as 91748, 91773, etc.
Country String Ship to country code in 3-digit format

  • Newegg.com, Neweggbuseinss.com: USA
  • Newegg.ca: CAN
Labels Object All Label information generated in this order
PackageSerialNumber Integer Package serial number, automatically generated by Newegg system
TrackingNumber String Tracking number for your package
ShippingMethod String The corresponding shipping method of requested label
DownloadUrl String Type of package recipient address

  • C – Commercial address
  • R – Residential Address
SignatureRequired Boolean Selected SignatureRequired option
ContainsHazardousMaterials Boolean Identified hazardous materials package value.
Length Decimal The download address of the PDF file corresponding to the Label.
Width Decimal Specified package length
Height Decimal Specified package width
Weight Decimal Specified package height
ShippingTotal Decimal Specified package weight
CurrencyCode String The currency for USA is USD

Canadian currency is CAD
CreateTime DateTime Label creation time

Schema: ShippingLabelQueryResponse.xsd

Example: XML, Response

<ShippingLabelQueryResponse>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
    <TotalCount>2</TotalCount>
    <Count>2</Count>
    <TotalPageCount>1</TotalPageCount>
    <Results>
        <Order>
            <SellerID>AEM7</SellerID>
            <OrderNumber>TEST200225-MKPL-019</OrderNumber>
            <AddressType>C</AddressType>
            <CreateTime>2020-02-24T22:28:32.1323188-08:00</CreateTime>
            <ShipToInformation>
                <Name>SHAO YONG</Name>
                <PhoneNumber>400-101-0000</PhoneNumber>
                <Address1>50008 NW Fake Ave</Address1>
                <City>Doral</City>
                <StateOrProvince>FL</StateOrProvince>
                <PostalCode>33122-1041</PostalCode>
                <Country>USA</Country>
            </ShipToInformation>
            <ShipFromInformation>
                <Name>Newegg 3PL</Name>
                <PhoneNumber>000-000-000</PhoneNumber>
                <Address1>17708 Rowland St.</Address1>
                <Address2 />
                <City>City of Industry</City>
                <StateOrProvince>CA</StateOrProvince>
                <PostalCode>91748</PostalCode>
                <Country>USA</Country>
            </ShipFromInformation>
            <Labels>
                <Label>
                    <PackageSerialNumber>1</PackageSerialNumber>
                    <TrackingNumber>1ZA813771270270891</TrackingNumber>
                    <ShippingMethod>UPS 3 Days Select</ShippingMethod>
                    <DownloadUrl>https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813771270270891.pdf</DownloadUrl>
                    <SignatureRequired>false</SignatureRequired>
                    <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
                    <Length>1.1</Length>
                    <Width>0.9</Width>
                    <Height>0.6</Height>
                    <Weight>0.75</Weight>
                    <ShippingTotal>8.36</ShippingTotal>
                    <CurrencyCode>USD</CurrencyCode>
                    <CreateTime>2020-02-24T22:28:32.1323188-08:00</CreateTime>
                </Label>
                <Label>
                    <PackageSerialNumber>2</PackageSerialNumber>
                    <TrackingNumber>1ZA813771270270908</TrackingNumber>
                    <ShippingMethod>UPS 3 Days Select</ShippingMethod>
                    <DownloadUrl>https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813771270270908.pdf</DownloadUrl>
                    <SignatureRequired>false</SignatureRequired>
                    <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
                    <Length>1.1</Length>
                    <Width>0.9</Width>
                    <Height>0.6</Height>
                    <Weight>0.75</Weight>
                    <ShippingTotal>8.36</ShippingTotal>
                    <CurrencyCode>USD</CurrencyCode>
                    <CreateTime>2020-02-24T22:28:32.1323188-08:00</CreateTime>
                </Label>
            </Labels>
        </Order>
        <Order>
            <SellerID>AEM7</SellerID>
            <OrderNumber>TEST200225-MKPL-018</OrderNumber>
            <AddressType>C</AddressType>
            <CreateTime>2020-02-24T22:27:09.9831047-08:00</CreateTime>
            <ShipToInformation>
                <Name>SHAO YONG</Name>
                <PhoneNumber>400-101-0000</PhoneNumber>
                <Address1>50002 NW Fake Ave</Address1>
                <City>Doral</City>
                <StateOrProvince>FL</StateOrProvince>
                <PostalCode>33122-1041</PostalCode>
                <Country>USA</Country>
            </ShipToInformation>
            <ShipFromInformation>
                <Name>Newegg 3PL</Name>
                <PhoneNumber>000-000-000</PhoneNumber>
                <Address1>17708 Rowland St.</Address1>
                <Address2 />
                <City>City of Industry</City>
                <StateOrProvince>CA</StateOrProvince>
                <PostalCode>91748</PostalCode>
                <Country>USA</Country>
            </ShipFromInformation>
            <Labels>
                <Label>
                    <PackageSerialNumber>1</PackageSerialNumber>
                    <TrackingNumber>1ZA813770370270881</TrackingNumber>
                    <ShippingMethod>UPS Ground</ShippingMethod>
                    <DownloadUrl>https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813770370270881.pdf</DownloadUrl>
                    <SignatureRequired>false</SignatureRequired>
                    <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
                    <Length>3</Length>
                    <Width>2</Width>
                    <Height>1</Height>
                    <Weight>1.2</Weight>
                    <ShippingTotal>6.50</ShippingTotal>
                    <CurrencyCode>USD</CurrencyCode>
                    <CreateTime>2020-02-24T22:27:09.9831047-08:00</CreateTime>
                </Label>
            </Labels>
        </Order>
    </Results>
</ShippingLabelQueryResponse>

Example: Json, Response

{
    "PageIndex": 0,
    "PageSize": 10,
    "TotalCount": 2,
    "Count": 2,
    "TotalPageCount": 1,
    "Results": [
        {
            "SellerID": "AEM7",
            "OrderNumber": "TEST200225-MKPL-019",
            "AddressType": "C",
            "CreateTime": "2020-02-24T22:28:32.132",
            "ShipToInformation": {
                "Name": "SHAO YONG",
                "PhoneNumber": "400-101-0000",
                "Address1": "50008 NW Fake Ave",
                "City": "Doral",
                "StateOrProvince": "FL",
                "PostalCode": "33122-1041",
                "Country": "USA"
            },
            "ShipFromInformation": {
                "Name": "Newegg 3PL",
                "PhoneNumber": "000-000-000",
                "Address1": "17708 Rowland St.",
                "Address2": "",
                "City": "City of Industry",
                "StateOrProvince": "CA",
                "PostalCode": "91748",
                "Country": "USA"
            },
            "Labels": [
                {
                    "PackageSerialNumber": 1,
                    "TrackingNumber": "1ZA813771270270891",
                    "ShippingMethod": "UPS 3 Days Select",
                    "DownloadUrl": "https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813771270270891.pdf",
                    "SignatureRequired": false,
                    "ContainsHazardousMaterials": false,
                    "Length": 1.1,
                    "Width": 0.9,
                    "Height": 0.6,
                    "Weight": 0.75,
                    "ShippingTotal": 8.36,
                    "CurrencyCode": "USD",
                    "CreateTime": "2020-02-24T22:28:32.132"
                },
                {
                    "PackageSerialNumber": 2,
                    "TrackingNumber": "1ZA813771270270908",
                    "ShippingMethod": "UPS 3 Days Select",
                    "DownloadUrl": "https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813771270270908.pdf",
                    "SignatureRequired": false,
                    "ContainsHazardousMaterials": false,
                    "Length": 1.1,
                    "Width": 0.9,
                    "Height": 0.6,
                    "Weight": 0.75,
                    "ShippingTotal": 8.36,
                    "CurrencyCode": "USD",
                    "CreateTime": "2020-02-24T22:28:32.132"
                }
            ]
        },
        {
            "SellerID": "AEM7",
            "OrderNumber": "TEST200225-MKPL-018",
            "AddressType": "C",
            "CreateTime": "2020-02-24T22:27:09.983",
            "ShipToInformation": {
                "Name": "SHAO YONG",
                "PhoneNumber": "400-101-0000",
                "Address1": "50002 NW Fake Ave",
                "City": "Doral",
                "StateOrProvince": "FL",
                "PostalCode": "33122-1041",
                "Country": "USA"
            },
            "ShipFromInformation": {
                "Name": "Newegg 3PL",
                "PhoneNumber": "000-000-000",
                "Address1": "17708 Rowland St.",
                "Address2": "",
                "City": "City of Industry",
                "StateOrProvince": "CA",
                "PostalCode": "91748",
                "Country": "USA"
            },
            "Labels": [
                {
                    "PackageSerialNumber": 1,
                    "TrackingNumber": "1ZA813770370270881",
                    "ShippingMethod": "UPS Ground",
                    "DownloadUrl": "https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813770370270881.pdf",
                    "SignatureRequired": false,
                    "ContainsHazardousMaterials": false,
                    "Length": 3,
                    "Width": 2,
                    "Height": 1,
                    "Weight": 1.2,
                    "ShippingTotal": 6.5,
                    "CurrencyCode": "USD",
                    "CreateTime": "2020-02-24T22:27:09.983"
                }
            ]
        }
    ]
}

Request Failure Errors

Schema: ErrorResponse.xsd

Bad Request – 400, Validation Failed

Example: XML, Response

<ErrorResponse>
    <Message>Request validation failed.</Message>
    <ValidationErrors>
        <ValidationErrorResponse>
            <PropertyName>ShipToInformation.PhoneNumber</PropertyName>
            <ErrorMessage>'Phone Number' should not be empty.</ErrorMessage>
        </ValidationErrorResponse>
        <ValidationErrorResponse>
            <PropertyName>ShipmentInformationList[0].Length</PropertyName>
            <ErrorMessage>'Length' must be between 0.01 and 999.99. You entered 1000.</ErrorMessage>
        </ValidationErrorResponse>
    </ValidationErrors>
    <StatusCode>BadRequest</StatusCode>
    <Succeeded>false</Succeeded>
    <Code>ValidationErrors</Code>
</ErrorResponse>

Example: Json, Response

[
    {
        "Succeeded": false,
        "Code": "ValidationErrors",
        "Message": "Request validation failed.",
        "ValidationErrors": [
            {
                "PropertyName": "ShipToInformation.PhoneNumber",
                "ErrorMessage": "'Phone Number' should not be empty."
            },
            {
                "PropertyName": "ShipmentInformationList[0].Length",
                "ErrorMessage": "'Length' must be between 0.01 and 999.99. You entered 1000."
            }
        ],
        "StatusCode": "BadRequest"
    }
]

Conflict – 409, Processing Failed

Example: XML, Response

<ErrorResponse>
    <Message>Shipping Method: UPS 3 Day Select is not an eligible service.</Message>
    <StatusCode>Conflict</StatusCode>
    <Succeeded>false</Succeeded>
    <Code>Error</Code>
</ErrorResponse>

Example: Json, Response

[
    {
        "Succeeded": false,
        "Code": "Error",
        "Message": "Shipping Method: UPS 3 Day Select is not an eligible service.",
        "StatusCode": "Conflict"
    }
]

 

Last updated: February 28, 2020