Order Confirmation

Notify Newegg to mark the orders you have downloaded. You will be able to exclude these downloaded orders in the Get Order Info API’s through OrderDownloaded filter.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/ordermgmt/orderstatus/orders/confirmation?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/ordermgmt/orderstatus/orders/confirmation?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/ordermgmt/orderstatus/orders/confirmation?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 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: OrderConfirmationRequest
OrderNumber Yes Integer The orders you want to mark as downloaded
already.

Schema: OrderConfirmRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>OrderConfirmationRequest</OperationType>
    <RequestBody>
        <DownloadedOrderList>
            <OrderNumber>159243598</OrderNumber>
        </DownloadedOrderList>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

{
    "OperationType": "OrderConfirmationRequest",
    "RequestBody": {
        "DownloadedOrderList": {
            "OrderNumber": [
                "159243598"
            ]
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Used to identify the operation of order confirmation is successful
Response: true or false
OperationType String Fixed value: OrderConfirmationResponse
SellerID String Your seller ID
ResponseDate String The date time of response (Pacific Standard Time)
RequestDate String The date time of request (Pacific Standard Time)
OrderNumber Integer The orders you want to mark as downloaded already.
Memo String Additional Information. Currently will return null.

Schema: OrderConfirmResponse.xsd

Example: XML, Response

<?xml version=”1.0” encoding=”utf-8”?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>OrderConfirmationResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseDate>2/22/2012 16:37:20</ResponseDate>
    <ResponseBody>
        <RequestDate>2/22/2012 16:37:20</RequestDate>
        <DownloadedOrderList>
            <OrderNumber>159243598</OrderNumber>
        </DownloadedOrderList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "OperationType": "OrderConfirmationResponse",
        "SellerID": "A006",
        "ResponseDate": "2/22/2012 16:38:53",
        "ResponseBody": {
            "RequestDate": "2/22/2012 16:38:53",
            "DownloadedOrderList": {
                "OrderNumber": "159243598"
            }
        }
    }
}

Request Failure Errors

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

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<Errors>
    <Error>
        <Code>CE001</Code>
        <Message>SellerID cannot be null or empty</Message>
    </Error>
</Errors>

Example: Json, Response

{
    "Code": "CE001",
    "Message": "SellerID cannot be null or empty"
}

Last updated: October 15, 2018