Submit Create Inbound Shipment Request

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

Resource Information

Request Body

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

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.

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: January 27, 2021