Void Shipping Request

An unconfirmed shipping request is applicable for void using this function.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/shippingservice/shippinglabel/voidshippingrequest?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/shippingservice/shippinglabel/voidshippingrequest?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	10 per min per client

Request Body

Attribute	Required?	Format	Description
OperationType	Yes	String	Fixed value: VoidShippingRequest
RequestID	Yes	String	Shipping request ID

Schema: ShippingVoidRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>VoidShippingRequest</OperationType>
    <RequestBody>
        <RequestIDList>
            <RequestID>2PQBYWH4V68ZP</RequestID>
            <RequestID>2PQCX3SPZ3QBF</RequestID>
        </RequestIDList>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "VoidShippingRequest",
    "RequestBody": {
        "RequestIDList": {
            "RequestID": [
                "2PQBYWH4V68ZP",
                "2PQCX3SPZ3QBF"
            ]
        }
    }
}

Response Body

Attribute	Format	Description
IsSuccess	String	Get feed status operation: True: Successful False: Not successful
OperationType	String	Fixed value: ConfirmShippingResponse
SellerID	String	Your seller ID
RequestID	String	Request identifier of a submission
RequestDate	String	Date time of request (Pacific Standard Time)
RequestStatus	String	Status of the request submission: VOIDING

Schema: ShippingVoidResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>VoidShippingResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <RequestIDList>
            <RequestID>2PQBYWH4V68ZP</RequestID>
            <RequestID>2PQCX3SPZ3QBF</RequestID>
        </RequestIDList>
        <RequestDate>12/06/2015 10:21:00</RequestDate>
        <RequestStatus>VOIDING</RequestStatus>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "IsSuccess": "true",
    "OperationType": "VoidShippingResponse",
    "SellerID": "A006",
    "ResponseBody": {
        "RequestIDList": {
            "RequestID": [
                "2PQBYWH4V68ZP",
                "2PQCX3SPZ3QBF"
            ]
        },
        "RequestDate": "12/06/2015 10:21:00",
        "RequestStatus": "CONFIRMING"
    }
}

Request Failure Errors

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

Error Code	Description
SL017	Request {request ID} cannot be submitted because the shipping request has {confirmed | voided}. Please revise the request list and submit again.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SL017</Code>
        <Message>Request 2PQBYWH4V68ZP cannot be submitted because the shipping request has confirmed. Please revise the request list and submit again.</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "SL017",
    "Message": "Request 2PQBYWH4V68ZP cannot be submitted because the shipping request has confirmed. Please revise the request list and submit again."
}

Last updated: October 15, 2018