Multi-Channel Shipping Label Request

Create a Newegg Shipping Label for other sales channels.

Note: To enable this service please go to Newegg Seller Portal > SBN/Logistics > Enroll Newegg Shipping Label Service.

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?sellerid={sellerid} 
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/shipping-label?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 requests per hour

Request Body

Attribute	Required?	Format	Description
OrderNumber	Yes	String	Order number form your sales channel
ShippingMethod	Yes	String	Available shipping service code: For Newegg.com, Neweggbusiness.com: UPS Next Day Air UPS Next Day Air Saver UPS 2nd Day UPS 3 Days Select UPS Ground
ContainsHazardousMaterials	No	Boolean	Hazardous materials packages must be identified. Default value: false。
CheckAddressType	No	Boolean	The Address Type of your package recipient address (R – Residential, C – Commercial) Default value: true。
ShipFromInformation	Yes	Object	Ship From address information. This address is mainly used to calculate shipping costs.
Name	Yes	String	Contact person name
Company	No	String	Company name is applicable
PhoneNumber	Yes	String	contact phone number
Address1	Yes	String	Ship from address Shipping cost is calculated based on Ship from address. Please fill in the correct information.
Address2	No	String	Ship from address 2nd line if any Shipping cost is calculated based on Ship from address. Please fill in the correct information.
City	Yes	String	Ship from city Shipping cost is calculated based on Ship from address. Please fill in the correct information.
StateOrProvince	Yes	String	Ship from state, such as CA, FL, etc. Shipping cost is calculated based on Ship from address. Please fill in the correct information.
PostalCode	Yes	String	Ship from zipcode, such as 91748, 91773, etc. Shipping cost is calculated based on Ship from address. Please fill in the correct information.
Country	Yes	String	Ship from country code in 3-digit format Newegg.com, Neweggbuseinss.com: USA
ShipToInformation	Yes	Object	Recipient address information
Name	Yes	String	Contact person name
Company	No	String	Company name is applicable
PhoneNumber	Yes	String	contact phone number
Address1	Yes	String	Ship to address
Address2	No	String	Ship to address 2nd line if any
City	Yes	String	Ship to city
StateOrProvince	Yes	String	Ship to state, such as CA, FL, etc.
PostalCode	Yes	String	Ship to zipcode, such as 91748, 91773, etc.
Country	Yes	String	Ship to country code in 3-digit format Newegg.com, Neweggbuseinss.com: USA
ShipmentInformationList	Yes	Object	Package Information Please add multiple nodes if your order contains multiple packages in different weights or sizes.
SignatureRequired	No	Boolean	Options: True: The shipping carrier will obtain the recipient’s signature on delivery. False: indicate no delivery signature is required.
Length	Yes	Decimal	Package length Default unit: inch See Newegg Partnered Carrier (UPS) page for more details about Shipments Weight and Size Limitations.
Width	Yes	Decimal	Package width Default unit: inch See Newegg Partnered Carrier (UPS) page for more details about Shipments Weight and Size Limitations.
Height	Yes	Decimal	Package height Default unit: inch See Newegg Partnered Carrier (UPS) page for more details about Shipments Weight and Size Limitations.
Weight	Yes	Decimal	Package weight Default unit: lb See Newegg Partnered Carrier (UPS) page for more details about Shipments Weight and Size Limitations.
LabelQuantity	No	Integer	The number of label to be generated. The default value is 1.

Schema: ShippingLabelRequest.xsd

Example: XML, Request

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

