Get Shipping Request Detail

Retrieving the processing result of Submit Shipping Request.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/shippingservice/shippinglabel/shippingdetail?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/shippingservice/shippinglabel/shippingdetail?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?
PUT Required XML, Json XML, Json 100 request per hour

Request Body

Attribute Required? Format Description
IssueUser No String Specify your eligible seller account (email address) here
OperationType Yes String Fixed value: GetShippingDetailRequest
RequestID Yes, if no OrderNumber provided String The request ID

* This service does NOT support querying multiple request IDs.

OrderNumber Yes, if no RequestID provided String Order number

Schema: ShippingDetailRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetShippingDetailRequest</OperationType>
    <RequestBody>
        <RequestID>2PQBYWH4V68ZP</RequestID>
        <OrderNumber>423423678</OrderNumber>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetShippingDetailRequest",
    "RequestBody": {
        "RequestID": "2PQBYWH4V68ZP",
        "OrderNumber": "423423678"
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

SellerID String Your seller ID
OperationType String Fixed value: GetShippingDetailResponse
OrderNumber Integer Related order number
RequestID String Request identifier of a submission
RequestDate String Date time of request (Pacific Standard Time)
CustomerName String Order’s customer name
CustomerPhoneNumber String Order’s shipping phone number
CustomerEmailAddress String Masked customer email address, you can reach to the customer through this email address.

For example: gdv6l0viwo4l7j1d@marketplace.newegg.com

ShipToAddress1 String Order will be shipped to address 1
ShipToAddress2 String Order will be shipped to address 2, if any
ShipToCityName String Order will be shipped to city name
ShipToStateCode String Order will be shipped to state
ShipToZipCode String Order will be shipped to zip code
ShipToCountryCode String Order will be shipped to country

Default values:
United States

ShippingCarrierCode Integer Shipping carrier

Available shipping carrier code:

100 – Newegg Partnered Carrier (UPS)
200 – Newegg Partnered Carrier (FedEx)

If 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
106 – UPS Worldwide Saver

If ShippingCarrierCode = 200:
201 – FedEx Ground
202 – FedEx Home Delivery
203 – FedEx Priority Overnight
204 – FedEx Express Saver
205 – FedEx 2Day
206 – FedEx Standard Overnight
207 – FedEx International Economy

Note: If left this blank, a default shipping service will be assigned according to the shipping service that the customer purchased on this order. The default shipping service mapping as below:

If ShippingCarrierCode = 100:

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

If ShippingCarrierCode = 200:

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

Note: If the shipping request is for a Newegg Premier order, this field is not able to specify and a cheapest shipping service will be assigned automatically in terms of the shipping service that the customer purchased
on the order.

ShipmentStatus String Available shipment status:

ESTIMATING – you have successfully sent a request to estimate the
shipping cost but Newegg partnered carrier is in the process of the
estimation.

ESTIMATED – Newegg partnered carrier has completed shipping cost
estimation. You are able to confirm to ship the request.
ERROR_ESIMATING – An error encountered in the process of the
estimation.

CONFIRMING – you have successfully sent a request to confirm the
shipment but the confirmation process is not yet complete.

CONFIRMED – Your shipping has been confirmed. Note: You cannot void
the shipping request anymore.

ERROR_CONFIRMING – An error encountered in the process of confirming.

VOIDING – You have successfully sent a request to void a shipping request
but the voiding process has not yet complete.

VOIDED – The shipping request has confirmed to void, your account will
not be charged for the shipping cost.

ShipDate String Date when the shipping request confirmed (Pacific Standard Time)
ErrorMessage String An error encountered in the process of the request.

Only has value when the ShipmentStatus = ERROR_ESTIMATING or
ERROR_CONFIRMING

BillableWeight Decimal Weight Newegg partnered carrier will bill to the shipment.
EstimatedDeliveryDay String Date Newegg partnered carrier will delivery the shipment.
EstimatedChargeAmount Decimal Amount Newegg partnered carrier will charge to the shipment.
ShipFromFirstName String Contact person – first name
ShipFromLastName String Contact person – last name
ShipFromPhoneNumber String Contact person – contact phone number
ShipFromAddress1 String Ship from address 1
ShipFromAddress2 String Ship from address 2, if any
ShipFromCityName String Ship from city
ShipFromStateCode String Ship from state
ShpFromZipCode String Ship from zipcode
ShipFromCountryCode String Ship from country code in 3-digit fromat

* Currenlty the default value is USA.

TrackingNumber String Tracking number
SellerPartNumber String Seller part number
Quantity Integer Item quantity

Schema: ShippingDetailResponse.xsd

Example: XML, Response

<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetShippingDetailResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <OrderNumber>2135751360</OrderNumber>
        <RequestList>
            <Request>
                <RequestID>2PQBYWH4V68ZP</RequestID>
                <RequestDate>12/10/2015 14:38:17</RequestDate>
                <Shipment>
                    <CustomerName>WY SD</CustomerName>
                    <CustomerPhoneNumber>123-223-3223</CustomerPhoneNumber>
                    <CustomerEmailAddress>gdv6l0viwo4l7j1d@marketplace.newegg.com</CustomerEmailAddress>
                    <ShipToAddress1>149 Kenwood Dr</ShipToAddress1>
                    <ShipToAddress2/>
                    <ShipToCityName>Newcastle</ShipToCityName>
                    <ShipToStateCode>WY</ShipToStateCode>
                    <ShipToZipCode>82701</ShipToZipCode>
                    <ShipToCountryCode>UNITED STATES</ShipToCountryCode>
                    <ShippingCarrierCode>100</ShippingCarrierCode>
                    <ShippingServiceCode>101</ShippingServiceCode>
                    <ShipmentStatus>CONFIRMED</ShipmentStatus>
                    <ErrorMessage/>
                    <ShipDate>12/25/2015</ShipDate>
                    <PartneredEstimate>
                        <BillableWeight>6.5</BillableWeight>
                        <EstimatedDeliveryDay>12/29/2015</EstimatedDeliveryDay>
                        <EstimatedChargeAmount>21.94</EstimatedChargeAmount>
                    </PartneredEstimate>
                    <ShipFromFirstName>Jon</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>
                            <TrackingNumber>1Z8V016A0377769652</TrackingNumber>
                            <ItemList>
                                <Item>
                                    <SellerPartNumber>201307220000101</SellerPartNumber>
                                    <Quantity>4</Quantity>
                                </Item>
                                <Item>
                                    <SellerPartNumber>SARATEST0118</SellerPartNumber>
                                    <Quantity>1</Quantity>
                                </Item>
                            </ItemList>
                        </Package>
                        <Package>
                            <TrackingNumber>1Z8V016A0360430477</TrackingNumber>
                            <ItemList>
                                <Item>
                                    <SellerPartNumber>201307220000102</SellerPartNumber>
                                    <Quantity>3</Quantity>
                                </Item>
                            </ItemList>
                        </Package>
                    </PackageList>
                </Shipment>
            </Request>
            <Request>
                <RequestID>2PQBYWH4V68ZP</RequestID>
                <RequestDate>12/10/2015 14:38:17</RequestDate>
                <Shipment>
                    <CustomerName>WY SD</CustomerName>
                    <CustomerPhoneNumber>123-223-3223</CustomerPhoneNumber>
                    <CustomerEmailAddress>gdv6l0viwo4l7j1d@marketplace.newegg.com</CustomerEmailAddress>
                    <ShipToAddress1>149 Kenwood Dr</ShipToAddress1>
                    <ShipToAddress2/>
                    <ShipToCityName>Newcastle</ShipToCityName>
                    <ShipToStateCode>WY</ShipToStateCode>
                    <ShipToZipCode>82701</ShipToZipCode>
                    <ShipToCountryCode>UNITED STATES</ShipToCountryCode>
                    <ShippingCarrierCode>100</ShippingCarrierCode>
                    <ShippingServiceCode>101</ShippingServiceCode>
                    <ShipmentStatus>CONFIRMED</ShipmentStatus>
                    <ErrorMessage/>
                    <ShipDate>12/25/2015</ShipDate>
                    <PartneredEstimate>
                        <BillableWeight>6.5</BillableWeight>
                        <EstimatedDeliveryDay>12/29/2015</EstimatedDeliveryDay>
                        <EstimatedChargeAmount>21.94</EstimatedChargeAmount>
                    </PartneredEstimate>
                    <ShipFromFirstName>Jon</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>
                            <TrackingNumber>1Z8V016A0377769652</TrackingNumber>
                            <ItemList>
                                <Item>
                                    <SellerPartNumber>201307220000101</SellerPartNumber>
                                    <Quantity>4</Quantity>
                                </Item>
                                <Item>
                                    <SellerPartNumber>SARATEST0118</SellerPartNumber>
                                    <Quantity>1</Quantity>
                                </Item>
                            </ItemList>
                        </Package>
                        <Package>
                            <TrackingNumber>1Z8V016A0360430477</TrackingNumber>
                            <ItemList>
                                <Item>
                                    <SellerPartNumber>201307220000102</SellerPartNumber>
                                    <Quantity>3</Quantity>
                                </Item>
                            </ItemList>
                        </Package>
                    </PackageList>
                </Shipment>
            </Request>
        </RequestList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "GetShippingDetailResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "OrderNumber": "2135751360",
        "RequestList": {
            "Request": [
                {
                    "RequestID": "2PQBYWH4V68ZP",
                    "RequestDate": "12/10/2015 14:38:17",
                    "Shipment": {
                        "CustomerName": "WY SD",
                        "CustomerPhoneNumber": "123-223-3223",
                        "CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
                        "ShipToAddress1": "149 Kenwood Dr",
                        "ShipToCityName": "Newcastle",
                        "ShipToStateCode": "WY",
                        "ShipToZipCode": "82701",
                        "ShipToCountryCode": "UNITED STATES",
                        "ShippingCarrierCode": "100",
                        "ShippingServiceCode": "101",
                        "ShipmentStatus": "CONFIRMED",
                        "ShipDate": "12/25/2015",
                        "PartneredEstimate": {
                            "BillableWeight": "6.5",
                            "EstimatedDeliveryDay": "12/29/2015",
                            "EstimatedChargeAmount": "21.94"
                        },
                        "ShipFromFirstName": "Jon",
                        "ShipFromLastName": "Doe",
                        "ShipFromPhoneNumber": "6266171420",
                        "ShipFromAddress1": "18045 Rowland Street",
                        "ShipFromCityName": "City Of Industry",
                        "ShipFromStateCode": "CA",
                        "ShipFromZipCode": "91748",
                        "ShipFromCountryCode": "USA",
                        "PackageList": {
                            "Package": [
                                {
                                    "TrackingNumber": "1Z8V016A0377769652",
                                    "ItemList": {
                                        "Item": [
                                            {
                                                "SellerPartNumber": "201307220000101",
                                                "Quantity": "4"
                                            },
                                            {
                                                "SellerPartNumber": "SARATEST0118",
                                                "Quantity": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "TrackingNumber": "1Z8V016A0360430477",
                                    "ItemList": {
                                        "Item": {
                                            "SellerPartNumber": "201307220000102",
                                            "Quantity": "3"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                },
                {
                    "RequestID": "2PQBYWH4V68ZP",
                    "RequestDate": "12/10/2015 14:38:17",
                    "Shipment": {
                        "CustomerName": "WY SD",
                        "CustomerPhoneNumber": "123-223-3223",
                        "CustomerEmailAddress": "gdv6l0viwo4l7j1d@marketplace.newegg.com",
                        "ShipToAddress1": "149 Kenwood Dr",
                        "ShipToCityName": "Newcastle",
                        "ShipToStateCode": "WY",
                        "ShipToZipCode": "82701",
                        "ShipToCountryCode": "UNITED STATES",
                        "ShippingCarrierCode": "100",
                        "ShippingServiceCode": "101",
                        "ShipmentStatus": "CONFIRMED",
                        "ShipDate": "12/25/2015",
                        "PartneredEstimate": {
                            "BillableWeight": "6.5",
                            "EstimatedDeliveryDay": "12/29/2015",
                            "EstimatedChargeAmount": "21.94"
                        },
                        "ShipFromFirstName": "Jon",
                        "ShipFromLastName": "Doe",
                        "ShipFromPhoneNumber": "6266171420",
                        "ShipFromAddress1": "18045 Rowland Street",
                        "ShipFromCityName": "City Of Industry",
                        "ShipFromStateCode": "CA",
                        "ShipFromZipCode": "91748",
                        "ShipFromCountryCode": "USA",
                        "PackageList": {
                            "Package": [
                                {
                                    "TrackingNumber": "1Z8V016A0377769652",
                                    "ItemList": {
                                        "Item": [
                                            {
                                                "SellerPartNumber": "201307220000101",
                                                "Quantity": "4"
                                            },
                                            {
                                                "SellerPartNumber": "SARATEST0118",
                                                "Quantity": "1"
                                            }
                                        ]
                                    }
                                },
                                {
                                    "TrackingNumber": "1Z8V016A0360430477",
                                    "ItemList": {
                                        "Item": {
                                            "SellerPartNumber": "201307220000102",
                                            "Quantity": "3"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Request Failure Errors

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

Error Code Description
SL013 Cannot find shipping request:{[request ID]}

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SL013</Code>
        <Message>Cannot find shipping request: APQBYWH4V68ZP</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "SL013",
    "Message": "Cannot find shipping request: APQBYWH4V68ZP"
}

Last updated: October 15, 2018