Get Inbound Shipment Status Request

Get the status of specified inbound shipment.

Resource URL

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

Request Body

Attribute Required? Format Description
OperationType Yes String Fixed values: GetShipmentStatusRequest
RequestID No String The Identifier of a submission. Other condition will be ignored if Request ID has been specified.
ActionCode No Integer Available values for action code:

0: All(Default)
1: Create
2: Void
MaxCount No Integer The maximum return records. Default is 100. If you specified over than 100, the system still return 100 records.
RequestStatus No String The status of the submitted request.
Available values:
ALL (Default)
SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
RequestDateFrom No DateTime Search by request date range (Pacific Standard Time)

Please refer to the Acceptable Date Format
RequestDateTo No DateTime Search by request date range (Pacific Standard Time)

Please refer to the Acceptable Date Format

Schema: GetShipmentStatusRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetShipmentStatusRequest</OperationType>
    <RequestBody>
        <GetRequestStatus>
            <RequestIDList>
                <RequestID>22AZLF9YXKT7S</RequestID>
            </RequestIDList>
            <ActionCode>1</ActionCode>
            <MaxCount>100</MaxCount>
            <RequestStatus>ALL</RequestStatus>
            <RequestDateFrom/>
            <RequestDateTo/>
        </GetRequestStatus>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetShipmentStatusRequest",
    "RequestBody": {
        "GetRequestStatus": {
            "RequestIDList": {
                "RequestID": [
                    "22AZLF9YXKT7S"
                ]
            },
            "ActionCode": 1,
            "MaxCount": 100,
            "RequestStatus": "ALL",
            "RequestDateFrom": "2013-5-4",
            "RequestDateTo": "2013-8-4"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful
OperationType String Fixed value: GetShipmentStatusResponse
SellerID String Your seller ID
RequestID String The Identifier of  submission
ActionCode Integer Available values for the action code:

1: Create
2: Void
RequestDate String The date when the feed was submitted (Pacific Standard Time)
RequestStatus String Available values for the status of the feed submission:

SUBMITTED
IN_PROGRESS
FINISHED
CANCELLED
Memo String Detailed error information

Schema: GetShipmentStatusResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <SellerID>A006</SellerID>
    <OperationType>GetShipmentStatusResponse</OperationType>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>22AZLF9YXKT7S</RequestId>
                <ActionCode>1</ActionCode>
                <RequestDate>07/11/2013 16:39:30</RequestDate>
                <RequestStatus>IN_PROGRESS</RequestStatus>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": true,
    "SellerID": "A006",
    "OperationType": "GetShipmentStatusResponse",
    "ResponseBody": {
        "ResponseList": [
            {
                "RequestId": "22AZLF9YXKT7S",
                "ActionCode": 1,
                "RequestDate": "07/11/2013 16:39:30",
                "RequestStatus": "IN_PROGRESS"
            }
        ]
    }
}

Request Failure Errors

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

Last updated: October 15, 2018