Shipping Label Request for Newegg Orders

Confirm/ship orders using Newegg Shipping Label Services.

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

Resource URL

Newegg.com: https://api.newegg.com/marketplace/shippingservice/shippinglabel/createshippinglabel?sellerid={sellerid} 
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/shippingservice/shippinglabel/createshippinglabel?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/shippingservice/shippinglabel/createshippinglabel?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
OperationType Yes String Fixed value: CreateShippingLabel
SellerID Yes String Your seller ID
OrderNumber Yes Integer Order number
ShippingCarrierCode Yes Integer Available shipping carrier code:

100 – Newegg Partnered Carrier (UPS)

ShippingServiceCode No Integer Available shipping service code:

For Newegg.com, Neweggbusiness.com:

ShippingCarrierCode = 100:

101 – UPS Ground
102 – UPS 3 Day Select
103 – UPS 2nd Day Air
104 – UPS Next Day Air Saver
105 – UPS Next Day Air*

For Newegg.ca:

ShippingCarrierCode = 100:

111 – UPS Standard
112 – UPS Express
113 – UPS Expedited
114 – UPS Express Saver*

Note: if left this blank, a default shipping service will be assigned according to the shipping service that the customer purchased on order. Default shipping service mapping:

If ShippingCarrierCode = 100:

For Newegg.com, Neweggbusiness.com:

Newegg Order Shipping Method Default Mapped Service
Standard Shipping(5-7 business days) UPS Ground
Expedited Shipping(3-5 business days) UPS 3 Day Select
Two-Day Shipping UPS 2nd Day Air
One-Day Shipping UPS Next Day Air Saver

For Newegg.ca:

Newegg Order Shipping Method Default Mapped Service
Standard Shipping(5-7 business days) UPS Standard
Expedited Shipping(3-5 business days) UPS Standard
Two-Day Shipping UPS Expedited
One-Day Shipping UPS Express Saver

* Optional carrier service

ShipFromFirstName Yes String Contact person – first name
ShipFromLastName Yes String Contact person – last name
ShipFromPhoneNumber Yes String Contact person – contact phone number
ShipFromAddress1 Yes String Ship from address

Shipping cost is calculated based on Ship from address. Please fill in the correct information.

ShipFromAddress2 No String Ship from address 2nd line if any

Shipping cost is calculated based on Ship from address. Please fill in the correct information.

ShipFromCityName Yes String Ship from city

Shipping cost is calculated based on Ship from address. Please fill in the correct information.

ShipFromStateCode 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.

ShpFromZipCode 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.

ShipFromCountryCode Yes String Ship from country code in 3-digit format

  • Newegg.com, Neweggbuseinss.com: USA
  • Newegg.ca: CAN
PackageWeight Yes Decimal Package weight

PackageLength Yes Decimal Package length

PackageHeight Yes Decimal Package height

PackageWidth Yes Decimal Package width

SignatureOptions No String Options:

  • Regular: The shipping carrier will obtain the recipient’s signature on delivery.
  • No value indicate no delivery signature is required.
SellerPartNumber Yes String Seller Part#
Quantity Yes Integer Item quantity

Schema: ShippingNewLabelSubmitRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>CreateShippingLabel</OperationType>
    <SellerID>A006</SellerID>
    <RequestBody>
        <Shipment>
            <OrderNumber>2135751360</OrderNumber>
            <ShippingCarrierCode>100</ShippingCarrierCode>
            <ShippingServiceCode>101</ShippingServiceCode>
            <ShipFromFirstName>John</ShipFromFirstName>
            <ShipFromLastName>Doe</ShipFromLastName>
            <ShipFromPhoneNumber>6266171420</ShipFromPhoneNumber>
            <ShipFromAddress1>18045 Rowland Street</ShipFromAddress1>
            <ShipFromAddress2/>
            <ShipFromCityName>City Of Industry</ShipFromCityName>
            <ShipFromStateCode>CA</ShipFromStateCode>
            <ShipFromZipCode>91748</ShipFromZipCode>
            <ShipFromCountryCode>USA</ShipFromCountryCode>
            <PackageList>
                <Package>
                    <PackageWeight>5</PackageWeight>
                    <PackageLength>5.00</PackageLength>
                    <PackageHeight>4.00</PackageHeight>
                    <PackageWidth>3.00</PackageWidth>
                    <SignatureOptions>Regular</SignatureOptions>
                    <ItemList>
                        <Item>
                            <SellerPartNumber>201307220000101</SellerPartNumber>
                            <Quantity>4</Quantity>
                        </Item>
                        <Item>
                            <SellerPartNumber>SARATEST0118</SellerPartNumber>
                            <Quantity>1</Quantity>
                        </Item>
                    </ItemList>
                </Package>
                <Package>
                    <PackageWeight>1.5</PackageWeight>
                    <PackageLength>2.00</PackageLength>
                    <PackageHeight>3.00</PackageHeight>
                    <PackageWidth>4.00</PackageWidth>
                    <ItemList>
                        <Item>
                            <SellerPartNumber>201307220000102</SellerPartNumber>
                            <Quantity>3</Quantity>
                        </Item>
                    </ItemList>
                </Package>
            </PackageList>
        </Shipment>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
  "NeweggAPIRequest": {
    "OperationType": "CreateShippingLabel",
    "SellerID": "A006",
    "RequestBody": {
      "Shipment": {
        "OrderNumber": "2135751360",
        "ShippingCarrierCode": "100",
        "ShippingServiceCode": "101",
        "ShipFromFirstName": "John",
        "ShipFromLastName": "Doe",
        "ShipFromPhoneNumber": "6266171420",
        "ShipFromAddress1": "18045 Rowland Street",
        "ShipFromCityName": "City Of Industry",
        "ShipFromStateCode": "CA",
        "ShipFromZipCode": "91748",
        "ShipFromCountryCode": "USA",
        "PackageList": {
          "Package": [
            {
              "PackageWeight": "5",
              "PackageLength": "5.00",
              "PackageHeight": "4.00",
              "PackageWidth": "3.00",
              "SignatureOptions": "Regular",
              "ItemList": {
                "Item": [
                  {
                    "SellerPartNumber": "201307220000101",
                    "Quantity": "4"
                  },
                  {
                    "SellerPartNumber": "SARATEST0118",
                    "Quantity": "1"
                  }
                ]
              }
            },
            {
              "PackageWeight": "1.5",
              "PackageLength": "2.00",
              "PackageHeight": "3.00",
              "PackageWidth": "4.00",
              "ItemList": {
                "Item": {
                  "SellerPartNumber": "201307220000102",
                  "Quantity": "3"
                }
              }
            }
          ]
        }
      }
    }
  }
}

Response Body

Attribute Format Description
IsSuccess String Get the feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: CreateShippingLabelResponse
SellerID String Your seller ID
OrderNumber Integer The order number for the operation
ShipDate String Date when the shipping request confirmed (Pacific Standard Time)
TrackingNumber String Tracking number for the shipped package
ProcessResult String The request failed or successfully processed.
ErrorMessage String A detailed error of failed process.
SignatureOptions String
  • Regular: The shipping carrier will obtain the recipient’s signature on delivery.
  • Blank: No delivery signature required.
LabelUrl String Link to download the shipping label
PackageListUrl String Link to download the package list
ShipWeight Decimal Weight of package
ArriveBy String Date Newegg partnered carrier will deliver the shipment.
ShippingAmount Decimal Amount Newegg partnered carrier will charge for the shipment.
SignatureOptions Decimal Amount Newegg partnered carrier will charge for a required signature.
Total Decimal Total amount Newegg partnered carrier will charge.  ShippingAmount + SignatureOptions
SellerPartNumber String Seller Part# of the item
Quantity Integer Shipped quantity of the item

Schema: ShippingNewLabelSubmitResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>CreateShippingLabelResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <Shipment>
            <OrderNumber>2135751360</OrderNumber>
            <ShipDate>12/25/2015</ShipDate>
            <PackageList>
                <Package>
                    <TrackingNumber>1Z8V016A0377769652</TrackingNumber>
                    <ProcessResult>Success</ProcessResult>
                    <ErrorMessage/>
                    <SignatureOptions>Regular</SignatureOptions>
                    <LabelUrl>http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf</LabelUrl>
                    <PackingListUrl>http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf</PackingListUrl>
                    <Rate>
                        <ShipWeight>6.5</ShipWeight>
                        <ArriveBy>12/29/2015</ArriveBy>
                        <ShippingAmount>21.94</ShippingAmount>
                        <SignatureOptions>4.25</SignatureOptions>
                        <Total>26.19</Total>
                    </Rate>
                    <ItemList>
                        <Item>
                            <SellerPartNumber>201307220000101</SellerPartNumber>
                            <Quantity>4</Quantity>
                        </Item>
                        <Item>
                            <SellerPartNumber>SARATEST0118</SellerPartNumber>
                            <Quantity>1</Quantity>
                        </Item>
                    </ItemList>
                </Package>
            </PackageList>
        </Shipment>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
  "NeweggAPIResponse": {
    "IsSuccess": "true",
    "OperationType": "CreateShippingLabelResponse",
    "SellerID": "A006",
    "ResponseBody": {
      "Shipment": {
        "OrderNumber": "2135751360",
        "ShipDate": "12/25/2015",
        "PackageList": {
          "Package": {
            "TrackingNumber": "1Z8V016A0377769652",
            "ProcessResult": "Success",
            "SignatureOptions": "Regular",
            "LabelUrl": "http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf",
            "PackingListUrl": "http://images10.newegg.com/SBNInbound/UPSShippingLabel/dc395051-a1ba-4c7e-99c9-94025bc7577e.pdf",
            "Rate": {
              "ShipWeight": "6.5",
              "ArriveBy": "12/29/2015",
              "ShippingAmount": "21.94",
              "SignatureOptions": "4.25",
              "Total": "26.19"
            },
            "ItemList": {
              "Item": [
                {
                  "SellerPartNumber": "201307220000101",
                  "Quantity": "4"
                },
                {
                  "SellerPartNumber": "SARATEST0118",
                  "Quantity": "1"
                }
              ]
            }
          }
        }
      }
    }
  }
}

Request Failure Errors

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

Error Code Description
SL001 Your request cannot be processed. The tem(s):{0} in order: [Order #] has been shipped or voided.
SL002 No data found or this order does not belong to this seller.
SL003 Only unshipped orders can submit a shipping request. The order status is currently {order status}.
SL004 Only shipped by seller orders can submit a shipping request.
SL005 Seller Part #: {sellerpart#} must be shipped for its entire quantity on the order.
SL006 The field: [PackageWeight or PackageLength or PackageHeight or PackageWidth] is required when using Newegg Partnered Carrier service (ShippingCarrierCode: 100).For more detail, please review Newegg API Development Guide.
SL007 The value in the field: PackageWeight cannot exceed {Maximum package weight limit by Newegg Partnered Carrier} lbs. ({Maximum package weight limit by Newegg Partnered Carrier}kg) when using Newegg Partnered Carrier service (ShippingCarrierCode: {ShippingCarrierCode}). For more detail, please review Newegg API Development Guide.
SL008 The value in the field: PackageLength cannot exceed {Maximum package length limit by Newegg Partnered Carrier} inches ({Maximum package length limit by Newegg Partnered Carrier} cm) when using Newegg Partnered Carrier service (ShippingCarrierCode: {ShippingCarrierCode}). For more detail, please review Newegg API Development Guide.
SL009 Package size cannot exceed {Maximum package cubic size limit by Newegg Partnered Carrier}inches ({Maximum package cubic size limit by Newegg Partnered Carrier} cm) in (Package Length + 2x Package Width + 2x Package Height) when using Newegg Partnered Carrier service (ShippingCarrierCode: {ShippingCarrierCode}). For more detail, please review Newegg API Development Guide.
SL010 Cannot submit the request because seller part number(s):{sellerpart#} does NOT belong to this order.
SL015 Cannot submit the request because currently only supports USA domestic transportation.Please revise the Ship From or Ship To information and try again.
SL027 Invalid request. You are not able to use Newegg Shipping Label Service before sign up. Please visit Newegg Seller Portal > Add-on Services > Newegg Shipping Label Service to sign up.
SL030 Invalid request. The ShippingServiceCode :{ shipping service code} you specified is not a recognized value for ShippingCarrierCode :{ shipping carrier code}. Please review Newegg API Development Guide or schema for correct information.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SL001</Code>
        <Message>Order Number should be an integer (ranging from 1 to 2147483647)</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "SL001",
        "Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
    }
]

Last updated: January 13, 2020