<ShippingLabelRequest
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <OrderNumber>TEST200227-MKPL-001</OrderNumber>
    <ShippingMethod>UPS Ground</ShippingMethod>
    <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
    <CheckAddressType>true</CheckAddressType>
    <ShipFromInformation>
        <Name>Newegg 3PL</Name>
        <Company>Newegg Inc.</Company>
        <PhoneNumber>400-000-0001</PhoneNumber>
        <Address1>17708 Rowland St.</Address1>
        <Address2></Address2>
        <City>City of Industry</City>
        <StateOrProvince>CA</StateOrProvince>
        <PostalCode>91748</PostalCode>
        <Country>USA</Country>
    </ShipFromInformation>
    <ShipToInformation>
        <Name>Test Customer</Name>
        <PhoneNumber>401-000-0001</PhoneNumber>
        <Address1>50081 NW 82nd Ave</Address1>
        <City>Doral</City>
        <StateOrProvince>FL</StateOrProvince>
        <PostalCode>33122-1041</PostalCode>
        <Country>USA</Country>
    </ShipToInformation>
    <ShipmentInformationList>
        <ShipmentInformation>
            <SignatureRequired>false</SignatureRequired>
            <Length>3</Length>
            <Width>2</Width>
            <Height>1</Height>
            <Weight>1.2</Weight>
            <LabelQuantity>2</LabelQuantity>
        </ShipmentInformation>
        <ShipmentInformation>
            <SignatureRequired>true</SignatureRequired>
            <Length>1.5</Length>
            <Width>1</Width>
            <Height>0.8</Height>
            <Weight>0.85</Weight>
        </ShipmentInformation>
    </ShipmentInformationList>
</ShippingLabelRequest>

Example: Json, Request

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

{
    "OrderNumber": "TEST200227-MKPL-001",
    "ShippingMethod": "UPS Ground",
    "ContainsHazardousMaterials": false,
    "CheckAddressType": true,
    "ShipFromInformation": {
        "Name": "Newegg 3PL",
        "Company": "Newegg Inc.",
        "PhoneNumber": "400-000-0001",
        "Address1": "17708 Rowland St.",
        "Address2": "",
        "City": "City of Industry",
        "StateOrProvince": "CA",
        "PostalCode": "91748",
        "Country": "USA"
    },
    "ShipToInformation": {
        "Name": "Test Customer",
        "PhoneNumber": "401-000-0001",
        "Address1": "50081 NW 82nd Ave",
        "City": "Doral",
        "StateOrProvince": "FL",
        "PostalCode": "33122-1041",
        "Country": "USA"
    },
    "ShipmentInformationList": [
        {
            "SignatureRequired": false,
            "Length": 3,
            "Width": 2,
            "Height": 1,
            "Weight": 1.2,
            "LabelQuantity": 2
        },
        {
            "SignatureRequired": true,
            "Length": 1.5,
            "Width": 1,
            "Height": 0.8,
            "Weight": 0.85
        }
    ]
}

Response Body

Attribute	Format	Description
SellerID	String	Seller ID with Newegg Marketplace
OrderNumber	String	Order number specified form your sales channel
Labels	Object	Generated Label List
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
AddressType	String	The Address Type of your package recipient address C – Commercial address R – Residential Address
SignatureRequired	Boolean	Selected SignatureRequired option
ContainsHazardousMaterials	Boolean	Identified hazardous materials package value.
DownloadUrl	String	The download address of the PDF file corresponding to the Label.
Length	Decimal	Specified package length
Width	Decimal	Specified package width
Height	Decimal	Specified package height
Weight	Decimal	Specified package weight
ShippingTotal	Decimal	Amount will be charged for current shipment.
CurrencyCode	String	The currency for USA is USD
CreateTime	String	Label creation time
Succeeded	Boolean	If the label request was failed, ErrorMessage will contain exception information.
Code	String	Error code
StatusCode	String	Status code OK – 200 BadRequest – 400 Unauthorized – 401 Forbidden – 403 RequestTimeout – 408 Conflict – 409 InternalServerError – 500 ServiceUnavailable – 503 GatewayTimeout – 504
Message	String	Exception information
ValidationErrors	Object	When the data validation failed, the detailed reason will be available.
PropertyName	String	Attribute name
ErrorMessage	String	Error information

Schema: ShippingLabelResponse.xsd

Example: XML, Response

