Submit Create Inbound Shipment Plan Suggestion

Submit a new inbound shipment request based on the information that was returned by Get Inbound Shipment Plan Suggestion.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sbnmgmt/inboundshipment/shipmentrequest?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/sbnmgmt/inboundshipment/shipmentrequest?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 100 requests per min per client

Request Body

Attribute Required? Format Description
OperationType Yes String Fixed values: SubmitShipmentRequest
ActionCode Yes Integer Action code:

1:Create

ShipFromAddress1 No String Ship from address1, if left blank, system will use seller’s primary address.
ShipFromAddress2 No String Ship from address2, if left blank, system will use seller’s primary address.
ShipFromCity No String Ship from city, if left blank, system will use seller’s primary address.
ShipFromState No String Ship from state, if left blank, system will use seller’s primary address.
ShipFromZipcode No String Ship from zip code, if left blank, system will use seller’s primary address.
ShipFromCountry No String Ship from country code, if left blank, system will use seller’s primary address.
ShipFromPhoneNumber No String Ship from location contact phone number.
ShipToWarehouseCode Yes String Which Newegg warehouse you want to ship to.

Available Newegg warehouse:

06: Tennessee Bulk Warehouse
07: California Small Warehouse
08: California Bulk Item Warehouse
10: New Jersey Bulk Warehouse
14: New Jersey Small Warehouse

ShippingMethodCode Yes Integer Which shipping method you will be using for this shipment?

Available values:
1: Small Parcel Delivery(Individual boxes: consist of units packed in individual boxes and individually labeled for delivery)
2: Less Than Truckload(LTL, Pallets, Shipment at least 150 lbs:shipment combines individual boxes on pallets for delivery)

ShippingCarrierCode Yes Integer Which shipping carrier you will be using for this shipment?

If ShippingMethodCode = 1:

101: DHL
102: FedEx
103: UPS
104: USPS
105: Newegg Partnered Carrier(UPS). For more information, please refer to Newegg Partnered Carrier- UPS
99: Other

If ShippingMethodCode = 2, the only acceptable value is: 99:Other

OtherCarrierName Yes, if ShippingCarrierCode=99 String Provide the shipping carrier name you will be using if ShippingCarrierCode = 99
TrackingNumber No String Tracking number in this shipment
PackageWeight Yes, if ShippingCarrierCode=105 Decimal Package weight, see Shipments Weight and Size Limitations for more details.
PackageLength Yes, if ShippingCarrierCode=105 Decimal Package length, see Shipments Weight and Size Limitations for more details.
PackageHeight Yes, if ShippingCarrierCode=105 Decimal Package length, see Shipments Weight and Size Limitations for more details.
PackageWidth Yes, if ShippingCarrierCode=105 Decimal Package length, see Shipments Weight and Size Limitations for more details.
SellerPartNumber Yes String The item’s seller part number. It will be used to identify the item in Newegg.
Quantity Yes Integer The total quantity of the specified item you want to send to Newegg’s warehouse.
NumberofPackage No Integer Number of package labels, if left blank, system will return 1 package label.
ORM-D No Integer 1: Yes
0: NoIf left blank, will treat it as 0.ORM-D is a marking for mail or shipping in the United States that identifies other regulated materials for domestic transport only. Packages bearing this mark
contain hazardous material in a limited quantity that presents a limited hazard during transportation, due to its form, quantity, and packaging.Please select ORM-D checkbox if applicable. A material safety data sheet must be uploaded for ORMD items.Examples of ORM-D items:

  • Aerosol cans
  • Automotive batteries
  • Perfumes
  • Small arms ammunition
  • Gunpowder (black powder)
  • Some photographic chemicals
  • Lighters
  • Beer
  • Drain openers
MSDSURL Yes if ORM-d=1 String Please specify the local path where the Material Safety Data Sheet file located.

Enter the URL for this product’s Material Safety Data Sheet File. All URLs must be a direct link to the actual file. File must be (pdf, jpg, jpeg, png, doc,docx, xls or xlsx).

  • An alphanumeric string; 2000 characters maximum in length.
  • The maximum file size is 10MB. All files larger than the 10MB limit will fail to process.

