Shipping Label Request for Newegg Orders

Confirm/ship orders using Newegg Shipping Label Services.

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

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

Resource Information

Request Body

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

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.

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