Get Courtesy Refund Information

Get the specified courtesy refund information by specified query conditions.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Neweggbusiness.com: https://api.newegg.com/marketplace/b2b/servicemgmt/courtesyrefund/info?sellerid={sellerid}
Newegg.ca: https://api.newegg.com/marketplace/can/servicemgmt/courtesyrefund/info?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 30 requests per min per client

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: GetCourtesyRefundInfo
PageIndex No Integer Current page index

If left blank, default is 1
PageSize No Integer Return records count in one page,  max is 100 per page

If left blank, default is 100
KeywordsType No Integer Available values:

0: All (default)
1: CourtesyRefundID
2: OrderNumber
3: CustomerName
KeywordsValue No String The keywords value of the specified KeywordsType

If the Keywordstype is 0, system will ignore this field
Status No Integer Available values:

0: All(Default)
1: Open
2: Void
3: Close
DateFrom No String Search by Courtesy Refund Date (Pacific Standard Time)

Please refer to the Acceptable Date Format
DateTo No String Search by Courtesy Refund Date (Pacific Standard Time)

Please refer to the Acceptable Date Format

Schema: GetCRInfoRequest.xsd

Example: XML, Request

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

<NeweggAPIRequest >
    <OperationType>GetCourtesyRefundInfo</OperationType>
    <RequestBody>
        <PageInfo>
            <PageIndex>1</PageIndex>
            <PageSize>10</PageSize>
        </PageInfo>
        <KeywordsType>0</KeywordsType>
        <KeywordsValue />
        <Status>0</Status>
        <DateFrom>2001-12-17 09:30:47</DateFrom>
        <DateTo>2011-12-17 12:30:47</DateTo>
    </RequestBody>
</NeweggAPIRequest>

Example: Json, Request

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

{
    "OperationType": "GetCourtesyRefundInfo",
    "RequestBody": {
        "PageInfo": {
            "PageIndex": "1",
            "PageSize": "10"
        },
        "KeywordsType": "0",
        "Status": "0",
        "DateFrom": "2001-12-17 09:30:47",
        "DateTo": "2011-12-17 12:30:47"
    }
}

Response Body

Attribute Format Description
IsSuccess String Get feed status operation:

True: Successful
False: Not successful
OperationType String Fixed value: GetCourtesyRefundResponse
SellerID String Your seller ID
ResponseDate String The date when the request was submitted (Pacific Standard Time)
TotalCount Integer How many records
TotalPageCount Integer How many pages return
PageSize Integer How many records in a page
PageIndex Integer Current page index
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)

Schema: GetCRInfoResponse.xsd

Example: XML, Response

<?xml version="1.0" encoding="utf-8"?>
<NeweggAPIResponse>
    <IsSuccess>true</IsSuccess>
    <OperationType>GetCourtesyRefundResponse</OperationType>
    <SellerID>A006</SellerID>
    <ResponseDate>2012-02-17 15:12:00</ResponseDate>
    <ResponseBody>
        <PageInfo>
            <TotalCount>1</TotalCount>
            <TotalPageCount>1</TotalPageCount>
            <PageSize>10</PageSize>
            <PageIndex>1</PageIndex>
        </PageInfo>
        <CourtesyRefundInfoList>
            <CourtesyrefundInfo>
                <CourtesyRefundID>8a9501f2-495a-4b4f-b921-966a40969aa8</CourtesyRefundID>
                <SONumber>88251262</SONumber>
                <SOAmount>890.40</SOAmount>
                <InvoiceNumber>48799955</InvoiceNumber>
                <RefundAmount>2.01</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-02-17 12:10:00</InDate>
                <EditUserName>A006</EditUserName>
                <EditDate>2012-02-17 12:10:00</EditDate>
            </CourtesyrefundInfo>
        </CourtesyRefundInfoList>
    </ResponseBody>
</NeweggAPIResponse>

Example: Json, Response

{
    "NeweggAPIResponse": {
        "IsSuccess": "true",
        "OperationType": "GetCourtesyRefundResponse",
        "SellerID": "A006",
        "ResponseDate": "2012-02-17 15:12:00",
        "ResponseBody": {
            "PageInfo": {
                "TotalCount": "1",
                "TotalPageCount": "1",
                "PageSize": "1",
                "PageIndex": "10"
            },
            "CourtesyRefundInfoList": {
                "CourtesyrefundInfo": {
                    "CourtesyRefundID": "8a9501f2-495a-4b4f-b921-966a40969aa8",
                    "SONumber": "88251262",
                    "SOAmount": "890.40",
                    "InvoiceNumber": "48799955",
                    "RefundAmount": "2.01",
                    "ReasonCode": "1",
                    "Reason": "Negative Customer Feedback",
                    "NoteToCustomer": "This is a test note",
                    "Status": "Close",
                    "IsNeweggRefund": "false",
                    "InUserName": "A006",
                    "InDate": "2012-02-17 12:10:00",
                    "EditUserName": "EDI",
                    "EditDate": "2012-02-17 12:10:00"
                }
            }
        }
    }
}

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