Cancel Order

Cancel order by specific order number.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}
Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/{ordernumber}?sellerid={sellerid}&version={version}

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
ordernumber	Yes	The order number
version	No	Available version numbers: 304

Resource Information

HTTP Method	Authentication?	Request Formats	Response Formats	Rate Limited?
PUT	Required	XML, Json	XML, Json	1000 request per hour

Request Body

Attribute

Required?

Format

Description

Action

Yes

Integer

1: Cancel Order

Note: SBN order might not be cancelled if the order is been processing by Newegg Warehouse. Please use Get SBN Order Cancellation Request Result, section 10.6 to check the status.

Value

Yes

Integer

The cancel reason code:

24: OutOfStock
72: Customer Requested to Cancel
73: PriceError
74: Unable to Fulfill Order

Schema: CancelRequest.xsd

Example: XML, Request

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

<UpdateOrderStatus>
    <Action>1</Action>
    <Value>24</Value>
</UpdateOrderStatus>

Example: Json, Request

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

{
    "Action": "1",
    "Value": "24"
}

Response Body

Attribute	Format	Description
IsSuccess	String	Used to identify the operation of order update is successful Returns true or false.
OrderNumber	Integer	The order number
SellerID	String	Your Seller ID
OrderStatus	String	The order status, values available: Void: Void successfully Processing: Cancellation request has been received and under processing. This status is ONLY available for the cancellation request of SBN orders. The final processing result can be checked using 10.6 Check SBN Order Cancellation Result.

Schema: CancelOrderResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<UpdateOrderStatusInfo>
    <IsSuccess>true</IsSuccess>
    <Result>
        <OrderNumber>159243598</OrderNumber>
        <SellerID>A006</SellerID>
        <OrderStatus>Void</OrderStatus>
    </Result>
</UpdateOrderStatusInfo>

Example: Json, Response

{
    "IsSuccess": "true",
    "Result": {
        "OrderNumber": "159243598",
        "SellerID": "A006",
        "OrderStatus": "Void"
    }
}

Request Failure Errors

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

Error Code	Description
SO001	Seller ID cannot be null or empty
SO002	Order Number should be an integer (ranging from 1 to 2147483647)
SO003	No data found or this order does not belong to this seller
SO004	This is a replacement SO with a RMA number. It cannot be voided
SO005	Cannot remove item because this is a Shipped by Newegg order. order is Shipped by Newegg
SO006	Only unshipped orders can be voided. The order status is currently {0}
SO007	Cannot get the order status info
SO008	This order has already been voided
SO009	Order number cannot be null or empty
SO010	Invalid order. No item exists
SO011	Only unshipped orders can be shipped. The order status is currently {0}
SO012	Only shipped by seller orders can be supported currently
SO014	The action should be [ Canceled = 1 \| Shipped = 2]
SO015	The Argument ‘{0}’ cannot be null
SO016	This order has not been downloaded onto seller portal yet. Please re-submit your request after two hours.
SO017	Reason code should be [24 — OutOfStock,72 — Customer Requested to Cancel,73 — PriceError,74 — Unable to Fulfill the Order]
SO020	There is a package or packages without shipping information in this shipment.
SO025	Some items in the shipment have already been shipped.
SO027	This order has already been shipped.
SO030	There is a format error in shipment segment of this XML request.
SO036	The order’s shipping method is null. Please contact System Admin.
SO037	The action should be [1 – Cancelled, 2 – Shipped]
SO040	The Order number or Seller ID provided is not the same as in the URL.
SO056	Your request cannot be processed. Order: [order #] is a Newegg Premier order and can only be shipped using Newegg Shipping Label Service.

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>SO002</Code>
        <Message>Order Number should be an integer (ranging from 1 to 2147483647)</Message>
    </Error>
</Errors>

Example: Json, Response

[
    {
        "Code": "SO002",
        "Message": "Order Number should be an integer (ranging from 1 to 2147483647)"
    }
]

Last updated: October 15, 2018