<ShippingLabelResponse>
    <SellerID>AEM7</SellerID>
    <OrderNumber>TEST200227-MKPL-001</OrderNumber>
    <Labels>
        <Label>
            <PackageSerialNumber>1</PackageSerialNumber>
            <TrackingNumber>1ZA813770370283064</TrackingNumber>
            <ShippingMethod>UPS Ground</ShippingMethod>
            <DownloadUrl>https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813770370283064.pdf</DownloadUrl>
            <SignatureRequired>false</SignatureRequired>
            <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
            <Length>3</Length>
            <Width>2</Width>
            <Height>1</Height>
            <Weight>1.2</Weight>
            <ShippingTotal>6.5</ShippingTotal>
            <CurrencyCode>USD</CurrencyCode>
            <CreateTime>2020-02-27T02:31:10.959</CreateTime>
        </Label>
        <Label>
            <PackageSerialNumber>2</PackageSerialNumber>
            <TrackingNumber>1ZA813770370283082</TrackingNumber>
            <ShippingMethod>UPS Ground</ShippingMethod>
            <DownloadUrl>https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813770370283082.pdf</DownloadUrl>
            <SignatureRequired>false</SignatureRequired>
            <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
            <Length>3</Length>
            <Width>2</Width>
            <Height>1</Height>
            <Weight>1.2</Weight>
            <ShippingTotal>6.5</ShippingTotal>
            <CurrencyCode>USD</CurrencyCode>
            <CreateTime>2020-02-27T02:31:10.971</CreateTime>
        </Label>
        <Label>
            <PackageSerialNumber>3</PackageSerialNumber>
            <TrackingNumber>1ZA813774270283071</TrackingNumber>
            <ShippingMethod>UPS Ground</ShippingMethod>
            <DownloadUrl>https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813774270283071.pdf</DownloadUrl>
            <SignatureRequired>true</SignatureRequired>
            <ContainsHazardousMaterials>false</ContainsHazardousMaterials>
            <Length>1.5</Length>
            <Width>1</Width>
            <Height>0.8</Height>
            <Weight>0.85</Weight>
            <ShippingTotal>10.49</ShippingTotal>
            <CurrencyCode>USD</CurrencyCode>
            <CreateTime>2020-02-27T02:31:10.971</CreateTime>
        </Label>
    </Labels>
    <Succeeded>true</Succeeded>
</ShippingLabelResponse>

Example: Json, Response

{
    "SellerID": "AEM7",
    "OrderNumber": "TEST200227-MKPL-001",
    "Labels": [
        {
            "PackageSerialNumber": 1,
            "TrackingNumber": "1ZA813770370283064",
            "ShippingMethod": "UPS Ground",
            "DownloadUrl": "https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813770370283064.pdf",
            "SignatureRequired": false,
            "ContainsHazardousMaterials": false,
            "Length": 3,
            "Width": 2,
            "Height": 1,
            "Weight": 1.2,
            "ShippingTotal": 6.5,
            "CurrencyCode": "USD",
            "CreateTime": "2020-02-27T02:31:10.959"
        },
        {
            "PackageSerialNumber": 2,
            "TrackingNumber": "1ZA813770370283082",
            "ShippingMethod": "UPS Ground",
            "DownloadUrl": "https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813770370283082.pdf",
            "SignatureRequired": false,
            "ContainsHazardousMaterials": false,
            "Length": 3,
            "Width": 2,
            "Height": 1,
            "Weight": 1.2,
            "ShippingTotal": 6.5,
            "CurrencyCode": "USD",
            "CreateTime": "2020-02-27T02:31:10.971"
        },
        {
            "PackageSerialNumber": 3,
            "TrackingNumber": "1ZA813774270283071",
            "ShippingMethod": "UPS Ground",
            "DownloadUrl": "https://images10.newegg.com/Shipping/CrossDocking/MKPL/1ZA813774270283071.pdf",
            "SignatureRequired": true,
            "ContainsHazardousMaterials": false,
            "Length": 1.5,
            "Width": 1,
            "Height": 0.8,
            "Weight": 0.85,
            "ShippingTotal": 10.49,
            "CurrencyCode": "USD",
            "CreateTime": "2020-02-27T02:31:10.971"
        }
    ],
    "Succeeded": true
}

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: March 15, 2021