Schema: SubmitInboundShipmentRequest_Create.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>SubmitShipmentRequest</OperationType>
    <RequestBody>
        <Shipment>
            <ActionCode>1</ActionCode>
            <ShipFromPhoneNumber>123456789</ShipFromPhoneNumber>
            <ShipToWarehouseCode>08</ShipToWarehouseCode>
            <ShippingMethodCode>1</ShippingMethodCode>
            <ShippingCarrierCode>99</ShippingCarrierCode>
            <OtherCarrierName>newegg</OtherCarrierName>
            <PackageList>
                <Package>
                    <TrackingNumber>SBNAPI-123456789</TrackingNumber>
                    <PackageWeight>10.00</PackageWeight>
                    <PackageLength>8.00</PackageLength>
                    <PackageHeight>7.00</PackageHeight>
                    <PackageWidth>7.00</PackageWidth>
                </Package>
            </PackageList>
            <ItemList>
                <Item>
                    <SellerPartNumber>SS0120130516683100755</SellerPartNumber>
                    <Quantity>4</Quantity>
                    <NumberofPackage>2</NumberofPackage>
                    <ORM-D>1</ORM-D>
                    <MSDSURL>http://tesipaddress/MSDS/testMSDS.pdf</MSDSURL>
                </Item>
            </ItemList>
        </Shipment>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "SubmitShipmentRequest",
    "RequestBody": {
        "Shipment": {
            "ActionCode": 1,
            "ShipFromPhoneNumber": "123456789",
            "ShipFromAddress1": "11708 Rowland St.",
            "ShipFromAddress2": "12708 Rowland St.",
            "ShipFromCity": "NY",
            "ShipFromState": "CA",
            "ShipFromZipcode": "123456",
            "ShipFromCountry": "USA",
            "ShipToWarehouseCode": "14",
            "ShippingMethodCode": 1,
            "ShippingCarrierCode": 105,
            "OtherCarrierName": "SF",
            "PackageList": {
                "Package": [
                    {
                        "TrackingNumber": "123456789",
                        "PackageWeight": 10,
                        "PackageLength": 8,
                        "PackageHeight": 7,
                        "PackageWidth": 6
                    },
                    {
                        "TrackingNumber": "987654321",
                        "PackageWeight": 10,
                        "PackageLength": 8,
                        "PackageHeight": 7,
                        "PackageWidth": 6
                    }
                ]
            },
            "ItemList": {
                "Item": [
                    {
                        "SellerPartNumber": "SS0120130516683100755",
                        "Quantity": 40,
                        "NumberofPackage": 2,
                        "ORM-D": 1,
                        "MSDSURL": "http://tesipaddress/MSDS/testMSDS.pdf"
                    }
                ]
            }
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: SubmitShipmentResponse
SellerID String Your seller ID
RequestID String The Identifier of  submission
RequestDate String Request date of submission
RequestStatus String The status of the request submission:

SUBMITTED

Schema: SubmitInboundShipmentResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>SubmitShipmentResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <RequestID>2PQCX3SPZ3QBF</RequestID>
        <RequestDate>06/06/2013 10:21:00</RequestDate>
        <RequestStatus>SUBMITTED</RequestStatus>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "OperationType": "SubmitShipmentResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "RequestID": "Z2OTIV1AVVBJ",
        "RequestDate": "07/11/2013 17:24:46",
        "RequestStatus": "SUBMITTED"
    }
}

Request Failure Errors

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

Error Code Description
SBN001 Delivery to the Newegg warehouse: {ShipToWarehouseCode} of Seller Part # {SellerPart#} is not available. Please
submit a Get Inbound Shipment Plan request to receive the information of available option(s).
SBN002 Invalid Seller Part # :{sellerpart#}.
SBN003 Seller Part # :{sellerpart#} is marked as Shipped by Seller now, please convert this item to Shipped by Newegg and try again.
SBN004 Invalid Shipment ID:{ShipmentID}
SBN005 Cannot void Shipment: [ShipmentID]. Shipment using Newegg Partnered Carrier service cannot be void 48 hours after pre-paid shipping label created.
SBN006 Cannot void Shipment: [ShipmentID]. Shipment cannot be void because it is marked as [Received or Partially Received or Manually closed or Voided].
SBN007 The field: [PackageWeight or PackageLength or PackageHeight or PackageWidth ] is required when using Newegg Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN008 The value in the field: PackageWeight cannot exceed 150 lbs. (70 kg) when using Newegg Partnered Carrier service
(ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN009 The value in the field: PackageLength cannot exceed 108 inches (270 cm) when using Newegg Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN010 Package size cannot exceed 165 inches (419 cm) in (Package Length + 2x Package Width + 2x Package Height) when using Newegg Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN011 The field: OtherCarrierName is required when Shipping Carrier is Other (ShippingCarrierCode: 99). For more detail, please review Newegg API Development Guide, SBN section.
SBN012 The value in the field of ShippingCarrier can only be Other (ShippingCarrierCode: 99) when the ShippingMethodCode= 2. For more detail, please review Newegg API Development Guide, SBN section.
SBN013 Newegg Partnered Carrier service (ShippingCarrierCode: 105) is not available for international sellers.
SBN014 Package Dimension Weight cannot exceed 150 lbs.(70kg) in (Package Length x Package Width x Package Height/166) when using Newegg Partnered Carrier service (ShippingCarrierCode:105). For more detail, please review Newegg API Development Guide, SBN section.
SBN015 The field:[MSDSURL] is required when ORM-D = 1. For more detail, please contact datafeeds@newegg.com.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SBN002</Code>
        <Message>Invalid Seller Part # :XYZ.</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "SBN002",
    "Message": "Invalid Seller Part # :XYZ."
}

Last updated: October 15, 2018