Remove Item
Remove item from specified order. If all items removed from an order, order status becomes void.
Note: Only supports orders that is fulfilled by seller.
Resource URL
Newegg.com: https://api.newegg.com/marketplace/ordermgmt/killitem/orders/{ordernumber}?sellerid={sellerid} Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/ordermgmt/killitem/orders/{ordernumber}?sellerid={sellerid} Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/killitem/orders/{ordernumber}?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 |
ordernumber | Yes | The order number |
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 |
IssueUser | No | String | Specify your eligible seller account (email address) here. |
OperationType | Yes | String | Fixed value: KillItemRequest |
SellerPartNumber | Yes | String | Seller Part# of item.
Note: Item cannot be removed with SBN orders. |
Memo | No | String | Additional Information, reason for removing item. |
Schema: RemoveItemRequest.xsd
Example: XML, Request
PUT https://api.newegg.com/marketplace/ordermgmt/killitem/orders/{ordernumber}?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/xml Accept: application/xml <NeweggAPIRequest> <OperationType>KillItemRequest</OperationType> <RequestBody> <KillItem> <Order> <ItemList> <Item> <SellerPartNumber>AWHZ3434</SellerPartNumber> </Item> <Item> <SellerPartNumber>AWHZ3435</SellerPartNumber> </Item> </ItemList> </Order> </KillItem> </RequestBody> </NeweggAPIRequest>
Example: Json, Request
PUT https://api.newegg.com/marketplace/ordermgmt/killitem/orders/{ordernumber}?sellerid={sellerid} Authorization: 720ddc067f4d115bd544aff46bc75634 SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D Content-Type: application/json Accept: application/json { "OperationType": "KillItemRequest", "RequestBody": { "KillItem": { "Order": { "ItemList": { "Item": [ { "SellerPartNumber": "AWHZ3434" }, { "SellerPartNumber": "AWHZ3435" } ] } } } } }
Response Body
Attribute | Format | Description |
IsSuccess | String | Used to identify the operation of removing item from order is successful.
Returns true or false |
OperationType | String | Fixed value: KillItemResponse |
SellerID | String | Your seller ID |
ResponseDate | String | The Date Time of a request (Pacific Standard Time) |
OrderNumber | Integer | The order number |
ShipDate | String | Ship date(Pacific Standard Time) |
SellerPartNumber | String | Seller Part# of item |
RequestDate | String | The Date Time of a request (Pacific Standard Time) |
Memo | String | When operation false, this field will contain detailed error description. |
Schema: RemoveItemResponse.xsd
Example: XML, Response
<?xml version=”1.0” encoding=”utf-8”?> <NeweggAPIResponse> <IsSuccess>true</IsSuccess> <OperationType>KillItemResponse</OperationType> <SellerID>A006</SellerID> <Memo /> <ResponseBody> <RequestDate>2012-02-22 16:42:10</RequestDate> <Orders> <OrderNumber>88237462</OrderNumber> <Result> <ItemList> <Item> <SellerPartNumber>AWHZ3434</SellerPartNumber> </Item> </ItemList> </Result> </Orders> </ResponseBody> <ResponseDate>2012-02-22 16:42:10</ResponseDate> </NeweggAPIResponse>
Example: Json, Response
{ "IsSuccess": true, "Memo": null, "OperationType": "KillItemResponse", "SellerID": "A006", "ResponseBody": { "Orders": { "OrderNumber": "88237462", "Result": { "ItemList": [ { "SellerPartNumber": "AWHZ3434" } ] } }, "RequestDate": "2012-02-22 16:42:10" }, "ResponseDate": "2012-02-22 16:42:10" }
Request Failure Errors
For common HTTP error responses, please refer to Failed Response Error Code List.
Error Code | Description |
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 |
SO041 | CANNOT find SONumber: {0} |
SO042 | Application exception occurred during calling EC Interface. SONumber: {0}, ItemNumber: {1}. Please Contact Newegg Marketplace. |
SO043 | Business exception occurred during calling EC Interface(3 invoice,4 void,1 shipped). SONumber: {0}, ItemNumber: {1}. Please Contact Newegg Marketplace. |
SO045 | Failed to get customer information! The customer number is {0}. |
SO046 | CANNOT find item in Newegg_SOTransaction, SONumber: {0}, ItemNumber: {1} |
SO047 | CANNOT get item detail information (sub category), ItemNumber: {0} |
SO049 | The ‘{0}’ is required. |
SO050 | The SellerPartNumber ‘{0}’ is invalid. |
SO051 | This ‘{0}’ has already been canceled in Newegg System. |
SO052 | CANNOT find out item by ordernumber ='{0}’ and sellerid='{1}’. |
SO053 | Cannot get the ordernumber='{0}’ status. |
SO054 | The ordernumber= ‘{0}’ is Replacement SO. CANNOT be voided. |
SO055 | The seller part# = ‘{0}’ is repeated. |
SO056 | Cannot remove item because this is a Shipped by Newegg order. order is Shipped by Newegg |
Example: XML, Response
<?xml version="1.0" encoding="utf-8"?> <Errors> <Error> <Code>SO008</Code> <Message>This order has already been voided</Message> </Error> </Errors>
Example: Json, Response
[ { "Code": "SO008", "Message": " This order has already been voided" } ]
Last updated: October 15, 2018