Get Courtesy Refund Request Status

Get the status of specified courtesy refund request by specified query conditions.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/courtesyrefund/requeststatus?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/courtesyrefund/requeststatus?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 10,000 request per hour

Request Body

Attribute Required? Format Description
IssueUser No String Issuer’s registered Seller Portal email address. System will only accept Seller’s
registered Seller Portal email addresses.If left blank, default value will be Seller ID.
OperationType Yes String Fixed value: GetCourtesyRefundStatusRequest
RequestID No String Newegg’s assigned Request ID for requested courtesy refund.

Note: Other condition MaxCount, RequestStatus, RequestDateFrom, RequestDateTo will be ignored, if Request ID is specified.

MaxCount No String The maximum return records. Default is 100. If you specified more than 100, the system still return 100 records.
RequestStatus No String Available values:

ALL (Default)
SUBMITTED
IN_PROGRESS
FINISHED
FAILED
CANCELLED

RequestDateFrom No String Search by Courtesy Refund Date (Pacific Standard Time)

Please refer to the Acceptable Date Format

RequestDateTo No String Search by Courtesy Refund Date (Pacific Standard Time)

Please refer to the Acceptable Date Format

Schema: GetCRStatusRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest>
    <OperationType>GetCourtesyRefundStatusRequest</OperationType>
    <RequestBody>
        <GetRequestStatus>
            <RequestIDList>
                <RequestID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestID>
            </RequestIDList>
            <MaxCount>100</MaxCount>
            <RequestStatus>ALL</RequestStatus>
            <RequestDateFrom/>
            <RequestDateTo/>
        </GetRequestStatus>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetCourtesyRefundStatusRequest",
    "RequestBody": {
        "GetRequestStatus": {
            "RequestIDList": {
                "RequestID": [
                    "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8"
                ]
            },
            "MaxCount": "100",
            "RequestStatus": "ALL"
        }
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful

OperationType String Fixed value: GetCourtesyRefundRequestStatusResponse
SellerID String Your seller ID
RequestId String Newegg’s assigned number of request
RequestType String Fixed value: COURTESYREFUND
RequestDate String The date when the request was submitted (Pacific Standard Time)
RequestStatus String Available values:

SUBMITTED
IN_PROGRESS
FINISHED
FAILED
CANCELLED

Note:

  • If you received the request status = ‘FAILED’, please refer to the detailed reason in the
    [ProcessMemo] field
  • If you received the request status = ‘FINISHED’, the courtesy refund info will be displayed
ProcessMemo String If status = failed, detailed error message(s) will be displayed here
CourtesyRefundID String Refund Transaction ID
SONumber Integer Order number
SOAmount Decimal Order amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
InvoiceNumber Integer Order invoice number
RefundAmount Decimal Refund amount

  • Newegg.com and Newggbusiness.com, all amounts are set in U.S. Dollars (USD)
  • Newegg.ca, all amounts are set in Can Dollars (CAD)
ReasonCode Integer Available values:

1: Negative customer feedback
2: Pricing error
3: Wrong item information
4: Shipping delay
5: Package not received
6: Customer Courtesy

Reason String Available values:

Negative customer feedback: If ReasonCode value = 1
Pricing error: If ReasonCode value = 2
Wrong item information: If ReasonCode value = 3
Shipping delay: If ReasonCode value = 4
Package not received: If ReasonCode value = 5
Customer Courtesy: If ReasonCode value = 6

NoteToCustomer String Note to customer
Status String Available values:

1: Open
2: Close
3: Void

IsNeweggRefund String Specify the refund issued by Newegg Customer Service agent.  Available values: “true” or “false”
InUserName String Courtesy refund creator
InDate String Courtesy refund create date (Pacific Standard Time)
EditUserName String Last edit user
EditDate String Last edit date (Pacific Standard Time)
Memo String Additional notes

Schema: GetCRStatusResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetCourtesyRefundRequestStatusResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseBody>
        <ResponseList>
            <ResponseInfo>
                <RequestId>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</RequestId>
                <RequestType>COURTESYREFUND</RequestType>
                <RequestDate>2012-03-07 12:37:09</RequestDate>
                <RequestStatus>FINISHED</RequestStatus>
                <Result>
                    <CourtesyRefundInfo>
                        <CourtesyRefundID>cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8</CourtesyRefundID>
                        <SONumber>164878278</SONumber>
                        <SOAmount>1.00</SOAmount>
                        <InvoiceNumber>84724946</InvoiceNumber>
                        <RefundAmount>1.00</RefundAmount>
                        <ReasonCode>1</ReasonCode>
                        <Reason>Negative Customer Feedback</Reason>
                        <NoteToCustomer>this is a test note</NoteToCustomer>
                        <Status>Close</Status>
                        <IsNeweggRefund>false</IsNeweggRefund>
                        <InUserName>A006</InUserName>
                        <InDate>2012-03-07 12:38:00</InDate>
                        <EditUserName>EDI</EditUserName>
                        <EditDate>2012-03-07 13:07:02</EditDate>
                    </CourtesyRefundInfo>
                </Result>
            </ResponseInfo>
        </ResponseList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "OperationType": "GetCourtesyRefundRequestStatusResponse",
        "SellerID": "A006",
        "ResponseBody": {
            "ResponseList": {
                "ResponseInfo": {
                    "RequestId": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
                    "RequestType": "COURTESYREFUND",
                    "RequestDate": "2012-03-07 12:37:09",
                    "RequestStatus": "FINISHED",
                    "Result": {
                        "CourtesyRefundInfo": {
                            "CourtesyRefundID": "cb0c9123-b7ac-454d-84d7-3fab9bf7e1f8",
                            "SONumber": "164878278",
                            "SOAmount": "1.00",
                            "InvoiceNumber": "84724946",
                            "RefundAmount": "1.00",
                            "ReasonCode": "1",
                            "Reason": "Negative Customer Feedback",
                            "NoteToCustomer": "this is a test note",
                            "Status": "Close",
                            "IsNeweggRefund": "false",
                            "InUserName": "A006",
                            "InDate": "2012-03-07 12:38:00",
                            "EditUserName": "EDI",
                            "EditDate": "2012-03-07 13:07:02"
                        }
                    }
                }
            }
        }
    }
}

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